cwinfo/matterbridge
5
0
Fork 0
mirror of https://github.com/cwinfo/matterbridge.git synced 2024-11-22 07:00:27 +00:00
Code Releases Activity
bridge between mattermost, IRC, gitter, xmpp, slack, discord, telegram, rocket.chat,hipchat (via xmpp), steam, twitch, ssh-chat, zulip, whatsapp and matrix with REST API (mattermost not required!)
254 Commits 2 Branches 81 Tags 75 MiB
Go 99.4%
Dockerfile 0.5%
Shell 0.1%
73f01ad8d8
Go to file
Wim 73f01ad8d8 Add REST API support
2017-02-18 23:13:46 +01:00
.github Create ISSUE_TEMPLATE.md 2016-11-23 20:22:27 +01:00
bridge Add REST API support 2017-02-18 23:13:46 +01:00
gateway Add REST API support 2017-02-18 23:13:46 +01:00
hook/rockethook Add initial Rocket.Chat support 2016-12-03 00:10:29 +01:00
matterclient Set http timeout to 10 seconds 2017-02-17 17:51:07 +01:00
matterhook Add Slack support 2016-09-05 16:34:37 +02:00
vendor Update vendor 2017-02-18 23:11:48 +01:00
changelog.md Add REST API support 2017-02-18 23:13:46 +01:00
Dockerfile Add githash to docker builds 2017-02-17 22:32:42 +01:00
LICENSE Initial commit 2015-10-23 17:07:05 +02:00
matterbridge.go Add githash to docker builds 2017-02-17 22:32:42 +01:00
matterbridge.toml.sample Add REST API support 2017-02-18 23:13:46 +01:00
matterbridge.toml.simple Release v0.9.0 2016-12-01 22:15:40 +01:00
migration.md Add migration info 2016-07-12 01:23:36 +02:00
README-0.6.md Update documentation 2016-09-18 21:04:28 +02:00
README.md Add REST API support 2017-02-18 23:13:46 +01:00

README.md

matterbridge

matterbridge.gif

Simple bridge between mattermost, IRC, XMPP, Gitter, Slack, Discord, Telegram, Rocket.Chat and Hipchat(via xmpp) with REST API.

  • Relays public channel messages between multiple mattermost, IRC, XMPP, Gitter, Slack, Discord, Telegram, Rocket.Chat and Hipchat (via xmpp). Pick and mix.
  • Supports multiple channels.
  • 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).
  • REST API to read/post messages to bridges (WIP)

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.7.0 the configuration has changed. More details in [changelog.md] (https://github.com/42wim/matterbridge/blob/master/changelog.md)

Requirements

Accounts to one of the supported bridges

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/)

  • For use with mattermost 3.5.x - 3.6.0 v0.9.2
  • For use with mattermost 3.3.0 - 3.4.0 v0.7.1

Compatibility

Mattermost

  • Matterbridge v0.9.2 works with mattermost 3.5.x - 3.6.0 3.6.0 release
  • Matterbridge v0.7.1 works with mattermost 3.3.0 - 3.4.0 3.4.0 release

Webhooks version

  • Configured incoming/outgoing webhooks on your mattermost instance.

API version

  • A dedicated user(bot) on your mattermost instance.

building

Go 1.6+ is required. Make sure you have Go 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.toml")
  -debug
        enable debug
  -version
        show version

config

matterbridge

matterbridge looks for matterbridge.toml in current directory. (use -conf to specify another file)

Look at [matterbridge.toml.sample] (https://github.com/42wim/matterbridge/blob/master/matterbridge.toml.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)

FAQ

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
  • 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.toml.

Also look at the RemoteNickFormat setting.