commit fb5ce53875d3bba8c36a298804031f60fb5239b2
Author: Wim <wim@42.be>
Date: Sun Sep 04 20:41:03 2016 +0000
Update documentation
diff --git a/README.md b/README.md
index 03c93a0..37a52b9 100644
--- a/README.md
+++ b/README.md
@@ -135 +140 @@
# matterbridge
-Simple bridge between mattermost and IRC.
+Simple bridge between mattermost, IRC, XMPP and Gitter
-* Relays public channel messages between mattermost and IRC.
-* Supports multiple mattermost and irc channels.
+* Relays public channel messages between mattermost, IRC, XMPP and Gitter. Pick and mix.
+* Supports multiple channels.
* Matterbridge -plus also works with private groups on your mattermost.
-This project has now [matterbridge-plus](https://github.com/42wim/matterbridge-plus/) merged in.
-Breaking changes for matterbridge can be found in [migration](https://github.com/42wim/matterbridge/blob/master/migration.md)
-Look at [matterbridge.conf.sample] (https://github.com/42wim/matterbridge/blob/master/matterbridge.conf.sample) for an example.
+Look at [matterbridge.conf.sample] (https://github.com/42wim/matterbridge/blob/master/matterbridge.conf.sample) for documentation and an example.
-Configuration changes since v0.5.0 can be found in [changelog.md] (https://github.com/42wim/matterbridge/blob/master/changelog.md)
+## Changelog
+Since v0.6.0-beta support for XMPP and Gitter is added. More details in [changelog.md] (https://github.com/42wim/matterbridge/blob/master/changelog.md)
## Requirements:
+Accounts to one of the supported bridges
* [Mattermost] (https://github.com/mattermost/platform/)
+* [IRC] (http://www.mirc.com/servers.html)
+* [XMPP] (https://jabber.org)
+* [Gitter] (https://gitter.im)
+
+## binaries
+Binaries can be found [here] (https://github.com/42wim/matterbridge/releases/)
+* For use with mattermost 3.3.0 [v0.6.0-beta1](https://github.com/42wim/matterircd/releases/tag/v0.6.0-beta1)
+* For use with mattermost 3.0.0-3.2.0 [v0.5.0](https://github.com/42wim/matterircd/releases/tag/v0.5.0)
-### Compatibility
+## Compatibility
+### Mattermost
* Matterbridge v0.6.0 works with mattermost 3.3.0 and higher [3.3.0 release](https://github.com/mattermost/platform/releases/tag/v3.3.0)
* Matterbridge v0.5.0 works with mattermost 3.0.0 - 3.2.0 [3.2.0 release](https://github.com/mattermost/platform/releases/tag/v3.2.0)
-### Webhooks version
+#### Webhooks version
* Configured incoming/outgoing [webhooks](https://www.mattermost.org/webhooks/) on your mattermost instance.
-### Plus (API) version
+#### Plus (API) version
* A dedicated user(bot) on your mattermost instance.
-## binaries
-Binaries can be found [here] (https://github.com/42wim/matterbridge/releases/)
-* For use with mattermost 3.3.0 [v0.6.0-beta1](https://github.com/42wim/matterircd/releases/tag/v0.6.0-beta1)
-* For use with mattermost 3.0.0-3.2.0 [v0.5.0](https://github.com/42wim/matterircd/releases/tag/v0.5.0)
## building
Go 1.6+ is required. Make sure you have [Go](https://golang.org/doc/install) properly installed, including setting up your [GOPATH] (https://golang.org/doc/code.html#GOPATH)
diff --git a/changelog.md b/changelog.md
index 09a7309..8e0894c 100644
--- a/changelog.md
+++ b/changelog.md
@@ -13 +17 @@
+# v0.6.0-beta2
+## New features
+* Gitter support added. See matterbridge.conf.sample for more information
+
# v0.6.0-beta1
## Breaking changes from 0.5 to 0.6
### commandline
@@ -203 +2456 @@ Add ```Enabled=true``` or ```Enabled``` to the ```[mattermost]``` section if you
* RemoteNickFormat {BRIDGE} variable added
You can now add the originating bridge to ```RemoteNickFormat```
eg ```RemoteNickFormat="[{BRIDGE}] <{NICK}> "```
+
+
+# v0.5.0
+## Breaking changes from 0.4 to 0.5 for matterbridge (webhooks version)
+### IRC section
+#### Server
+Port removed, added to server
+```
+server="irc.freenode.net"
+port=6667
+```
+changed to
+```
+server="irc.freenode.net:6667"
+```
+#### Channel
+Removed see Channels section below
+
+#### UseSlackCircumfix=true
+Removed, can be done by using ```RemoteNickFormat="<{NICK}> "```
+
+### Mattermost section
+#### BindAddress
+Port removed, added to BindAddress
+
+```
+BindAddress="0.0.0.0"
+port=9999
+```
+
+changed to
+
+```
+BindAddress="0.0.0.0:9999"
+```
+
+#### Token
+Removed
+
+### Channels section
+```
+[Token "outgoingwebhooktoken1"]
+IRCChannel="#off-topic"
+MMChannel="off-topic"
+```
+
+changed to
+
+```
+[Channel "channelnameofchoice"]
+IRC="#off-topic"
+Mattermost="off-topic"
+```
diff --git a/matterbridge.conf.sample b/matterbridge.conf.sample
index 597b851..98315a4 100644
--- a/matterbridge.conf.sample
+++ b/matterbridge.conf.sample
@@ -3413 +3414 @@ Nick="matterbot"
NickServNick="nickserv"
NickServPassword="secret"
-#RemoteNickFormat defines how Mattermost users appear on irc
+#RemoteNickFormat defines how remote users appear on this bridge
#The string "{NICK}" (case sensitive) will be replaced by the actual nick / username.
-#OPTIONAL (default NICK:)
-RemoteNickFormat="{NICK}: "
+#The string "{BRIDGE}" (case sensitive) will be replaced by the sending bridge
+#OPTIONAL (default {BRIDGE}-{NICK})
+RemoteNickFormat="[{BRIDGE}] <{NICK}>
#Nicks you want to ignore.
-#Messages from those users will not be sent to mattermost.
+#Messages from those users will not be sent to other bridges.
#OPTIONAL
IgnoreNicks="ircspammer1 ircspammer2"
@@ -13418 +13519 @@ SkipTLSVerify=true
#OPTIONAL (default false)
ShowJoinPart=false
-#Whether to prefix messages from IRC to mattermost with the sender's nick.
+#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
#mattermost server. If you set PrefixMessagesWithNick to true, each message
-#from IRC to Mattermost will by default be prefixed by "irc-" + nick. You can,
+#from bridge to Mattermost 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 IRC users appear on Mattermost.
+#RemoteNickFormat defines how remote users appear on this bridge
#The string "{NICK}" (case sensitive) will be replaced by the actual nick / username.
-#OPTIONAL (default irc-NICK)
-RemoteNickFormat="irc-{NICK}"
+#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 mattermost.
#Possible options are "table" and "plain"
@@ -15510 +15734 @@ NickFormatter=plain
#OPTIONAL (default 4)
NicksPerRow=4
-#Nicks you want to ignore. Messages from those users will not be sent to IRC.
+#Nicks you want to ignore. Messages from those users will not be bridged.
#OPTIONAL
IgnoreNicks="mmbot spammer2"
+###################################################################
+#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}>
+
###################################################################
#multiple channel config
###################################################################
@@ -16617 +19221 @@ IgnoreNicks="mmbot spammer2"
#The name is just an identifier for you.
#REQUIRED (at least 1 channel)
[Channel "channel1"]
-#Choose the IRC channel to send mattermost messages to.
+#Choose the IRC channel to send messages to.
IRC="#off-topic"
-#Choose the mattermost channel to send IRC messages to.
+#Choose the mattermost channel to messages to.
mattermost="off-topic"
-#Choose the mattermost channel to send IRC messages to.
+#Choose the xmpp channel to send messages to.
xmpp="off-topic"
+#Choose the Gitter channel to send messages to.
+#Gitter channels are named "user/repo"
+gitter="42wim/matterbridge"
[Channel "testchannel"]
IRC="#testing"
mattermost="testing"
xmpp="testing"
+gitter="user/repo"
###################################################################
#general
