Add migration info

This commit is contained in:
Wim 2016-07-12 01:23:36 +02:00
parent 815c7f8d64
commit b49429d722
2 changed files with 53 additions and 0 deletions

View File

@ -6,6 +6,9 @@ Simple bridge between mattermost and IRC.
* Supports multiple mattermost and irc channels. * Supports multiple mattermost and irc channels.
* Matterbridge -plus also works with private groups on your mattermost. * 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)
## Requirements: ## Requirements:
* [Mattermost] (https://github.com/mattermost/platform/) 3.x (stable, not a dev build) * [Mattermost] (https://github.com/mattermost/platform/) 3.x (stable, not a dev build)
### Webhooks version ### Webhooks version

50
migration.md Normal file
View File

@ -0,0 +1,50 @@
# 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"
```