#This is configuration for matterbridge. ################################################################### #IRC section ################################################################### [IRC] #Enable enables this bridge #OPTIONAL (default false) Enable=true #irc server to connect to. #REQUIRED Server="irc.freenode.net:6667" #Enable to use TLS connection to your irc server. #OPTIONAL (default false) UseTLS=false #Enable SASL (PLAIN) authentication. (freenode requires this from eg AWS hosts) #It uses NickServNick and NickServPassword as login and password #OPTIONAL (default false) UseSASL=false #Enable to not verify the certificate on your irc server. i #e.g. when using selfsigned certificates #OPTIONAL (default false) SkipTLSVerify=true #Your nick on irc. #REQUIRED Nick="matterbot" #If you registered your bot with a service like Nickserv on freenode. #Also being used when UseSASL=true #OPTIONAL NickServNick="nickserv" NickServPassword="secret" #RemoteNickFormat defines how remote users appear on this bridge #The string "{NICK}" (case sensitive) will be replaced by the actual nick / username. #The string "{BRIDGE}" (case sensitive) will be replaced by the sending bridge #OPTIONAL (default {BRIDGE}-{NICK}) RemoteNickFormat="[{BRIDGE}] <{NICK}> " #Nicks you want to ignore. #Messages from those users will not be sent to other bridges. #OPTIONAL IgnoreNicks="ircspammer1 ircspammer2" ################################################################### #XMPP section ################################################################### [XMPP] #Enable enables this bridge #OPTIONAL (default false) Enable=true #xmpp server to connect to. #REQUIRED Server="jabber.example.com:5222" #Jid #REQUIRED Jid="user@example.com" #Password #REQUIRED Password="yourpass" #MUC #REQUIRED Muc="conference.jabber.example.com" #Your nick in the rooms #REQUIRED Nick="xmppbot" ################################################################### #mattermost section ################################################################### [mattermost] #Enable enables this bridge #OPTIONAL (default false) Enable=true #### Settings for webhook matterbridge. #### These settings will not be used when using -plus switch which doesn't use #### webhooks. #Url is your incoming webhook url as specified in mattermost. #See account settings - integrations - incoming webhooks on mattermost. #REQUIRED URL="https://yourdomain/hooks/yourhookkey" #Address to listen on for outgoing webhook requests from mattermost. #See account settings - integrations - outgoing webhooks on mattermost. #This setting will not be used when using -plus switch which doesn't use #webhooks #REQUIRED BindAddress="0.0.0.0:9999" #Icon that will be showed in mattermost. #OPTIONAL IconURL="http://youricon.png" #### Settings for matterbridge -plus #### Thse settings will only be used when using the -plus switch. #The mattermost hostname. #REQUIRED Server="yourmattermostserver.domain" #Your team on mattermost. #REQUIRED Team="yourteam" #login/pass of your bot. #Use a dedicated user for this and not your own! #REQUIRED Login="yourlogin" Password="yourpass" #Enable this to make a http connection (instead of https) to your mattermost. #OPTIONAL (default false) NoTLS=false #### Shared settings for matterbridge and -plus #Enable to not verify the certificate on your mattermost server. #e.g. when using selfsigned certificates #OPTIONAL (default false) SkipTLSVerify=true #Enable to show IRC joins/parts in mattermost. #OPTIONAL (default false) ShowJoinPart=false #Whether to prefix messages from other bridges to mattermost with the sender's nick. #Useful if username overrides for incoming webhooks isn't enabled on the #mattermost server. If you set PrefixMessagesWithNick to true, each message #from bridge to Mattermost will by default be prefixed by "bridge-" + nick. You can, #however, modify how the messages appear, by setting (and modifying) RemoteNickFormat #OPTIONAL (default false) PrefixMessagesWithNick=false #RemoteNickFormat defines how remote users appear on this bridge #The string "{NICK}" (case sensitive) will be replaced by the actual nick / username. #The string "{BRIDGE}" (case sensitive) will be replaced by the sending bridge #OPTIONAL (default {BRIDGE}-{NICK}) RemoteNickFormat="[{BRIDGE}] <{NICK}> " #how to format the list of IRC nicks when displayed in mattermost. #Possible options are "table" and "plain" #OPTIONAL (default plain) NickFormatter=plain #How many nicks to list per row for formatters that support this. #OPTIONAL (default 4) NicksPerRow=4 #Nicks you want to ignore. Messages from those users will not be bridged. #OPTIONAL IgnoreNicks="mmbot spammer2" ################################################################### #Gitter section #Best to make a dedicated gitter account for the bot. ################################################################### [Gitter] #Enable enables this bridge #OPTIONAL (default false) Enable=true #Token to connect with Gitter API #You can get your token by going to https://developer.gitter.im/docs/welcome and SIGN IN #REQUIRED Token="Yourtokenhere" #Nicks you want to ignore. Messages of those users will not be bridged. #OPTIONAL IgnoreNicks="spammer1 spammer2" #RemoteNickFormat defines how remote users appear on this bridge #The string "{NICK}" (case sensitive) will be replaced by the actual nick / username. #The string "{BRIDGE}" (case sensitive) will be replaced by the sending bridge #OPTIONAL (default {BRIDGE}-{NICK}) RemoteNickFormat="[{BRIDGE}] <{NICK}> " ################################################################### #slack section ################################################################### [slack] #Enable enables this bridge #OPTIONAL (default false) Enable=true #### Settings for webhook matterbridge. #### These settings will not be used when useAPI is enabled #Url is your incoming webhook url as specified in slack #See account settings - integrations - incoming webhooks on slack #REQUIRED (unless useAPI=true) URL="https://hooks.slack.com/services/yourhook" #Address to listen on for outgoing webhook requests from slack #See account settings - integrations - outgoing webhooks on slack #This setting will not be used when useAPI is eanbled #webhooks #REQUIRED (unless useAPI=true) BindAddress="0.0.0.0:9999" #Icon that will be showed in slack #OPTIONAL IconURL="http://youricon.png" #### Settings for using slack API #OPTIONAL useAPI=false #Token to connect with the Slack API #REQUIRED (when useAPI=true) Token="yourslacktoken" #### Shared settings for webhooks and API #Whether to prefix messages from other bridges to mattermost with the sender's nick. #Useful if username overrides for incoming webhooks isn't enabled on the #slack server. If you set PrefixMessagesWithNick to true, each message #from bridge to Slack will by default be prefixed by "bridge-" + nick. You can, #however, modify how the messages appear, by setting (and modifying) RemoteNickFormat #OPTIONAL (default false) PrefixMessagesWithNick=false #RemoteNickFormat defines how remote users appear on this bridge #The string "{NICK}" (case sensitive) will be replaced by the actual nick / username. #The string "{BRIDGE}" (case sensitive) will be replaced by the sending bridge #OPTIONAL (default {BRIDGE}-{NICK}) RemoteNickFormat="[{BRIDGE}] <{NICK}> #how to format the list of IRC nicks when displayed in slack #Possible options are "table" and "plain" #OPTIONAL (default plain) NickFormatter=plain #How many nicks to list per row for formatters that support this. #OPTIONAL (default 4) NicksPerRow=4 #Nicks you want to ignore. Messages from those users will not be bridged. #OPTIONAL IgnoreNicks="mmbot spammer2" ################################################################### #multiple channel config ################################################################### #You can specify multiple channels. #The name is just an identifier for you. #REQUIRED (at least 1 channel) [Channel "channel1"] #Choose the IRC channel to send messages to. IRC="#off-topic" #Choose the mattermost channel to messages to. mattermost="off-topic" #Choose the xmpp channel to send messages to. xmpp="off-topic" #Choose the Gitter channel to send messages to. #Gitter channels are named "user/repo" gitter="42wim/matterbridge" #Choose the slack channel to send messages to. slack="general" [Channel "testchannel"] IRC="#testing" mattermost="testing" xmpp="testing" gitter="user/repo" slack="testing" ################################################################### #general ################################################################### [general] #request your API key on https://github.com/giphy/GiphyAPI. This is a public beta key. #OPTIONAL GiphyApiKey="dc6zaTOxFJmzC" #Enabling plus means you'll use the API version instead of the webhooks one Plus=false