Skip to content

Latest commit

 

History

History
181 lines (132 loc) · 5.92 KB

ts6.md

File metadata and controls

181 lines (132 loc) · 5.92 KB
Raw

TS6 support

This document details how to use juno with software implementing the TS6 linking protocol.

The TS6 protocol module can be used to link juno with a variety of IRC servers and other software. While it is also possible to link juno servers via TS6, the native Extensible Linking Protocol is strongly preferred for such.

Listening for TS6

The current implementation requires dedicated ports for TS6 links. This is because it is far too complicated to try to distinguish between different server protocols, particularly when each is provided in the form of an optional module.

Port configuration is only necessary if you intend to accept connections from TS6 servers. If juno will be initiating the connection (such as with CONNECT or autoconnect), you do not necessarily have to listen for TS6.

In your listen blocks, add ts6port and/or ts6sslport options. Values are the same as port; lists and ranges are accepted.

In your connect blocks for TS6 uplinks, you must also specify the ircd option from the list of supported software below.

Supported software

This is a list of IRC servers and packages that have been tested and seem to work well with juno TS6. Other software may also be supported using custom mode mappings and options.

atheme

Provides nickname and channel registration, plus a lot of other stuff.

Specify the ircd = 'atheme' option in the connect block.

Compile and install the provided protocol module:

cd /path/to/atheme
cd modules/contrib
cp /path/to/juno/extra/atheme/juno.c .
make
make install

Be sure to configure atheme to load modules that are associated with your status mode configuration. The below example is appropriate if you're using juno's default +qaohv configuration.

loadmodule "modules/contrib/juno";

# Disable these if they are disabled in juno configuration
loadmodule "modules/chanserv/owner";
loadmodule "modules/chanserv/protect";
loadmodule "modules/chanserv/halfop";

The provided protocol module assumes +qaohv, so if you want to disable certain statuses, then you should use atheme's protocol mixin modules.

PyLink

Provides a multi-network IRC relay and additional miscellaneous services.

In the connect block of your juno configuration, specify ircd = 'pylink'.

In the server block of your PyLink configuration, use the protocol: ts6. On PyLink 2.0+, specify ircd: elemental. On earlier versions, instead enable the use_elemental_modes: true option.

Also enable use_owner, use_admin, and use_halfop if these modes are enabled on your juno instance (with juno's default configuration, these should be enabled).

Example configuration for PyLink 2.0+

junonet:
	
    protocol: ts6
    ircd: elemental
    
    # Disable these if they are disabled in juno configuration
    use_owner: true
    use_admin: true
    use_halfop: true

    # Other options...

charybdis

Specify the ircd = 'charybdis' option in the connect block.

Nick length

Make sure that your configured nick length is consistent with the one you compiled charybdis with; otherwise, users with longer nicks will be killed as soon as they are propagated.

Ban propagation

You definitely want to have this enabled in your charybdis configuration:

use_propagated_bans = yes;

Also make sure that your shared block matches juno uplinks. As of writing, the one in the default configuration matches all servers:

shared {
	oper = "*@*", "*";
	flags = all, rehash;
};

Remote oper notices

If you want to see remote server notices from charybdis, be sure to enable the juno oper notice flags associated with each desired snomask letter. However, since juno notice flags are very verbose and fine-tunable, you can get most information from local notices.

ratbox

Specify the ircd = 'ratbox' option in the connect block.

Nick length

Make sure that your configured nick length is consistent with the one you compiled ratbox with; otherwise, users with longer nicks will be killed as soon as they are propagated. RATBOX HAS A VERY LOW DEFAULT NICK LENGTH.

Ban propagation

Adding cluster and shared blocks to your ratbox configuration is strongly recommended due to the fact that it lacks a global ban mechanism. This will effectively make all K-Lines, nick reserves, etc. which originated on ratbox global, just as they would be if they were set on juno.

cluster {
	name = "*";
	flags = all;
};

shared {
	oper = "*@*", "*";
	flags = all;
};

Known issues

  • Hostname limitations: ratbox has hostname length limits stricter than other servers, so hostnames may be truncated. Also, it does not support forward slashes (/) in hosts, so they are rewritten as dots (.). Each of these issues reduces the efficacy of bans.

  • NICKDELAY: ratbox does not support a nick delay command, which is used by services to prevent users from switching back to a nickname immediately after services forced them to a "Guest" nick. When linking ratbox to services, RESV is used instead, but if ratbox reaches services indirectly via juno, it cannot understand the encapsulated NICKDELAY command that would normally be forwarded to it. To resolve this, juno attempts to find NickServ using the services:nickserv config option, using it as the source of a RESV command. See issue #137.

  • Cloaking: ratbox does not support hostname cloaking. Consequently, on ratbox servers, users with hidden hosts will show their cloak as their real host, but the underlying IP address can easily be exposed to regular users with a simple WHOIS command. There are plans to add an option to spoof the IP address field so that this is not possible.