From a1e0de800d04733ccb0f8ae3e0e7de07c76beb82 Mon Sep 17 00:00:00 2001 From: James Lu Date: Tue, 29 Dec 2020 22:02:12 +0000 Subject: [PATCH] Document relaymsg in matterbridge.toml.sample --- matterbridge.toml.sample | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/matterbridge.toml.sample b/matterbridge.toml.sample index 9749080f..a92892b0 100644 --- a/matterbridge.toml.sample +++ b/matterbridge.toml.sample @@ -193,6 +193,19 @@ ShowTopicChange=false #OPTIONAL (default 0) JoinDelay=0 +#Use the optional RELAYMSG extension for username spoofing on IRC. +#This requires an IRCd that supports the draft/relaymsg specification: currently this includes +#Oragono 2.4.0+ and InspIRCd 3 with the m_relaymsg contrib module. +#See https://github.com/42wim/matterbridge/issues/667#issuecomment-634214165 for more details. +#Spoofed nicks will use the configured RemoteNickFormat, replacing reserved IRC characters +#(!+%@&#$:'"?*,.) with a hyphen (-). +#On most configurations, the RemoteNickFormat must include a separator character such as "/". +#You should make sure that the settings here match your IRCd. +#This option overrides ColorNicks. +#OPTIONAL (default false) +UseRelayMsg=false +#RemoteNickFormat="{NICK}/{PROTOCOL}" + ################################################################### #XMPP section ###################################################################