Add matrix support

1 files changed, 45 insertions, 0 deletions

diff --git a/matterbridge.toml.sample b/matterbridge.toml.sample
index 0fa95d0b..f0901ce9 100644
--- a/matterbridge.toml.sample
+++ b/matterbridge.toml.sample
@@ -487,6 +487,50 @@ RemoteNickFormat="[{PROTOCOL}] <{NICK}> "
 ShowJoinPart=false
 
 ###################################################################
+#matrix section
+###################################################################
+[matrix]
+#You can configure multiple servers "[matrix.name]" or "[matrix.name2]"
+#In this example we use [matrix.neo]
+#REQUIRED
+
+[matrix.neo]
+#Url is your homeserver (eg matrix.org)
+#REQUIRED
+URL="https://matrix.org"
+
+#login/pass of your bot. 
+#Use a dedicated user for this and not your own! 
+#Messages sent from this user will not be relayed to avoid loops.
+#REQUIRED 
+Login="yourlogin"
+Password="yourpass"
+
+#Whether to prefix messages from other bridges to matrix with the sender's nick. 
+#Useful if username overrides for incoming webhooks isn't enabled on the 
+#matrix server. If you set PrefixMessagesWithNick to true, each message 
+#from bridge to matrix will by default be prefixed by the RemoteNickFormat setting. i
+#OPTIONAL (default false)
+PrefixMessagesWithNick=false
+
+#Nicks you want to ignore. 
+#Messages from those users will not be sent to other bridges.
+#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
+#The string "{PROTOCOL}" (case sensitive) will be replaced by the protocol used by the bridge
+#OPTIONAL (default empty)
+RemoteNickFormat="[{PROTOCOL}] <{NICK}> "
+
+#Enable to show users joins/parts from other bridges (only from irc-bridge at the moment)
+#OPTIONAL (default false)
+ShowJoinPart=false
+
+
+###################################################################
 #API
 ###################################################################
 [api]
@@ -564,6 +608,7 @@ enable=true
     #             see (https://www.linkedin.com/pulse/telegram-bots-beginners-marco-frau)
     #hipchat    - id_channel (see https://www.hipchat.com/account/xmpp for the correct channel)
     #rocketchat - #channel (# is required)
+    #matrix     - room internal ID (looks like !QJFqjsGJwmQzbuBfff:matrix.org)
     #REQUIRED
     channel="#testing"