matterbridge/matterbridge.conf.sample

183 lines
5.1 KiB
Plaintext
Raw Normal View History

2016-07-11 22:25:32 +00:00
#This is configuration for matterbridge.
###################################################################
#IRC section
###################################################################
2015-10-23 20:34:37 +00:00
[IRC]
2016-07-11 23:02:56 +00:00
#irc server to connect to.
#REQUIRED
2016-07-11 22:25:32 +00:00
Server="irc.freenode.net:6667"
2016-07-11 23:02:56 +00:00
#Enable to use TLS connection to your irc server.
#OPTIONAL (default false)
2015-10-23 20:34:37 +00:00
UseTLS=false
2016-07-11 22:25:32 +00:00
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
2016-07-11 23:02:56 +00:00
#Enable to not verify the certificate on your irc server. i
2016-07-11 22:25:32 +00:00
#e.g. when using selfsigned certificates
2016-07-11 23:02:56 +00:00
#OPTIONAL (default false)
2015-10-23 20:34:37 +00:00
SkipTLSVerify=true
2016-07-11 22:25:32 +00:00
2016-07-11 23:02:56 +00:00
#Your nick on irc.
#REQUIRED
2016-07-11 22:25:32 +00:00
Nick="matterbot"
2016-07-11 23:02:56 +00:00
#If you registered your bot with a service like Nickserv on freenode.
2016-07-21 21:47:44 +00:00
#Also being used when UseSASL=true
2016-07-11 23:02:56 +00:00
#OPTIONAL
2016-07-11 22:25:32 +00:00
NickServNick="nickserv"
NickServPassword="secret"
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
IgnoreNicks="ircspammer1 ircspammer2"
2015-10-23 20:34:37 +00:00
2016-07-13 22:23:50 +00:00
###################################################################
#XMPP section
###################################################################
[XMPP]
#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"
2016-07-11 22:25:32 +00:00
###################################################################
#mattermost section
###################################################################
2015-10-23 20:34:37 +00:00
[mattermost]
2016-07-11 22:25:32 +00:00
#### Settings for webhook matterbridge.
2016-07-11 23:02:56 +00:00
#### These settings will not be used when using -plus switch which doesn't use
#### webhooks.
2016-07-11 22:25:32 +00:00
2016-07-11 23:02:56 +00:00
#Url is your incoming webhook url as specified in mattermost.
2016-07-11 22:25:32 +00:00
#See account settings - integrations - incoming webhooks on mattermost.
2016-07-11 23:02:56 +00:00
#REQUIRED
2016-07-11 22:25:32 +00:00
URL="https://yourdomain/hooks/yourhookkey"
2016-07-11 23:02:56 +00:00
#Address to listen on for outgoing webhook requests from mattermost.
2016-07-11 22:25:32 +00:00
#See account settings - integrations - outgoing webhooks on mattermost.
2016-07-11 23:02:56 +00:00
#This setting will not be used when using -plus switch which doesn't use
#webhooks
#REQUIRED
2016-07-11 22:25:32 +00:00
BindAddress="0.0.0.0:9999"
2016-07-11 23:02:56 +00:00
#Icon that will be showed in mattermost.
#OPTIONAL
2015-10-24 16:44:45 +00:00
IconURL="http://youricon.png"
2016-07-11 22:25:32 +00:00
#### Settings for matterbridge -plus
#### Thse settings will only be used when using the -plus switch.
2016-07-11 23:02:56 +00:00
#The mattermost hostname.
#REQUIRED
2016-07-11 22:25:32 +00:00
Server="yourmattermostserver.domain"
2016-07-11 23:02:56 +00:00
#Your team on mattermost.
#REQUIRED
2016-07-11 22:25:32 +00:00
Team="yourteam"
2016-07-11 23:02:56 +00:00
#login/pass of your bot.
#Use a dedicated user for this and not your own!
#REQUIRED
2016-07-11 22:25:32 +00:00
Login="yourlogin"
Password="yourpass"
2016-07-11 23:02:56 +00:00
#Disable to make a http connection to your mattermost.
#OPTIONAL (default false)
2016-07-11 22:25:32 +00:00
NoTLS=false
#### Shared settings for matterbridge and -plus
2016-07-11 23:02:56 +00:00
#Enable to not verify the certificate on your mattermost server.
2016-07-11 22:25:32 +00:00
#e.g. when using selfsigned certificates
2016-07-11 23:02:56 +00:00
#OPTIONAL (default false)
2016-07-11 22:25:32 +00:00
SkipTLSVerify=true
2016-07-11 23:02:56 +00:00
#Enable to show IRC joins/parts in mattermost.
#OPTIONAL (default false)
2016-07-11 22:25:32 +00:00
ShowJoinPart=false
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)
PrefixMessagesWithNick=false
2016-07-11 22:25:32 +00:00
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.
2016-07-11 22:25:32 +00:00
#Possible options are "table" and "plain"
2016-07-11 23:02:56 +00:00
#OPTIONAL (default plain)
NickFormatter=plain
2016-07-11 23:02:56 +00:00
#How many nicks to list per row for formatters that support this.
#OPTIONAL (default 4)
NicksPerRow=4
2015-10-27 23:04:57 +00:00
2016-07-11 23:02:56 +00:00
#Nicks you want to ignore. Messages from those users will not be sent to IRC.
#OPTIONAL
2016-07-11 22:25:32 +00:00
IgnoreNicks="mmbot spammer2"
2015-12-19 15:55:49 +00:00
2016-07-11 22:25:32 +00:00
###################################################################
2015-12-19 15:55:49 +00:00
#multiple channel config
2016-07-11 22:25:32 +00:00
###################################################################
2016-07-11 23:02:56 +00:00
#You can specify multiple channels.
2016-07-11 22:25:32 +00:00
#The name is just an identifier for you.
2016-07-11 23:02:56 +00:00
#REQUIRED (at least 1 channel)
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"
2015-12-19 15:55:49 +00:00
2016-07-11 22:25:32 +00:00
[Channel "testchannel"]
IRC="#testing"
mattermost="testing"
2015-12-19 15:55:49 +00:00
2016-07-11 22:25:32 +00:00
###################################################################
#general
###################################################################
[general]
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
2016-07-11 22:25:32 +00:00
GiphyApiKey="dc6zaTOxFJmzC"
2016-07-13 22:23:50 +00:00
#Enabling plus means you'll use the API version instead of the webhooks one
Plus=false
#Choose protocols to bridge. You need to specify at least two
2016-07-13 22:23:50 +00:00
#REQUIRED
Irc=true
Xmpp=false
Mattermost=true