GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-12-25 04:02:45 +01:00
Code Issues Projects Releases Wiki Activity
https://github.com/jlu5/PyLink
1,230 Commits 5 Branches 72 Tags 7.2 MiB
Python 100%
fa3d230ac9
Go to file
James Lu fa3d230ac9 IncrementalUIDGenerator: normalize SID to strings
2016-06-16 21:55:32 -07:00
docs docs/t/writing-plugins: mention main() and die() 2016-06-11 11:03:16 -07:00
log Make sure log/ exists 2015-07-18 20:13:53 -07:00
plugins Ctcp plugin: handles basic VERSION requests 2016-06-15 11:31:40 -07:00
protocols hybrid: rename debug umode (+g) to sno_debug 2016-05-31 20:57:17 -07:00
tests Use more flexible shebangs (/usr/bin/env python3) 2016-04-01 18:22:02 -07:00
.codeclimate.yml Add .codeclimate.yml 2016-06-08 07:56:10 -07:00
.gitignore .gitignore: don't ignore dotfile .yml confs 2016-06-08 07:56:10 -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 Irc: unconditionally call disconnect() on errors or ping timeouts 2016-06-15 10:55:47 -07:00
conf.py conf: fix testconf missing the logging: section 2016-03-11 23:14:16 -08:00
coreplugin.py core: configurable nicks for services (per-net and global) 2016-06-11 10:44:14 -07:00
example-conf.yml Ctcp plugin: handles basic VERSION requests 2016-06-15 11:31:40 -07:00
kill.sh Add wrapper scripts (start-cpulimit.sh, kill.sh) to assist running PyLink under cpulimit 2015-07-25 16:58:11 -07:00
LICENSE Add a LICENSE: MPL 2.0 2015-06-20 21:10:50 -07:00
log.py log: fix check for irc.pseudoclient 2016-05-14 13:52:21 -07:00
pylink pylink: remove call to coreplugin.main() 2016-04-30 16:44:27 -07:00
README.md case sensitivity is annoying 2016-06-04 18:51:22 -07:00
runtests runtests: remove .py extension, only run tests when ran as a script 2016-03-11 23:14:16 -08:00
start-cpulimit.sh start-cpulimit: pass command line options to ./pylink 2015-09-25 20:25:07 -07:00
structures.py Move DataStore to structures (untested) 2016-05-14 14:53:19 -07:00
utils.py IncrementalUIDGenerator: normalize SID to strings 2016-06-16 21:55:32 -07:00
world.py Remove leftover world.commands and world.whois_handlers 2016-05-21 23:02:46 -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 are frequently tested and well supported. If any issues occur, please file a bug on the issue tracker.

  • charybdis (3.5.x / 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 be 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.
  • 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. To make this easier, you may want to turn relay’s spawn_servers off, so that all relay users originate from one virtual server.

Setup

  1. Rename example-conf.yml to config.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!

  2. Run ./pylink from the command line.

  3. Profit???