3
0
mirror of https://github.com/jlu5/PyLink.git synced 2024-12-28 21:52:38 +01:00

inspircd: document target_version variable

This commit is contained in:
James Lu 2019-06-06 23:49:27 -07:00
parent 2b04050bf5
commit 04d36e93a1
2 changed files with 12 additions and 4 deletions

View File

@ -78,7 +78,9 @@ These IRCds (in alphabetical order) are frequently tested and well supported. If
* [charybdis](https://github.com/charybdis-ircd/charybdis) (3.5+) - module `ts6`
- For KLINE support to work, a `shared{}` block should be added for PyLink on all servers.
* [InspIRCd](http://www.inspircd.org/) 2.0.x - module `inspircd`
* [InspIRCd](http://www.inspircd.org/) 2.0, 3.x [BETA] - module `inspircd`
- Both InspIRCd 2.0 and 3.x are supported by this module.
Set the `target_version` option to `insp3` to target InspIRCd 3.x, or `insp20` to target InspIRCd 2.0 (currently the default).
- For vHost setting to work, `m_chghost.so` must be loaded. For ident and realname changing support, `m_chgident.so` and `m_chgname.so` must be loaded respectively.
- 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.
* [Nefarious IRCu](https://github.com/evilnet/nefarious2) (2.0.0+) - module `p10`
@ -99,8 +101,6 @@ Support for these IRCds exist, but are not tested as frequently and thoroughly.
- For KLINE support to work, a `shared{}` block should be added for PyLink on all servers.
* [Elemental-IRCd](https://github.com/Elemental-IRCd/elemental-ircd) (6.6.x / git master) - module `ts6`
- For KLINE support to work, a `shared{}` block should be added for PyLink on all servers.
* [InspIRCd](http://www.inspircd.org/) 3.0.x (git master) - module `inspircd`
- The same notes for InspIRCd 2.x apply here as well.
* [IRCd-Hybrid](http://www.ircd-hybrid.org/) (8.2.x / svn trunk) - module `hybrid`
- For host changing support and optimal functionality, a `service{}` block / U-line should be added for PyLink on every IRCd across your network.
- For KLINE support to work, a `shared{}` block should also be added for PyLink on all servers.

View File

@ -152,7 +152,6 @@ servers:
# CHANGE THIS to some abbreviation representing your network; usually
# something 3-5 characters should be good.
inspnet:
# Server IP, port, and passwords. The ip: field also supports resolving
# hostnames.
ip: 127.0.0.1
@ -186,6 +185,15 @@ servers:
# IRCds.
protocol: "inspircd"
# InspIRCd specific option: sets the target InspIRCd protocol version.
# Valid values include:
# "insp20" - InspIRCd 2.0.x (1202) [DEFAULT†]
# "insp3" - InspIRCd 3.x (1205) [BETA]
#target_version: insp20
#target_version: insp3
# † InspIRCd 2.0 servers can link to InspIRCd 3.0 via built-in link compatibility, but some
# new features may not work correctly.
# Sets the max nick length for the network. It is important that this is set correctly, or
# PyLink might introduce a nick that is too long and cause netsplits!
# This defaults to 30 if not set.