3
0
mirror of https://github.com/jlu5/PyLink.git synced 2024-12-30 14:42:50 +01:00
PyLink/docs/pylink-opers.md
2016-04-02 09:45:35 -07:00

2.9 KiB
Raw Blame History

Opering with PyLink Relay

This guide was written for the OVERdrive-IRC network, but may be applicable elsewhere.

PyLink Relay behaves much like Janus, an extended service used to relay channels together. This guide goes over some of the basic oper commands in Relay, along with the best ways to handle channel emergencies.

How nick suffixing work

When joining a relay channel, every user from another network will have a network tag attached to their name. The purpose of this is to prevent nick collisions from the same nick being used on multiple nets, and ensure that different networks registered nicks remain separate.

How is this relevant? Firstly, it means that you cannot ban users from entire networks using banmasks such as */net1!*@*! The nick suffix is something PyLink adds artificially; on net1s IRCd, which is checking the bans locally, the nick suffix simply doesnt exist.

However, this does mean that you can effectively give access to remote users via services, by specifying masks such as */net1@someident@someperson.opers.somenet.org. Just dont make masks too wide, or you risk getting channel takeovers.

Basic linking commands

The concept of relay channels in PyLink is greatly inspired from the original Janus implementation, though with a few differences in command syntax.

To create a channel: - /msg PyLink create #channelname

To link to a channel already created on a different network: - /msg PyLink link othernet #channelname

You can also link remote channels to take a different name on your network. (This is the third argument to the LINK command) - /msg PyLink link othernet #lobby #othernet-lobby

Dealing with channel emergencies

PyLink is not designed with the ability to forward KILLs, G:Lines, or any network bans. The best thing to do in the case of emergencies is to delink the problem networks / channels! Kills are actively blocked by the PyLink daemon (user is just respawned), while X:Lines are simply ignored, as there isnt any code to handle them yet.

To delink another network from a channel your network owns:

  • /msg PyLink delink #yourchannel badnetwork

To delink your network from a bad networks channel:

  • /msg PyLink delink #badchannel

Basically, only one of the two above commands will work for one specific channel. Almost always, the network that owns a channel should be the one who has it registered via their services. You can see a list of channels by typing /msg PyLink linked.

When a network starts causing disconnect spam

Juping an individual net.relay server will likely cause PyLink Relay to break or disconnect completely. When a network starts acting up and disconnecting frequently (and causing netsplit/quit floods), you should disable autoconnect for this network:

  • /msg PyLink autoconnect badnetwork -1 (setting autoconnect to 0 or below will cause it to be disabled)