matterbridge/matterbridge.conf.sample

#This is configuration for matterbridge.
###################################################################
#IRC section
###################################################################
[IRC]
#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 (deefault 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 Mattermost users appear on irc
#The string "{NICK}" (case sensitive) will be replaced by the actual nick / username.
#OPTIONAL (default NICK:)
RemoteNickFormat="{NICK}: "

#Nicks you want to ignore. 
#Messages from those users will not be sent to mattermost.
#OPTIONAL
IgnoreNicks="ircspammer1 ircspammer2"

###################################################################
#mattermost section
###################################################################

[mattermost]
#### 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"

#Disable to make a http connection 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 IRC 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 IRC to Mattermost will by default be prefixed by "irc-" + nick. You can, 
#however, modify how the messages appear, by setting (and modifying) RemoteNickFormat 
#OPTIONAL (default false)
PrefixMessagesWithNick=false

#RemoteNickFormat defines how IRC users appear on Mattermost. 
#The string "{NICK}" (case sensitive) will be replaced by the actual nick / username.
#OPTIONAL (default irc-NICK)
RemoteNickFormat="irc-{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 sent to IRC. 
#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 mattermost messages to.
IRC="#off-topic"
#Choose the mattermost channel to send IRC messages to.
mattermost="off-topic"

[Channel "testchannel"]
IRC="#testing"
mattermost="testing"

###################################################################
#general
###################################################################
[general]
#request your API key on https://github.com/giphy/GiphyAPI. This is a public beta key. 
#OPTIONAL
GiphyApiKey="dc6zaTOxFJmzC"
Update documentation 2016-07-11 22:25:32 +00:00			`#This is configuration for matterbridge.`
			`###################################################################`
			`#IRC section`
			`###################################################################`
Initial matterbridge commit 2015-10-23 20:34:37 +00:00			`[IRC]`
Update documentation 2016-07-11 23:02:56 +00:00			`#irc server to connect to.`
			`#REQUIRED`
Update documentation 2016-07-11 22:25:32 +00:00			`Server="irc.freenode.net:6667"`

Update documentation 2016-07-11 23:02:56 +00:00			`#Enable to use TLS connection to your irc server.`
			`#OPTIONAL (default false)`
Initial matterbridge commit 2015-10-23 20:34:37 +00:00			`UseTLS=false`
Update documentation 2016-07-11 22:25:32 +00:00
Add (PLAIN) SASL support 2016-07-21 21:47:44 +00:00			`#Enable SASL (PLAIN) authentication. (freenode requires this from eg AWS hosts)`
			`#It uses NickServNick and NickServPassword as login and password`
			`#OPTIONAL (deefault false)`
			`UseSASL=false`

Update documentation 2016-07-11 23:02:56 +00:00			`#Enable to not verify the certificate on your irc server. i`
Update documentation 2016-07-11 22:25:32 +00:00			`#e.g. when using selfsigned certificates`
Update documentation 2016-07-11 23:02:56 +00:00			`#OPTIONAL (default false)`
Initial matterbridge commit 2015-10-23 20:34:37 +00:00			`SkipTLSVerify=true`
Update documentation 2016-07-11 22:25:32 +00:00
Update documentation 2016-07-11 23:02:56 +00:00			`#Your nick on irc.`
			`#REQUIRED`
Update documentation 2016-07-11 22:25:32 +00:00			`Nick="matterbot"`

Update documentation 2016-07-11 23:02:56 +00:00			`#If you registered your bot with a service like Nickserv on freenode.`
Add (PLAIN) SASL support 2016-07-21 21:47:44 +00:00			`#Also being used when UseSASL=true`
Update documentation 2016-07-11 23:02:56 +00:00			`#OPTIONAL`
Update documentation 2016-07-11 22:25:32 +00:00			`NickServNick="nickserv"`
			`NickServPassword="secret"`

