mirror of
https://github.com/cwinfo/matterbridge.git
synced 2024-11-09 23:40:27 +00:00
Update documentation
This commit is contained in:
parent
106404d32f
commit
eb20cb237d
@ -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)
|
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 an example.
|
||||||
|
|
||||||
|
Configuration changes since v0.5.0 can be found in [changelog.md] (https://github.com/42wim/matterbridge/blob/master/changelog.md)
|
||||||
|
|
||||||
## Requirements:
|
## Requirements:
|
||||||
* [Mattermost] (https://github.com/mattermost/platform/)
|
* [Mattermost] (https://github.com/mattermost/platform/)
|
||||||
### Compatibility
|
### Compatibility
|
||||||
|
19
changelog.md
Normal file
19
changelog.md
Normal file
@ -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}> "```
|
@ -16,7 +16,7 @@ UseTLS=false
|
|||||||
|
|
||||||
#Enable SASL (PLAIN) authentication. (freenode requires this from eg AWS hosts)
|
#Enable SASL (PLAIN) authentication. (freenode requires this from eg AWS hosts)
|
||||||
#It uses NickServNick and NickServPassword as login and password
|
#It uses NickServNick and NickServPassword as login and password
|
||||||
#OPTIONAL (deefault false)
|
#OPTIONAL (default false)
|
||||||
UseSASL=false
|
UseSASL=false
|
||||||
|
|
||||||
#Enable to not verify the certificate on your irc server. i
|
#Enable to not verify the certificate on your irc server. i
|
||||||
@ -119,7 +119,7 @@ Team="yourteam"
|
|||||||
Login="yourlogin"
|
Login="yourlogin"
|
||||||
Password="yourpass"
|
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)
|
#OPTIONAL (default false)
|
||||||
NoTLS=false
|
NoTLS=false
|
||||||
|
|
||||||
@ -170,10 +170,13 @@ IgnoreNicks="mmbot spammer2"
|
|||||||
IRC="#off-topic"
|
IRC="#off-topic"
|
||||||
#Choose the mattermost channel to send IRC messages to.
|
#Choose the mattermost channel to send IRC messages to.
|
||||||
mattermost="off-topic"
|
mattermost="off-topic"
|
||||||
|
#Choose the mattermost channel to send IRC messages to.
|
||||||
|
xmpp="off-topic"
|
||||||
|
|
||||||
[Channel "testchannel"]
|
[Channel "testchannel"]
|
||||||
IRC="#testing"
|
IRC="#testing"
|
||||||
mattermost="testing"
|
mattermost="testing"
|
||||||
|
xmpp="testing"
|
||||||
|
|
||||||
###################################################################
|
###################################################################
|
||||||
#general
|
#general
|
||||||
|
Loading…
Reference in New Issue
Block a user