GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-11-24 03:29:28 +01:00
Code Issues Projects Releases Wiki Activity
https://github.com/jlu5/PyLink
1,349 Commits 5 Branches 72 Tags 7.2 MiB
Python 100%
a9a6c22044
Go to file
James Lu a9a6c22044 setup.py: fix fallback version import path
2016-07-03 00:29:31 -07:00
coremods core: remove references to plugins/protocols_folder (#259) 2016-07-02 23:58:21 -07:00
docs protocols: return uplink field in SQUIT handlers 2016-06-25 13:34:43 -07:00
log Make sure log/ exists 2015-07-18 20:13:53 -07:00
plugins Generate __init__.py with package version on runtime 2016-07-03 00:26:03 -07:00
protocols inspircd: refactor opertype handling and opertypes for Services 2016-07-01 21:03:10 -07:00
.codeclimate.yml Add .codeclimate.yml 2016-06-08 07:56:10 -07:00
.gitignore .gitignore: ignore dist/ and egg-related data 2016-06-20 18:19:37 -07:00
.mailmap Add .mailmap 2016-03-17 15:08:41 -07:00
AUTHORS AUTHORS: add @DanielOaks 2016-04-07 19:05:41 -07:00
classes.py Generate __init__.py with package version on runtime 2016-07-03 00:26:03 -07:00
conf.py core: make maxnicklen optional, defaulting it to 30 2016-06-27 22:39:18 -07:00
example-conf.yml example-conf: capitalize our nick by default 2016-07-02 22:18:10 -07:00
LICENSE Add a LICENSE: MPL 2.0 2015-06-20 21:10:50 -07:00
log.py log: remove references to script directory 2016-06-20 18:23:05 -07:00
pylink Generate __init__.py with package version on runtime 2016-07-03 00:26:03 -07:00
README.md README: add juno-ircd (make @cooper happy) and links to IRCd pages 2016-07-01 22:03:49 -07:00
setup.py setup.py: fix fallback version import path 2016-07-03 00:29:31 -07:00
structures.py Move DataStore to structures (untested) 2016-05-14 14:53:19 -07:00
utils.py core: remove references to plugins/protocols_folder (#259) 2016-07-02 23:58:21 -07:00
world.py Generate __init__.py with package version on runtime 2016-07-03 00:26:03 -07:00

README.md

PyLink

PyLink is an extensible, plugin-based IRC services framework written in Python. It aims to be:

  1. a replacement for the now-defunct Janus.

  2. a versatile framework and gateway to IRC.

Support

First, MAKE SURE you’ve read the FAQ!

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.

Dependencies

  • Python 3.4+
  • PyYAML (pip install pyyaml)
  • For the servprotect plugin: expiringdict (note: unfortunately, installation is broken in pip due to mailgun/expiringdict#13)
  • For the changehost and opercmds plugins: ircmatch (pip install ircmatch)

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
  • UnrealIRCd 4.x - module unreal
    • Note: Support for mixed UnrealIRCd 3.2/4.0 networks is experimental, and requires you to enable a mixed_link option in the configuration. This may in turn void your support.

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.
  • juno-ircd (10.x / yiria) - module ts6 (with elemental-ircd modes)
  • 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.), a UWorld{} block / U-line should be added for every server that PyLink spawns.

Other TS6 and P10 variations may work, but are not officially supported.

Setup

  1. Install PyLink by using python3 setup.py install (global install) or python3 setup.py install --user (local install)

  2. Rename example-conf.yml to pylink.yml and configure your instance there. Note that the configuration format isn’t finalized yet - this means that your configuration may break in an update!

  3. Run pylink from the command line.

  4. Profit???