matterbridge/README.md

114 lines
4.9 KiB
Markdown
Raw Normal View History

2015-10-23 20:34:37 +00:00
# matterbridge
Simple bridge between mattermost, IRC, XMPP, Gitter, Slack, Discord and Telegram.
2016-09-18 19:04:28 +00:00
* Relays public channel messages between multiple mattermost, IRC, XMPP, Gitter, Slack, Discord and Telegram. Pick and mix.
2016-09-04 18:41:03 +00:00
* Supports multiple channels.
2016-09-18 19:04:28 +00:00
* Matterbridge can also work with private groups on your mattermost.
* Allow for bridging the same bridges, which means you can eg bridge between multiple mattermosts.
* The bridge is now a gateway which has support multiple in and out bridges. (and supports multiple gateways).
2015-10-23 20:34:37 +00:00
2016-09-18 19:04:28 +00:00
Look at [matterbridge.toml.sample] (https://github.com/42wim/matterbridge/blob/master/matterbridge.toml.sample) for documentation and an example.
Look at [matterbridge.toml.simple] (https://github.com/42wim/matterbridge/blob/master/matterbridge.toml.simple) for a simple example.
2016-07-11 23:23:36 +00:00
2016-09-04 18:41:03 +00:00
## Changelog
2016-11-12 21:33:58 +00:00
Since v0.7.0 the configuration has changed. More details in [changelog.md] (https://github.com/42wim/matterbridge/blob/master/changelog.md)
2016-08-20 15:52:42 +00:00
2016-09-18 19:04:28 +00:00
## Requirements
2016-09-04 18:41:03 +00:00
Accounts to one of the supported bridges
* [Mattermost] (https://github.com/mattermost/platform/)
2016-09-04 18:41:03 +00:00
* [IRC] (http://www.mirc.com/servers.html)
* [XMPP] (https://jabber.org)
* [Gitter] (https://gitter.im)
2016-09-18 19:04:28 +00:00
* [Slack] (https://slack.com)
2016-09-19 18:53:26 +00:00
* [Discord] (https://discordapp.com)
* [Telegram] (https://telegram.org)
2016-09-18 19:04:28 +00:00
## Docker
Create your matterbridge.toml file locally eg in ```/tmp/matterbridge.toml```
```
docker run -ti -v /tmp/matterbridge.toml:/matterbridge.toml 42wim/matterbridge
```
2016-08-20 16:16:22 +00:00
2016-09-04 18:41:03 +00:00
## binaries
Binaries can be found [here] (https://github.com/42wim/matterbridge/releases/)
2016-11-20 17:01:59 +00:00
* For use with mattermost 3.5.0+ [v0.8.1](https://github.com/42wim/matterircd/releases/tag/v0.8.1)
* For use with mattermost 3.3.0 - 3.4.0 [v0.7.1](https://github.com/42wim/matterircd/releases/tag/v0.7.1)
2016-11-12 21:33:58 +00:00
* For use with mattermost 3.0.0 - 3.2.0 [v0.5.0](https://github.com/42wim/matterircd/releases/tag/v0.5.0) (not maintained anymore)
2016-09-04 18:41:03 +00:00
## Compatibility
### Mattermost
2016-11-20 17:01:59 +00:00
* Matterbridge v0.8.1 works with mattermost 3.5.0+ [3.5.0 release](https://github.com/mattermost/platform/releases/tag/v3.5.0)
* Matterbridge v0.7.1 works with mattermost 3.3.0 - 3.4.0 [3.4.0 release](https://github.com/mattermost/platform/releases/tag/v3.4.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)
2016-07-12 20:00:38 +00:00
2016-09-04 18:41:03 +00:00
#### Webhooks version
2016-07-11 23:02:56 +00:00
* Configured incoming/outgoing [webhooks](https://www.mattermost.org/webhooks/) on your mattermost instance.
2016-07-12 20:00:38 +00:00
2016-09-18 19:04:28 +00:00
#### API version
2016-07-11 23:02:56 +00:00
* A dedicated user(bot) on your mattermost instance.
2015-12-20 15:21:30 +00:00
2015-10-23 21:02:14 +00:00
2015-10-23 20:34:37 +00:00
## building
2016-04-25 19:40:26 +00:00
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)
2015-10-23 20:34:37 +00:00
```
cd $GOPATH
2015-10-30 08:57:23 +00:00
go get github.com/42wim/matterbridge
2015-10-23 20:34:37 +00:00
```
You should now have matterbridge binary in the bin directory:
```
$ ls bin/
matterbridge
```
## running
2015-10-23 20:39:03 +00:00
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.
2015-12-19 15:55:49 +00:00
3) Now you can run matterbridge.
```
2016-07-11 21:22:56 +00:00
Usage of ./matterbridge:
-conf string
2016-09-18 19:04:28 +00:00
config file (default "matterbridge.toml")
2016-07-11 21:22:56 +00:00
-debug
enable debug
-version
show version
2015-12-19 15:55:49 +00:00
```
2015-10-23 20:34:37 +00:00
## config
### matterbridge
2016-09-18 19:04:28 +00:00
matterbridge looks for matterbridge.toml in current directory. (use -conf to specify another file)
2015-10-23 20:34:37 +00:00
2016-09-18 19:04:28 +00:00
Look at [matterbridge.toml.sample] (https://github.com/42wim/matterbridge/blob/master/matterbridge.toml.sample) for an example.
2015-10-23 20:34:37 +00:00
### mattermost
2016-07-11 23:02:56 +00:00
#### webhooks version
You'll have to configure the incoming and outgoing webhooks.
2015-10-23 20:34:37 +00:00
* incoming webhooks
2015-10-23 20:39:03 +00:00
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)
2015-10-23 20:34:37 +00:00
* outgoing webhooks
2015-10-23 20:39:03 +00:00
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.
2015-10-23 20:34:37 +00:00
2016-07-11 23:02:56 +00:00
e.g. http://192.168.1.1:9999 (192.168.1.1:9999 is the BindAddress specified in [mattermost] section of matterbridge.conf)
2015-10-23 20:34:37 +00:00
2016-07-15 19:59:14 +00:00
## FAQ
2016-09-18 19:04:28 +00:00
Please look at [matterbridge.toml.sample] (https://github.com/42wim/matterbridge/blob/master/matterbridge.toml.sample) for more information first.
2016-07-15 19:59:14 +00:00
### 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)
2016-09-18 19:04:28 +00:00
* setting ```PrefixMessagesWithNick``` to ```true``` in ```mattermost``` section of your matterbridge.toml.
2016-07-15 19:59:14 +00:00
If you're running the plus version you'll need to:
2016-09-18 19:04:28 +00:00
* setting ```PrefixMessagesWithNick``` to ```true``` in ```mattermost``` section of your matterbridge.toml.
2016-07-15 19:59:14 +00:00
Also look at the ```RemoteNickFormat``` setting.