diff options
author | Wim <wim@42.be> | 2016-09-18 21:04:28 +0200 |
---|---|---|
committer | Wim <wim@42.be> | 2016-09-18 21:04:28 +0200 |
commit | 0816e968318be5a4b165ac8fd30c032c6ecce61c (patch) | |
tree | e4463c48ddafe5f88fb108f194e25a42071e3899 /README.md | |
parent | 7baf386edea4c71919b257d99ca7f7e07897c412 (diff) | |
download | matterbridge-msglm-0816e968318be5a4b165ac8fd30c032c6ecce61c.tar.gz matterbridge-msglm-0816e968318be5a4b165ac8fd30c032c6ecce61c.tar.bz2 matterbridge-msglm-0816e968318be5a4b165ac8fd30c032c6ecce61c.zip |
Update documentation
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 45 |
1 files changed, 26 insertions, 19 deletions
@@ -1,22 +1,35 @@ # matterbridge -Simple bridge between mattermost, IRC, XMPP and Gitter +:warning: Look at [README-0.6.md] (https://github.com/42wim/matterbridge/blob/master/README-0.6.md) for the documentation of the current stable. +The information below is about the develop version. -* Relays public channel messages between mattermost, IRC, XMPP and Gitter. Pick and mix. +Simple bridge between mattermost, IRC, XMPP, Gitter and Slack + +* Relays public channel messages between multiple mattermost, IRC, XMPP, Gitter and Slack. Pick and mix. * Supports multiple channels. -* Matterbridge -plus also works with private groups on your mattermost. +* 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). -Look at [matterbridge.conf.sample] (https://github.com/42wim/matterbridge/blob/master/matterbridge.conf.sample) for documentation and an example. +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. ## 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) +Since v0.7.0-dev the configuration has changed. More details in [changelog.md] (https://github.com/42wim/matterbridge/blob/master/changelog.md) -## Requirements: +## 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://slack.com) + +## Docker +Create your matterbridge.toml file locally eg in ```/tmp/matterbridge.toml``` +``` +docker run -ti -v /tmp/matterbridge.toml:/matterbridge.toml 42wim/matterbridge +``` ## binaries Binaries can be found [here] (https://github.com/42wim/matterbridge/releases/) @@ -32,7 +45,7 @@ Binaries can be found [here] (https://github.com/42wim/matterbridge/releases/) #### Webhooks version * Configured incoming/outgoing [webhooks](https://www.mattermost.org/webhooks/) on your mattermost instance. -#### Plus (API) version +#### API version * A dedicated user(bot) on your mattermost instance. @@ -59,20 +72,18 @@ matterbridge ``` Usage of ./matterbridge: -conf string - config file (default "matterbridge.conf") + config file (default "matterbridge.toml") -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) +matterbridge looks for matterbridge.toml 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. +Look at [matterbridge.toml.sample] (https://github.com/42wim/matterbridge/blob/master/matterbridge.toml.sample) for an example. ### mattermost #### webhooks version @@ -89,18 +100,14 @@ Choose a channel (the same as the one from incoming webhooks) and fill in the ad 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. +Please look at [matterbridge.toml.sample] (https://github.com/42wim/matterbridge/blob/master/matterbridge.toml.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. +* setting ```PrefixMessagesWithNick``` to ```true``` in ```mattermost``` section of your matterbridge.toml. If you're running the plus version you'll need to: -* setting ```PrefixMessagesWithNick``` to ```true``` in ```mattermost``` section of your matterbridge.conf. +* setting ```PrefixMessagesWithNick``` to ```true``` in ```mattermost``` section of your matterbridge.toml. Also look at the ```RemoteNickFormat``` setting. |