GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-12-28 13:42:37 +01:00
Code Issues Projects Releases Wiki Activity
https://github.com/jlu5/PyLink
576 Commits 5 Branches 72 Tags 7.2 MiB
Python 100%
f884d71cf0
Go to file
James Lu f884d71cf0 docs/pmodule-spec.md: formatting again
2015-09-24 18:39:33 -07:00
docs/technical docs/pmodule-spec.md: formatting again 2015-09-24 18:39:33 -07:00
log Make sure log/ exists 2015-07-18 20:13:53 -07:00
plugins relay: don't prepend sender prefixes more than once (for servers and clients not on any relay networks) 2015-09-20 18:13:39 -07:00
protocols Documentation updates, finish off pmodule-spec.md (#113) 2015-09-24 18:36:54 -07:00
tests tests/inspircd: remove checks for FMODE hook data, they change too often 2015-09-13 14:06:20 -07:00
.gitignore .gitignore: ignore .pem files 2015-08-10 20:26:10 -07:00
classes.py Move parseArgs and removeClient into the base Protocol class 2015-09-24 18:03:30 -07:00
conf.py Fix test cases 2015-09-12 22:34:55 -07:00
config.yml.example example conf: add full "netname" in server configuration 2015-09-20 11:55:51 -07:00
coreplugin.py coreplugin: protect the main PyLink client too, even though it's technically manipulatable 2015-09-20 16:55:04 -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 Support loading different config files from the command line 2015-08-03 19:27:19 -07:00
pylink pylink: always chdir to the PyLink root directory 2015-09-19 11:55:22 -07:00
README.md Various README fixes 2015-09-13 22:36:50 -07:00
runtests.py runtests: allow specifying files to test 2015-09-12 22:31:19 -07:00
start-cpulimit.sh start-cpulimit: update binary name for f6a4503372 2015-09-06 21:53:54 -07:00
utils.py TS6SIDGenerator: take an IRC object, and skip any SIDs that are currently in use 2015-09-20 18:32:43 -07:00
world.py world: fix 0f26848 (we can't use log here) 2015-09-19 11:55:29 -07:00

README.md

PyLink

PyLink is an extensible, plugin-based IRC Services framework written in Python. It aims to be a replacement for the now-defunct Janus.

Usage

PyLink is a work in progress and thus may be very unstable! No warranty is provided if this completely wrecks your network and causes widespread rioting amongst your users!

That said, please report any bugs you find to the issue tracker. Pull requests are open if you’d like to contribute: note that master is bugfix only; new stuff goes to the devel branch.

Dependencies

Dependencies currently include:

  • Python 3.4+
  • PyYAML (pip install pyyaml or apt-get install python3-yaml)
  • For the relay plugin only: expiringdict (pip install expiringdict/apt-get install python3-expiringdict)

Supported IRCds

  • InspIRCd 2.0.x - module inspircd
  • charybdis (3.5.x / git master) - module ts6
  • Elemental-IRCd (6.6.x / git master) - module ts6

Setup

  1. Rename config.yml.example 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???