Package: pylinkirc
PyLink IRC ServicesEND OF LIFE NOTICE: This project is no longer maintained. So long and thanks for all the fish.PyLink is an extensible, plugin-based IRC services framework written in Python. It aims to be:a transparent server-side relayer between IRC networks.a versatile framework for developing IRC services.PyLink is licensed under the Mozilla Public License, version 2.0 (LICENSE.MPL2). Thecorresponding documentationis licensed under the Creative Attribution-ShareAlike 4.0 International License. (LICENSE.CC-BY-SA-4.0)Getting helpFirst, MAKE SURE you've read theFAQ!When upgrading between major versions, remember to read therelease notesfor any breaking changes!Please report any bugs you find to theissue tracker. Pull requests are likewise welcome.InstallationPre-requisitesPython 3.7 or above - prefer the newest Python 3.x when availableA 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 sourceFirst, make sure the following dependencies are met:Setuptools (pip3 install setuptools)PyYAML (pip3 install pyyaml)cachetools (pip3 install cachetools)For hashed password support: Passlib >= 1.7.0 (pip3 install passlib)For Unicode support in Relay: unidecode (pip3 install Unidecode)For extended PID file tracking (i.e. removing stale PID files after a crash): psutil (pip3 install psutil)Clone the repository:git clone https://github.com/PyLink/PyLink && cd PyLinkPreviously there was adevelbranch for testing versions of PyLink - this practice has since been discontinued.Install PyLink usingpython3 setup.py install(global install) orpython3 setup.py install --user(local install)Note:--useris aliteralstring;do notreplace it with your username.Whenever you switch branches or update PyLink's sources viagit pull, you will need to re-run this command for changes to apply!Installing via DockerAs of PyLink 3.0 there is a Docker image available on Docker Hub:jlu5/pylinkIt supports the following tags:Rolling tags:latest(latest stable/RC release),latest-beta(latest beta snapshot)Pinned to a major branch: e.g.3(latest 3.x stable release),3-beta(latest 3.x beta snapshot)Pinned to a specific version: e.g.3.0.0To use this image you should mount your configuration/DB folder into/pylink.Make sure this directory is writable by UID 10000.$dockerrun-v$HOME/pylink:/pylinkjlu5/pylinkInstalling via PyPI (stable branch only)Make sure you're running the right pip command: on most distros, pip for Python 3 uses the commandpip3.Runpip3 install pylinkircto download and install PyLink. pip will automatically resolve dependencies.Download or copyhttps://github.com/PyLink/PyLink/blob/master/example-conf.ymlfor an example configuration.ConfigurationRenameexample-conf.ymltopylink.yml(or a similarly named.ymlfile) and configure your instance there.Runpylinkfrom the command line. PyLink will load its configuration frompylink.ymlby default, but you can override this by runningpylinkwith a config argument (e.g.pylink mynet.yml).Supported IRCdsPrimary supportThese IRCds (in alphabetical order) are frequently tested and well supported. If any issues occur, please file a bug on the issue tracker.InspIRCd(2.0 - 3.x) - moduleinspircdSet thetarget_versionoption toinsp3to target InspIRCd 3.x (default), orinsp20to target InspIRCd 2.0 (legacy).For vHost setting to work,m_chghost.somust be loaded. For ident and realname changing support,m_chgident.soandm_chgname.somust 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.Nefarious IRCu(2.0.0+) - modulep10Note: Both account cloaks (user and oper) and hashed IP cloaks are optionally supported (HOST_HIDING_STYLEsettings 0 to 3). Make sure you configure PyLink to match your IRCd settings.UnrealIRCd(4.2.x - 5.0.x) - moduleunrealSupported 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.Extended supportSupport 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.charybdis(3.5+) - modulets6For KLINE support to work, ashared{}block should be added for PyLink on all servers.ChatIRCd(1.2.x / git master) - modulets6For KLINE support to work, ashared{}block should be added for PyLink on all servers.juno-ircd(13.x / ava) - modulets6(seeconfiguration example)ngIRCd(24+) - modulengircdFor GLINEs to propagate, theAllowRemoteOperoption must be enabled in ngIRCd.+(modeless) channels are not supported, and should be disabled for PyLink to function correctly.For use with Relay, theCloakHostModeXsetting will work fine butCloakHostandCloakUserToNickarenotsupported.Legacy extended supportSupport for these IRCds was added at some point but is no longer actively maintained, either due to inactive upstream development or a perceived lack of interest. We recommend migrating to an IRCd in the above two sections.beware-ircd(1.6.3) - modulep10Because 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 ofU:<your pylink server>:andU:*.relay:(adjust accordingly for your relay server suffix).Useircd: snircdas the target IRCd.Halfops,sethost(+h), and account-based cloaking (VHostStyle=1) are supported. Crypted IPs and static hosts (VHostStyle2 and 3) are NOT.Elemental-IRCd(6.6.x / git master) - modulets6For KLINE support to work, ashared{}block should be added for PyLink on all servers.IRCd-Hybrid(8.2.x / svn trunk) - modulehybridFor host changing support and optimal functionality, aservice{}block / U-line should be added for PyLink on every IRCd across your network.For KLINE support to work, ashared{}block should also be added for PyLink on all servers.ircd-ratbox(3.x) - modulets6Host 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, ashared{}block should be added for PyLink on all servers.IRCu(u2.10.12.16+) - modulep10Host changing (changehost, relay) is not supported.snircd(1.3.x+) - modulep10Outbound host changing (i.e. for thechangehostplugin) is not supported.ClientbotPyLink supports connecting to IRCds as a relay bot and forwarding users back as virtual clients, 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 therelay_clientbotplugin in conjunction withrelay.Note:Clientbot links can only be used as a leaf for Relay links - they CANNOT be used to host channels!This means that Relay does not support having all your networks be Clientbot - in those cases you are better off using a classic relay bot, likeRelayNext for Limnoria.