diff options
Diffstat (limited to 'README-0.6.md')
| -rw-r--r-- | README-0.6.md | 115 |
1 files changed, 0 insertions, 115 deletions
diff --git a/README-0.6.md b/README-0.6.md deleted file mode 100644 index f25f4574..00000000 --- a/README-0.6.md +++ /dev/null @@ -1,115 +0,0 @@ -# matterbridge - -Simple bridge between mattermost, IRC, XMPP, Gitter and Slack - -* Relays public channel messages between mattermost, IRC, XMPP, Gitter and Slack. Pick and mix. -* Supports multiple channels. -* Matterbridge can also work with private groups on your mattermost. - -Look at [matterbridge.conf.sample] (https://github.com/42wim/matterbridge/blob/master/matterbridge.conf.sample) for documentation and an example. - -## Changelog -Since v0.6.1 support for XMPP, Gitter and Slack is added. More details in [changelog.md] (https://github.com/42wim/matterbridge/blob/master/changelog.md) - -## Requirements: -Accounts to one of the supported bridges -* [Mattermost] (https://github.com/mattermost/platform/) -* [IRC] (http://www.mirc.com/servers.html) -* [XMPP] (https://jabber.org) -* [Gitter] (https://gitter.im) -* [Slack] (https://www.slack.com) - -## binaries -Binaries can be found [here] (https://github.com/42wim/matterbridge/releases/) -* For use with mattermost 3.3.0+ [v0.6.1](https://github.com/42wim/matterircd/releases/tag/v0.6.1) -* For use with mattermost 3.0.0-3.2.0 [v0.5.0](https://github.com/42wim/matterircd/releases/tag/v0.5.0) - - -## Docker -Create your matterbridge.conf file locally eg in ```/tmp/matterbridge.conf``` - -``` -docker run -ti -v /tmp/matterbridge.conf:/matterbridge.conf 42wim/matterbridge:0.6.1 -``` - -## Compatibility -### Mattermost -* Matterbridge v0.6.1 works with mattermost 3.3.0 and higher [3.3.0 release](https://github.com/mattermost/platform/releases/tag/v3.3.0) -* Matterbridge v0.5.0 works with mattermost 3.0.0 - 3.2.0 [3.2.0 release](https://github.com/mattermost/platform/releases/tag/v3.2.0) - - -#### Webhooks version -* Configured incoming/outgoing [webhooks](https://www.mattermost.org/webhooks/) on your mattermost instance. - -#### Plus (API) version -* A dedicated user(bot) on your mattermost instance. - - -## building -Go 1.6+ is required. Make sure you have [Go](https://golang.org/doc/install) properly installed, including setting up your [GOPATH] (https://golang.org/doc/code.html#GOPATH) - -``` -cd $GOPATH -go get github.com/42wim/matterbridge -``` - -You should now have matterbridge binary in the bin directory: - -``` -$ ls bin/ -matterbridge -``` - -## running -1) Copy the matterbridge.conf.sample to matterbridge.conf in the same directory as the matterbridge binary. -2) Edit matterbridge.conf with the settings for your environment. See below for more config information. -3) Now you can run matterbridge. - -``` -Usage of ./matterbridge: - -conf string - config file (default "matterbridge.conf") - -debug - enable debug - -plus - running using API instead of webhooks (deprecated, set Plus flag in [general] config) - -version - show version -``` - -## config -### matterbridge -matterbridge looks for matterbridge.conf in current directory. (use -conf to specify another file) - -Look at [matterbridge.conf.sample] (https://github.com/42wim/matterbridge/blob/master/matterbridge.conf.sample) for an example. - -### mattermost -#### webhooks version -You'll have to configure the incoming and outgoing webhooks. - -* incoming webhooks -Go to "account settings" - integrations - "incoming webhooks". -Choose a channel at "Add a new incoming webhook", this will create a webhook URL right below. -This URL should be set in the matterbridge.conf in the [mattermost] section (see above) - -* outgoing webhooks -Go to "account settings" - integrations - "outgoing webhooks". -Choose a channel (the same as the one from incoming webhooks) and fill in the address and port of the server matterbridge will run on. - -e.g. http://192.168.1.1:9999 (192.168.1.1:9999 is the BindAddress specified in [mattermost] section of matterbridge.conf) - -#### plus version -You'll have to create a new dedicated user on your mattermost instance. -Specify the login and password in [mattermost] section of matterbridge.conf - -## FAQ -Please look at [matterbridge.conf.sample] (https://github.com/42wim/matterbridge/blob/master/matterbridge.conf.sample) for more information first. -### Mattermost doesn't show the IRC nicks -If you're running the webhooks version, this can be fixed by either: -* enabling "override usernames". See [mattermost documentation](http://docs.mattermost.com/developer/webhooks-incoming.html#enabling-incoming-webhooks) -* setting ```PrefixMessagesWithNick``` to ```true``` in ```mattermost``` section of your matterbridge.conf. - -If you're running the plus version you'll need to: -* setting ```PrefixMessagesWithNick``` to ```true``` in ```mattermost``` section of your matterbridge.conf. - -Also look at the ```RemoteNickFormat``` setting. |