Thumbnail

rani/matterbridge.git

Clone URL: https://git.buni.party/rani/matterbridge.git

commit 27b2cd7201a988d35d38e58bfb889c7986409cbc Author: Wim <wim@42.be> Date: Sat Aug 20 17:52:42 2016 +0000 Update documentation diff --git a/README.md b/README.md index 5de682a..4a562c4 100644 --- a/README.md +++ b/README.md @@ -106 +108 @@ This project has now [matterbridge-plus](https://github.com/42wim/matterbridge-p  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.   +Configuration changes since v0.5.0 can be found in [changelog.md] (https://github.com/42wim/matterbridge/blob/master/changelog.md) +  ## Requirements:  * [Mattermost] (https://github.com/mattermost/platform/)  ### Compatibility diff --git a/changelog.md b/changelog.md new file mode 100644 index 0000000..9c6b8f2 --- /dev/null +++ b/changelog.md @@ -00 +119 @@ +# v0.6.0 +## Breaking changes from 0.5 to 0.6 +### commandline +* -plus switch deprecated. Use ```Plus=true``` or ```Plus``` in ```[general]``` section +### IRC section +* ```Enabled``` added (default false) +Add ```Enabled=true``` or ```Enabled``` to the ```[IRC]``` section if you want to enable the IRC bridge +### Mattermost section +* ```Enabled``` added (default false) +Add ```Enabled=true``` or ```Enabled``` to the ```[mattermost]``` section if you want to enable the mattermostbridge +### General section +* Use ```Plus=true``` or ```Plus``` in ```[general]``` section to enable the API version of matterbridge + +## New features +* Matterbridge now bridges between any specified protocol (not only mattermost anymore) +* XMPP support added. See matterbridge.conf.sample for more information +* RemoteNickFormat {BRIDGE} variable added +You can now add the originating bridge to ```RemoteNickFormat``` +eg ```RemoteNickFormat="[{BRIDGE}] <{NICK}> "``` diff --git a/matterbridge.conf.sample b/matterbridge.conf.sample index 43d69a5..597b851 100644 --- a/matterbridge.conf.sample +++ b/matterbridge.conf.sample @@ -167 +167 @@ UseTLS=false    #Enable SASL (PLAIN) authentication. (freenode requires this from eg AWS hosts)  #It uses NickServNick and NickServPassword as login and password -#OPTIONAL (deefault false) +#OPTIONAL (default false)  UseSASL=false    #Enable to not verify the certificate on your irc server. i @@ -1197 +1197 @@ Team="yourteam"  Login="yourlogin"  Password="yourpass"   -#Disable to make a http connection to your mattermost. +#Enable this to make a http connection (instead of https) to your mattermost.  #OPTIONAL (default false)  NoTLS=false   @@ -17010 +17013 @@ IgnoreNicks="mmbot spammer2"  IRC="#off-topic"  #Choose the mattermost channel to send IRC messages to.  mattermost="off-topic" +#Choose the mattermost channel to send IRC messages to. +xmpp="off-topic"    [Channel "testchannel"]  IRC="#testing"  mattermost="testing" +xmpp="testing"    ###################################################################  #general