coremods | ||
docs | ||
plugins | ||
protocols | ||
test | ||
.gitattributes | ||
.gitignore | ||
.mailmap | ||
.travis.yml | ||
AUTHORS | ||
classes.py | ||
conf.py | ||
example-conf.yml | ||
launcher.py | ||
LICENSE.CC-BY-SA-4.0 | ||
LICENSE.MPL2 | ||
log.py | ||
pylink | ||
pylink-mkpasswd | ||
README.md | ||
RELNOTES.md | ||
selectdriver.py | ||
setup.py | ||
structures.py | ||
utils.py | ||
VERSION | ||
world.py |
PyLink IRC Services
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 for developing IRC services.
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 the project
Obtaining 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 channel at
#PyLink @ irc.overdrivenetworks.com
(webchat).
Ask your questions and be patient for a response.
Installation
Pre-requisites
- CPython 3.5 or above (other intepreters are untested and unsupported)
- A Unix-like operating system: PyLink is actively developed on Linux only, so we cannot guarantee that things will work properly on other systems.
If you are a developer and want to help make PyLink more portable, patches are welcome.
Installing from source
First, make sure the following dependencies are met:
- Setuptools (
pip3 install setuptools
) - PyYAML (
pip3 install pyyaml
) - For hashed password support: Passlib >= 1.7.0
(
pip3 install passlib
) - For better PID file tracking (i.e. removing stale PID files
after a crash): psutil (
pip3 install psutil
) - For the servprotect plugin: cachetools
(
pip3 install cachetools
)
- Setuptools (
Clone the repository:
git clone https://github.com/jlu5/PyLink && cd PyLink
Pick your branch.
- By default you’ll be on the master branch, which contains the latest stable code. This branch is recommended for production networks that don’t require new features or intensive bug fixes as they are developed.
- The devel branch is where active development goes,
and it can be accessed by running
git checkout devel
in your Git tree.
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. - Whenever you switch branches or update PyLink’s sources via
git pull
, you will need to re-run this command for changes to apply!
- Note:
Installing via PyPI (stable branch only)
Make sure you’re running the right pip command: on most distros, pip for Python 3 uses the command
pip3
.Run
pip3 install pylinkirc
to download and install PyLink. pip will automatically resolve dependencies.Download or copy https://github.com/jlu5/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+) - module
ts6
- For KLINE support to work, a
shared{}
block should be added for PyLink on all servers.
- For KLINE support to work, a
- InspIRCd 2.0, 3.x [BETA] -
module
inspircd
- Both InspIRCd 2.0 and 3.x are supported by this module. Set the
target_version
option toinsp3
to target InspIRCd 3.x, orinsp20
to target InspIRCd 2.0 (currently the default). - For vHost setting to work,
m_chghost.so
must be loaded. For ident and realname changing support,m_chgident.so
andm_chgname.so
must be loaded respectively. - 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.
- Both InspIRCd 2.0 and 3.x are supported by this module. Set the
- Nefarious IRCu
(2.0.0+) - module
p10
- 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.
- Note: Both account cloaks (user and oper) and hashed IP cloaks are
optionally supported (
- UnrealIRCd 4.x (4.0.12+) -
module
unreal
- UnrealIRCd 4.x before version 4.0.12 suffers from bug #4890 which
causes hostname desyncs on servers not directly linked to PyLink
(e.g.
pylink<->serverA<->serverB
creates desynced hostnames on server B). This problem is fixed by upgrading your IRCds. - Linking to UnrealIRCd 3.2 servers is only possible 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.
- UnrealIRCd 4.x before version 4.0.12 suffers from bug #4890 which
causes hostname desyncs on servers not directly linked to PyLink
(e.g.
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.
- beware-ircd (1.6.3) - module
p10
- Because bircd disallows BURST after ENDBURST for regular servers,
U-lines are required for all PyLink servers. Fortunately, wildcards are
supported in U-lines, so you can add something along the lines of
U:<your pylink server>:
andU:*.relay:
(adjust accordingly for your relay server suffix). - Use
ircd: snircd
as the target IRCd. - Halfops,
sethost
(+h
), and account-based cloaking (VHostStyle=1
) are supported. Crypted IPs and static hosts (VHostStyle
2 and 3) are NOT.
- Because bircd disallows BURST after ENDBURST for regular servers,
U-lines are required for all PyLink servers. Fortunately, wildcards are
supported in U-lines, so you can add something along the lines of
- ChatIRCd (1.2.x /
git master) - module
ts6
- For KLINE support to work, a
shared{}
block should be added for PyLink on all servers.
- For KLINE support to work, a
- Elemental-IRCd
(6.6.x / git master) - module
ts6
- For KLINE support to work, a
shared{}
block should be added for PyLink on all servers.
- For KLINE support to work, a
- IRCd-Hybrid (8.2.x / svn
trunk) - module
hybrid
- For host changing support and optimal functionality, a
service{}
block / U-line should be added for PyLink on every IRCd across your network. - For KLINE support to work, a
shared{}
block should also be added for PyLink on all servers.
- For host changing support and optimal functionality, a
- ircd-ratbox (3.x) - module
ts6
- Host changing is not supported.
- On ircd-ratbox, all known IPs of users will be shown in
/whois
, even if the client is e.g. a cloaked relay client. If you’re paranoid about this, turn off Relay IP forwarding on the ratbox network(s). - For KLINE support to work, a
shared{}
block should be added for PyLink on all servers.
- IRCu (u2.10.12.16+) -
module
p10
- Host changing is not supported.
- juno-ircd (13.x / ava)
- module
ts6
(see configuration example) - ngIRCd (24+) - module
ngircd
- For GLINEs to propagate, the
AllowRemoteOper
option must be enabled in ngIRCd. +
(modeless) channels are not supported, and should be disabled for PyLink to function correctly.
- For GLINEs to propagate, the
- snircd (1.3.x+) -
module
p10
- Outbound host changing (i.e. for the
changehost
plugin) is not supported on P10 variants other than Nefarious.
- Outbound host changing (i.e. for the
Other TS6 and P10 variations may work, but are not officially supported.
Clientbot
Since v1.0, PyLink supports connecting to IRCds as a relay bot and forwarding users back, similar to Janus’ Clientbot. This can be useful if the IRCd a network used isn’t supported, or if you want to relay certain channels without fully linking with a network.
For Relay to work properly with Clientbot, be sure to load the
relay_clientbot
plugin in conjunction with
relay
.