matterbridge/matterbridge.conf.sample

288 lines
8.7 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]
#Enable enables this bridge
#OPTIONAL (default false)
Enable=true
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
2016-08-20 15:52:42 +00:00
#OPTIONAL (default false)
2016-07-21 21:47:44 +00:00
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-09-04 18:41:03 +00:00
#RemoteNickFormat defines how remote users appear on this bridge
2016-07-11 23:02:56 +00:00
#The string "{NICK}" (case sensitive) will be replaced by the actual nick / username.
2016-09-04 18:41:03 +00:00
#The string "{BRIDGE}" (case sensitive) will be replaced by the sending bridge
#OPTIONAL (default {BRIDGE}-{NICK})
RemoteNickFormat="[{BRIDGE}] <{NICK}> "
2016-07-11 23:02:56 +00:00
#Nicks you want to ignore.
2016-09-04 18:41:03 +00:00
#Messages from those users will not be sent to other bridges.
2016-07-11 23:02:56 +00:00
#OPTIONAL
IgnoreNicks="ircspammer1 ircspammer2"
2015-10-23 20:34:37 +00:00
2016-07-13 22:23:50 +00:00
###################################################################
#XMPP section
###################################################################
[XMPP]
#Enable enables this bridge
#OPTIONAL (default false)
Enable=true
2016-07-13 22:23:50 +00:00
#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]
#Enable enables this bridge
#OPTIONAL (default false)
Enable=true
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-08-20 15:52:42 +00:00
#Enable this to make a http connection (instead of https) to your mattermost.
2016-07-11 23:02:56 +00:00
#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-09-04 18:41:03 +00:00
#Whether to prefix messages from other bridges to mattermost with the sender's nick.
2016-07-11 23:02:56 +00:00
#Useful if username overrides for incoming webhooks isn't enabled on the
#mattermost server. If you set PrefixMessagesWithNick to true, each message
2016-09-04 18:41:03 +00:00
#from bridge to Mattermost will by default be prefixed by "bridge-" + nick. You can,
2016-07-11 23:02:56 +00:00
#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-09-04 18:41:03 +00:00
#RemoteNickFormat defines how remote users appear on this bridge
2016-07-11 23:02:56 +00:00
#The string "{NICK}" (case sensitive) will be replaced by the actual nick / username.
2016-09-04 18:41:03 +00:00
#The string "{BRIDGE}" (case sensitive) will be replaced by the sending bridge
#OPTIONAL (default {BRIDGE}-{NICK})
RemoteNickFormat="[{BRIDGE}] <{NICK}> "
2016-07-11 23:02:56 +00:00
#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-09-04 18:41:03 +00:00
#Nicks you want to ignore. Messages from those users will not be bridged.
2016-07-11 23:02:56 +00:00
#OPTIONAL
2016-07-11 22:25:32 +00:00
IgnoreNicks="mmbot spammer2"
2015-12-19 15:55:49 +00:00
2016-09-04 18:41:03 +00:00
###################################################################
#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}> "
2016-09-04 18:41:03 +00:00
2016-09-05 14:42:46 +00:00
###################################################################
#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"
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"]
2016-09-04 18:41:03 +00:00
#Choose the IRC channel to send messages to.
2016-07-11 22:25:32 +00:00
IRC="#off-topic"
2016-09-04 18:41:03 +00:00
#Choose the mattermost channel to messages to.
2016-07-11 22:25:32 +00:00
mattermost="off-topic"
2016-09-04 18:41:03 +00:00
#Choose the xmpp channel to send messages to.
2016-08-20 15:52:42 +00:00
xmpp="off-topic"
2016-09-04 18:41:03 +00:00
#Choose the Gitter channel to send messages to.
#Gitter channels are named "user/repo"
gitter="42wim/matterbridge"
2016-09-05 14:42:46 +00:00
#Choose the slack channel to send messages to.
slack="general"
2015-12-19 15:55:49 +00:00
2016-07-11 22:25:32 +00:00
[Channel "testchannel"]
IRC="#testing"
mattermost="testing"
2016-08-20 15:52:42 +00:00
xmpp="testing"
2016-09-04 18:41:03 +00:00
gitter="user/repo"
2016-09-05 14:42:46 +00:00
slack="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