Update documentation 2016-07-11 23:02:56 +00:00			`#RemoteNickFormat defines how Mattermost users appear on irc`
			`#The string "{NICK}" (case sensitive) will be replaced by the actual nick / username.`
			`#OPTIONAL (default NICK:)`
			`RemoteNickFormat="{NICK}: "`

			`#Nicks you want to ignore.`
			`#Messages from those users will not be sent to mattermost.`
			`#OPTIONAL`
Add support for ignoring messages from specific users. 2016-05-21 14:03:19 +00:00			`IgnoreNicks="ircspammer1 ircspammer2"`
Initial matterbridge commit 2015-10-23 20:34:37 +00:00
Update documentation 2016-07-11 22:25:32 +00:00			`###################################################################`
			`#mattermost section`
			`###################################################################`

Initial matterbridge commit 2015-10-23 20:34:37 +00:00			`[mattermost]`
Update documentation 2016-07-11 22:25:32 +00:00			`#### Settings for webhook matterbridge.`
Update documentation 2016-07-11 23:02:56 +00:00			`#### These settings will not be used when using -plus switch which doesn't use`
			`#### webhooks.`
Update documentation 2016-07-11 22:25:32 +00:00
Update documentation 2016-07-11 23:02:56 +00:00			`#Url is your incoming webhook url as specified in mattermost.`
Update documentation 2016-07-11 22:25:32 +00:00			`#See account settings - integrations - incoming webhooks on mattermost.`
Update documentation 2016-07-11 23:02:56 +00:00			`#REQUIRED`
Update documentation 2016-07-11 22:25:32 +00:00			`URL="https://yourdomain/hooks/yourhookkey"`

Update documentation 2016-07-11 23:02:56 +00:00			`#Address to listen on for outgoing webhook requests from mattermost.`
Update documentation 2016-07-11 22:25:32 +00:00			`#See account settings - integrations - outgoing webhooks on mattermost.`
Update documentation 2016-07-11 23:02:56 +00:00			`#This setting will not be used when using -plus switch which doesn't use`
			`#webhooks`
			`#REQUIRED`
Update documentation 2016-07-11 22:25:32 +00:00			`BindAddress="0.0.0.0:9999"`

Update documentation 2016-07-11 23:02:56 +00:00			`#Icon that will be showed in mattermost.`
			`#OPTIONAL`
Refactor and IconURL support 2015-10-24 16:44:45 +00:00			`IconURL="http://youricon.png"`
Update documentation 2016-07-11 22:25:32 +00:00
			`#### Settings for matterbridge -plus`
			`#### Thse settings will only be used when using the -plus switch.`

Update documentation 2016-07-11 23:02:56 +00:00			`#The mattermost hostname.`
			`#REQUIRED`
Update documentation 2016-07-11 22:25:32 +00:00			`Server="yourmattermostserver.domain"`

Update documentation 2016-07-11 23:02:56 +00:00			`#Your team on mattermost.`
			`#REQUIRED`
Update documentation 2016-07-11 22:25:32 +00:00			`Team="yourteam"`

Update documentation 2016-07-11 23:02:56 +00:00			`#login/pass of your bot.`
			`#Use a dedicated user for this and not your own!`
			`#REQUIRED`
Update documentation 2016-07-11 22:25:32 +00:00			`Login="yourlogin"`
			`Password="yourpass"`

Update documentation 2016-07-11 23:02:56 +00:00			`#Disable to make a http connection to your mattermost.`
			`#OPTIONAL (default false)`
Update documentation 2016-07-11 22:25:32 +00:00			`NoTLS=false`

			`#### Shared settings for matterbridge and -plus`

Update documentation 2016-07-11 23:02:56 +00:00			`#Enable to not verify the certificate on your mattermost server.`
Update documentation 2016-07-11 22:25:32 +00:00			`#e.g. when using selfsigned certificates`
Update documentation 2016-07-11 23:02:56 +00:00			`#OPTIONAL (default false)`
Update documentation 2016-07-11 22:25:32 +00:00			`SkipTLSVerify=true`

