diff options
| author | Wim <wim@42.be> | 2016-08-20 17:52:42 +0200 |
|---|---|---|
| committer | Wim <wim@42.be> | 2016-08-20 18:08:59 +0200 |
| commit | eb20cb237dc2194b5e3f5e6cd79ba9e9fc46a8f8 (patch) | |
| tree | 8c48e59f795ce6887281ee3e7f1ad27e29480f9a | |
| parent | 106404d32f3df781d52000924501492700ab6075 (diff) | |
| download | matterbridge-msglm-eb20cb237dc2194b5e3f5e6cd79ba9e9fc46a8f8.tar.gz matterbridge-msglm-eb20cb237dc2194b5e3f5e6cd79ba9e9fc46a8f8.tar.bz2 matterbridge-msglm-eb20cb237dc2194b5e3f5e6cd79ba9e9fc46a8f8.zip | |
Update documentation
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | changelog.md | 19 | ||||
| -rw-r--r-- | matterbridge.conf.sample | 7 |
3 files changed, 26 insertions, 2 deletions
@@ -10,6 +10,8 @@ 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 00000000..9c6b8f2d --- /dev/null +++ b/changelog.md @@ -0,0 +1,19 @@ +# 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 43d69a57..597b851c 100644 --- a/matterbridge.conf.sample +++ b/matterbridge.conf.sample @@ -16,7 +16,7 @@ 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 @@ -119,7 +119,7 @@ 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 @@ -170,10 +170,13 @@ 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 |