GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-11-01 09:19:23 +01:00
Code Issues Projects Releases Wiki Activity
https://github.com/jlu5/PyLink
1,183 Commits 5 Branches 72 Tags 7.2 MiB
Python 100%
4cfc262bfb
Go to file
James Lu 4cfc262bfb coreplugin: optionally respect umode +H (hideoper) (#214)
2016-05-20 20:48:41 -07:00
docs docs/t: rewrite parts of writing-plugins.md 2016-05-19 23:42:42 -07:00
log Make sure log/ exists 2015-07-18 20:13:53 -07:00
plugins relay: optionally relay home server & login details in /WHOIS 2016-05-19 23:32:43 -07:00
protocols Purge c_ and u_ prefixes from named modes 2016-05-15 11:05:02 -07:00
tests Use more flexible shebangs (/usr/bin/env python3) 2016-04-01 18:22:02 -07:00
.gitignore gitignore: Ignore env folder for virtualenvs 2016-03-29 19:52:57 +10: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: introduce isServiceBot checker 2016-05-14 16:17:12 -07:00
conf.py conf: fix testconf missing the logging: section 2016-03-11 23:14:16 -08:00
coreplugin.py coreplugin: optionally respect umode +H (hideoper) (#214) 2016-05-20 20:48:41 -07:00
example-conf.yml coreplugin: optionally respect umode +H (hideoper) (#214) 2016-05-20 20:48:41 -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 README: update U-Line note for nefarious 2016-05-01 21:58:10 -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 ServiceBot.call_cmd: support notice and called_by keys 2016-05-15 11:25:47 -07:00
world.py Begin work on service bot abstraction (#216) 2016-05-14 09:55: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

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 (experimental)
    • Note: FAKE hosts (+f), account cloaks (user and oper), and hashed IP cloaks are supported. 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.
    • Host changing for internal PyLink clients does not work. It should work for other users though.
    • Usermode +h ident@host is not supported at this time.

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???