GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-12-24 11:42:51 +01:00
Code Issues Projects Releases Wiki Activity
https://github.com/jlu5/PyLink
1,712 Commits 5 Branches 72 Tags 7.2 MiB
Python 100%
945818e1d8
Go to file
James Lu 945818e1d8 Refresh protocol module spec for 0.10 (#284) 
Reword various things, and update links to source code references. Also, mention the following:

- conf_keys validation (#282)
- Topic acceptance rules (or rather, the lack thereof: #277)
2016-08-24 23:25:36 -07:00
coremods core: rehashable file loggers with log rotation support 2016-08-17 21:42:18 -07:00
docs Refresh protocol module spec for 0.10 (#284) 2016-08-24 23:25:36 -07:00
log Make sure log/ exists 2015-07-18 20:13:53 -07:00
plugins relay: fix overzealous host normalization due to variable replacement during iteration 2016-08-21 18:06:53 -07:00
protocols clientbot: fix nick() using the wrong arguments 2016-08-24 22:54:53 -07:00
.codeclimate.yml Add .codeclimate.yml 2016-06-08 07:56:10 -07:00
.gitignore Make plugins/ and protocols/ namespaces 2016-07-20 23:55:26 -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: make throttle time configurable per server (defaults to 0.01s) 2016-08-21 17:25:09 -07:00
conf.py Make server config validation protocol specific 2016-07-28 21:34:00 -07:00
example-conf.yml Irc: make throttle time configurable per server (defaults to 0.01s) 2016-08-21 17:25:09 -07:00
LICENSE.CC-BY-SA-4.0 Relicense docs under CC-BY-SA-4.0 2016-07-09 00:14:24 -07:00
LICENSE.MPL2 Relicense docs under CC-BY-SA-4.0 2016-07-09 00:14:24 -07:00
log.py log: configurable file rotation (size & backup count) 2016-08-17 22:01:00 -07:00
pylink launcher: show VCS version in "pylink -v" 2016-08-23 07:28:48 -07:00
README.md Merge remote-tracking branch 'origin/master' into devel 2016-08-17 21:22:31 -07:00
RELNOTES.md Release 0.9.1 2016-08-06 20:00:57 -07:00
setup.py setup: refresh classifiers 2016-08-04 00:27:50 -07:00
structures.py Move DataStore to structures (untested) 2016-05-14 14:53:19 -07:00
update.sh update.sh: pass arguments to pylink 2016-07-16 21:58:39 -07:00
utils.py ServiceBot: use newline-agnostic str.splitlines() to split up docstrings 2016-08-02 12:38:15 -07:00
VERSION Bump version to 0.10-alpha1 2016-08-21 17:12:50 -07:00
world.py core: rename IrcUser.identified attribute to IrcUser.account 2016-07-29 20:16:05 -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.

PyLink and any bundled software are licensed under the Mozilla Public License, version 2.0 (LICENSE.MPL2). The corresponding documentation in the docs/ folder is licensed under the Creative Attribution-ShareAlike 4.0 International License. (LICENSE.CC-BY-SA-4.0)

Support

First, MAKE SURE you’ve read the FAQ!

When upgrading between major versions, remember to read the release notes for any breaking changes!

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.

Installation

Installing from source (recommended)

First, make sure the following dependencies are met:

  • Python 3.4+
  • Setuptools (pip3 install setuptools)
  • PyYAML (pip3 install pyyaml)
  • ircmatch (pip3 install ircmatch)
  • For the servprotect plugin: expiringdict (install this from source; installation is broken in pip due to mailgun/expiringdict#13)

  1. Clone the repository: git clone https://github.com/GLolol/PyLink && cd PyLink

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

    • Note: --user is a literal string; do not replace it with your username.

Installing via PyPI

  1. Make sure you’re running the right pip command: on most distros, pip for Python3 uses the command pip3.

  2. Run pip3 install pylinkirc to download and install PyLink. pip will automatically resolve dependencies.

  3. Download or copy https://github.com/GLolol/PyLink/blob/master/example-conf.yml for an example configuration.

Configuration

  1. Rename example-conf.yml to pylink.yml (or a similarly named .yml file) 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. PyLink will load its configuration from pylink.yml by default, but you can override this by running pylink with a config argument (e.g. pylink mynet.yml).

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
    • For vHost setting to work, m_chghost.so must be loaded.
    • 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.
  • UnrealIRCd 4.x - module unreal
    • Linking to UnrealIRCd 3.2 servers is only supported when using an UnrealIRCd 4.x server as a hub, with topology such as pylink<->unreal4<->unreal3.2. We nevertheless encourage you to upgrade so all your IRCds are running the same version.

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 (11.x / janet) - module ts6 (see configuration example)
  • 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.), consider adding UWorld{} blocks / U-lines for every server that PyLink spawns.

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