diff --git a/README.md b/README.md index 7e1b523..769185e 100644 --- a/README.md +++ b/README.md @@ -36,8 +36,10 @@ These IRCds (in alphabetical order) are frequently tested and well supported. If * [charybdis](http://charybdis.io/) (3.5+ / git master) - module `ts6` * [InspIRCd](http://www.inspircd.org/) 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 * [UnrealIRCd](https://www.unrealircd.org/) 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` + - 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 @@ -47,10 +49,10 @@ Support for these IRCds exist, but are not tested as frequently and thoroughly. * [InspIRCd](http://www.inspircd.org/) 2.2 (git master) - module `inspircd` * [IRCd-Hybrid](http://www.ircd-hybrid.org/) (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](https://github.com/cooper/yiria) (11.x / janet) - module `ts6` (with elemental-ircd modes) +* [juno-ircd](https://github.com/cooper/yiria) (11.x / janet) - module `ts6` (see [configuration example](https://github.com/cooper/juno/blob/master/doc/ts6.md#pylink)) * [Nefarious IRCu](https://github.com/evilnet/nefarious2) (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. + - 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. @@ -58,7 +60,7 @@ Other TS6 and P10 variations may work, but are not officially supported. 1) Install PyLink by using `python3 setup.py install` (global install) or `python3 setup.py install --user` (local install; note: `--user` is a *literal* string) -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! +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! Read the [release notes](RELNOTES.md) before updating to see if anything has changed. 3) Run `pylink` from the command line. diff --git a/docs/faq.md b/docs/faq.md index 7d89dd4..3915fe8 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -8,19 +8,21 @@ InterJanus-style links between PyLink daemons are not supported yet; see https:/ ### Does PyLink support Clientbot relay like Janus? -Not yet; see https://github.com/GLolol/PyLink/issues/144 +Yes, starting with PyLink 0.10. Clientbot support is in alpha stages and is far from complete: [Clientbot TODO](https://github.com/GLolol/PyLink/issues?q=is%3Aissue+is%3Aopen+label%3Aprotocols%2Fclientbot). ### What are PyLink Relay's benefits over Janus? In no particular order: - More complete support for modern IRCds (UnrealIRCd 4.x, InspIRCd 2.0, charybdis 4, Nefarious IRCu, etc.). -- Built upon a flexible, maintainable codebase. -- Cross platform (*nix and Windows). -- Proper protocol negotiation: better support for channel modes (+fjMOR, etc.), nick length limits, and WHOIS. +- PyLink is built upon a flexible, maintainable codebase. +- Cross platform (*nix, Windows, and probably others too). +- Proper protocol negotiation leading to fewer DoS possibilities: + - Better support for channel modes such as +fjMOR, etc. + - Configurable nick length limits for relayed users. ### I turned autoconnect for PyLink on, and now I'm getting errors! -PyLink does not support inbound connections - much like Atheme or Anope, it only connects outwards to IRCds. (If you don't understand what this means, it means you should turn autoconnect OFF for PyLink) +PyLink does not support inbound connections - much like regular services such as Atheme or Anope, it only connects outwards *to* IRCds. (If you don't understand what this means, it means you should turn autoconnect OFF for PyLink) ### I get errors like "ImportError: No module named 'yaml'" when I start PyLink -- You are missing dependencies - re-read https://github.com/GLolol/PyLink#dependencies \ No newline at end of file +- You are missing dependencies - re-read https://github.com/GLolol/PyLink#dependencies