Update documentation 2016-07-11 23:02:56 +00:00			`#Enable to show IRC joins/parts in mattermost.`
			`#OPTIONAL (default false)`
Update documentation 2016-07-11 22:25:32 +00:00			`ShowJoinPart=false`

Update documentation 2016-07-11 23:02:56 +00:00			`#Whether to prefix messages from IRC 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 IRC to Mattermost will by default be prefixed by "irc-" + nick. You can,`
			`#however, modify how the messages appear, by setting (and modifying) RemoteNickFormat`
			`#OPTIONAL (default false)`
Move new config parameters from IRC to Mattermost. PrefixMessagesWithNick, NickFormatter and NicksPerRow. 2016-03-18 19:54:14 +00:00			`PrefixMessagesWithNick=false`
Update documentation 2016-07-11 22:25:32 +00:00
Update documentation 2016-07-11 23:02:56 +00:00			`#RemoteNickFormat defines how IRC users appear on Mattermost.`
			`#The string "{NICK}" (case sensitive) will be replaced by the actual nick / username.`
			`#OPTIONAL (default irc-NICK)`
			`RemoteNickFormat="irc-{NICK}"`

			`#how to format the list of IRC nicks when displayed in mattermost.`
Update documentation 2016-07-11 22:25:32 +00:00			`#Possible options are "table" and "plain"`
Update documentation 2016-07-11 23:02:56 +00:00			`#OPTIONAL (default plain)`
Move new config parameters from IRC to Mattermost. PrefixMessagesWithNick, NickFormatter and NicksPerRow. 2016-03-18 19:54:14 +00:00			`NickFormatter=plain`
Update documentation 2016-07-11 23:02:56 +00:00			`#How many nicks to list per row for formatters that support this.`
			`#OPTIONAL (default 4)`
Move new config parameters from IRC to Mattermost. PrefixMessagesWithNick, NickFormatter and NicksPerRow. 2016-03-18 19:54:14 +00:00			`NicksPerRow=4`
Add giphy support. !gif <query> 2015-10-27 23:04:57 +00:00
Update documentation 2016-07-11 23:02:56 +00:00			`#Nicks you want to ignore. Messages from those users will not be sent to IRC.`
			`#OPTIONAL`
Update documentation 2016-07-11 22:25:32 +00:00			`IgnoreNicks="mmbot spammer2"`
Add support for multiple channels 2015-12-19 15:55:49 +00:00
Update documentation 2016-07-11 22:25:32 +00:00			`###################################################################`
Add support for multiple channels 2015-12-19 15:55:49 +00:00			`#multiple channel config`
Update documentation 2016-07-11 22:25:32 +00:00			`###################################################################`
Update documentation 2016-07-11 23:02:56 +00:00			`#You can specify multiple channels.`
Update documentation 2016-07-11 22:25:32 +00:00			`#The name is just an identifier for you.`
Update documentation 2016-07-11 23:02:56 +00:00			`#REQUIRED (at least 1 channel)`
Update documentation 2016-07-11 22:25:32 +00:00			`[Channel "channel1"]`
			`#Choose the IRC channel to send mattermost messages to.`
			`IRC="#off-topic"`
			`#Choose the mattermost channel to send IRC messages to.`
			`mattermost="off-topic"`
Add support for multiple channels 2015-12-19 15:55:49 +00:00
Update documentation 2016-07-11 22:25:32 +00:00			`[Channel "testchannel"]`
			`IRC="#testing"`
			`mattermost="testing"`
Add support for multiple channels 2015-12-19 15:55:49 +00:00
Update documentation 2016-07-11 22:25:32 +00:00			`###################################################################`
			`#general`
			`###################################################################`
			`[general]`
Update documentation 2016-07-11 23:02:56 +00:00			`#request your API key on https://github.com/giphy/GiphyAPI. This is a public beta key.`
			`#OPTIONAL`
Update documentation 2016-07-11 22:25:32 +00:00			`GiphyApiKey="dc6zaTOxFJmzC"`