945818e1d8
Reword various things, and update links to source code references. Also, mention the following: - conf_keys validation (#282) - Topic acceptance rules (or rather, the lack thereof: #277) |
||
---|---|---|
coremods | ||
docs | ||
log | ||
plugins | ||
protocols | ||
.codeclimate.yml | ||
.gitignore | ||
.mailmap | ||
AUTHORS | ||
classes.py | ||
conf.py | ||
example-conf.yml | ||
LICENSE.CC-BY-SA-4.0 | ||
LICENSE.MPL2 | ||
log.py | ||
pylink | ||
README.md | ||
RELNOTES.md | ||
setup.py | ||
structures.py | ||
update.sh | ||
utils.py | ||
VERSION | ||
world.py |
PyLink
PyLink is an extensible, plugin-based IRC services framework written in Python. It aims to be:
a replacement for the now-defunct Janus.
a versatile framework and gateway to IRC.
PyLink and any bundled software are licensed under the Mozilla Public License, version 2.0 (LICENSE.MPL2). The corresponding documentation in the docs/ folder is licensed under the Creative Attribution-ShareAlike 4.0 International License. (LICENSE.CC-BY-SA-4.0)
Support
First, MAKE SURE you’ve read the FAQ!
When upgrading between major versions, remember to read the release notes for any breaking changes!
Please report any bugs you find to the issue tracker. Pull requests are open if you’d like to contribute, though new stuff generally goes to the devel branch.
You can also find support via our IRC channels:
#PyLink @ irc.overdrivenetworks.com
(webchat)
or #PyLink @ chat.freenode.net
. Ask your questions and be
patient for a response.
Installation
Installing from source (recommended)
First, make sure the following dependencies are met:
- Python 3.4+
- Setuptools (
pip3 install setuptools
) - PyYAML (
pip3 install pyyaml
) - ircmatch
(
pip3 install ircmatch
) - For the servprotect plugin: expiringdict (install this from source; installation is broken in pip due to mailgun/expiringdict#13)
Clone the repository:
git clone https://github.com/GLolol/PyLink && cd PyLink
Install PyLink using
python3 setup.py install
(global install) orpython3 setup.py install --user
(local install)- Note:
--user
is a literal string; do not replace it with your username.
- Note:
Installing via PyPI
Make sure you’re running the right pip command: on most distros, pip for Python3 uses the command
pip3
.Run
pip3 install pylinkirc
to download and install PyLink. pip will automatically resolve dependencies.Download or copy https://github.com/GLolol/PyLink/blob/master/example-conf.yml for an example configuration.
Configuration
Rename
example-conf.yml
topylink.yml
(or a similarly named.yml
file) and configure your instance there. Note that the configuration format isn’t finalized yet - this means that your configuration may break in an update!Run
pylink
from the command line. PyLink will load its configuration frompylink.yml
by default, but you can override this by runningpylink
with a config argument (e.g.pylink mynet.yml
).
Supported IRCds
Primary support
These IRCds (in alphabetical order) are frequently tested and well supported. If any issues occur, please file a bug on the issue tracker.
- charybdis (3.5+ / git master) -
module
ts6
- InspIRCd 2.0.x - module
inspircd
- For vHost setting to work,
m_chghost.so
must be loaded. - Supported channel, user, and prefix modes are negotiated on connect, but hotloading modules that change these is not supported. After changing module configuration, it is recommended to SQUIT PyLink to force a protocol renegotiation.
- For vHost setting to work,
- UnrealIRCd 4.x - module
unreal
- Linking to UnrealIRCd 3.2 servers is only supported when using an
UnrealIRCd 4.x server as a hub, with topology such as
pylink<->unreal4<->unreal3.2
. We nevertheless encourage you to upgrade so all your IRCds are running the same version.
- Linking to UnrealIRCd 3.2 servers is only supported when using an
UnrealIRCd 4.x server as a hub, with topology such as
Extended support
Support for these IRCds exist, but are not tested as frequently and thoroughly. Bugs should be filed if there are any issues, though they may not always be fixed in a timely fashion.
- Elemental-IRCd
(6.6.x / git master) - module
ts6
- InspIRCd 2.2 (git master) -
module
inspircd
- IRCd-Hybrid (8.2.x / svn
trunk) - module
hybrid
- Note: for host changing support and optimal functionality, a
service{}
block / U-line should be added for PyLink on every IRCd across your network.
- Note: for host changing support and optimal functionality, a
- juno-ircd (11.x /
janet) - module
ts6
(see configuration example) - Nefarious IRCu
(2.0.0+) - module
nefarious
- Note: Both account cloaks (user and oper) and hashed IP cloaks are optionally supported (HOST_HIDING_STYLE settings 0 to 3). Make sure you configure PyLink to match your IRCd settings.
- For optimal functionality (mode overrides in relay, etc.), consider
adding
UWorld{}
blocks / U-lines for every server that PyLink spawns.
Other TS6 and P10 variations may work, but are not officially supported.