Update documentation

1 files changed, 67 insertions, 0 deletions

diff --git a/matterbridge.conf.sample b/matterbridge.conf.sample
index 98315a4b..b20720e0 100644
--- a/matterbridge.conf.sample
+++ b/matterbridge.conf.sample
@@ -186,6 +186,70 @@ IgnoreNicks="spammer1 spammer2"
 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. 
@@ -201,12 +265,15 @@ 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