summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWim <wim@42.be>2016-07-12 01:23:36 +0200
committerWim <wim@42.be>2016-07-12 01:23:36 +0200
commitb49429d722c77babcd24d35033ce9ce1b7a68e50 (patch)
tree8405756871fac023d7c3d5ab2c7216a8f77f134a
parent815c7f8d64a5d354b260efa347fdd99fb9f7d3f6 (diff)
downloadmatterbridge-msglm-b49429d722c77babcd24d35033ce9ce1b7a68e50.tar.gz
matterbridge-msglm-b49429d722c77babcd24d35033ce9ce1b7a68e50.tar.bz2
matterbridge-msglm-b49429d722c77babcd24d35033ce9ce1b7a68e50.zip
Add migration info
-rw-r--r--README.md3
-rw-r--r--migration.md50
2 files changed, 53 insertions, 0 deletions
diff --git a/README.md b/README.md
index bfcc3761..5bb357c0 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,9 @@ Simple bridge between mattermost and IRC.
* Supports multiple mattermost and irc 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)
+
## Requirements:
* [Mattermost] (https://github.com/mattermost/platform/) 3.x (stable, not a dev build)
### Webhooks version
diff --git a/migration.md b/migration.md
new file mode 100644
index 00000000..3dc537c5
--- /dev/null
+++ b/migration.md
@@ -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"
+```