bridge between mattermost, IRC, gitter, xmpp, slack, discord, telegram, rocket.chat, steam, twitch, ssh-chat, zulip, whatsapp, keybase and matrix with REST API (mattermost not required!)
Go to file
Wim 845f7dc331 Update readme 2017-07-10 22:21:11 +02:00
.github Update issue template 2017-07-08 12:25:52 +02:00
bridge Lookup bot username (slack). #213 2017-07-10 21:58:43 +02:00
gateway Replace :emoji: with unicode chars. #215 2017-07-09 14:00:28 +02:00
hook/rockethook Add initial Rocket.Chat support 2016-12-03 00:10:29 +01:00
matterclient Add 4.0 support (mattermost) 2017-07-09 15:15:22 +02:00
matterhook Add ReadTimeout to close lingering connections (mattermost). See #125 2017-02-21 22:13:34 +01:00
vendor Replace :emoji: with unicode chars. #215 2017-07-09 14:00:28 +02: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
README-0.6.md Update documentation 2016-09-18 21:04:28 +02:00
README.md Update readme 2017-07-10 22:21:11 +02:00
changelog.md Release v0.16.0 2017-07-09 15:37:59 +02:00
matterbridge.go Bump version 2017-07-10 21:59:17 +02:00
matterbridge.toml.sample Add UseInsecureURL option (telegram) 2017-07-04 01:35:30 +02:00
matterbridge.toml.simple Add note about file permissions 2017-06-08 23:42:00 +02:00
migration.md Add migration info 2016-07-12 01:23:36 +02:00

README.md

matterbridge

Click on one of the badges below to join the chat

Gitter Join the IRC chat at https://webchat.freenode.net/?channels=matterbridgechat Discord Matrix Slack

matterbridge.gif

Simple bridge between Mattermost, IRC, XMPP, Gitter, Slack, Discord, Telegram, Rocket.Chat, Hipchat(via xmpp), Matrix and Steam. Has a REST API.

Table of Contents

Features

  • Relays public channel messages between multiple mattermost, IRC, XMPP, Gitter, Slack, Discord, Telegram, Rocket.Chat, Hipchat (via xmpp), Matrix and Steam. Pick and mix.
  • Matterbridge can also work with private groups on your mattermost/slack.
  • 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).

Requirements

Accounts to one of the supported bridges

Installing

Binaries

Binaries can be found [here] (https://github.com/42wim/matterbridge/releases/)

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

Configuration

Basic configuration

See howto for a step by step walkthrough for creating your configuration.

Advanced configuration

Examples

Bridge mattermost (off-topic) - irc (#testing)

[irc]
    [irc.freenode]
    Server="irc.freenode.net:6667"
    Nick="yourbotname"

[mattermost]
    [mattermost.work]
    useAPI=true
    Server="yourmattermostserver.tld"
    Team="yourteam"
    Login="yourlogin"
    Password="yourpass"
    PrefixMessagesWithNick=true

[[gateway]]
name="mygateway"
enable=true
    [[gateway.inout]]
    account="irc.freenode"
    channel="#testing"

    [[gateway.inout]]
    account="mattermost.work"
    channel="off-topic"

Bridge slack (#general) - discord (general)

[slack]
[slack.test]
useAPI=true
Token="yourslacktoken"
PrefixMessagesWithNick=true

[discord]
[discord.test]
Token="yourdiscordtoken"
Server="yourdiscordservername"

[general]
RemoteNickFormat="[{PROTOCOL}/{BRIDGE}] <{NICK}> "

[[gateway]]
    name = "mygateway"
    enable=true

    [[gateway.inout]]
    account = "discord.test"
    channel="general"

    [[gateway.inout]]
    account ="slack.test"
    channel = "general"

Running

  1. Copy the matterbridge.toml.sample to matterbridge.toml
  2. Edit matterbridge.toml with the settings for your environment.
  3. Now you can run matterbridge. (./matterbridge)

(Matterbridge will only look for the config file in your current directory, if it isn't there specify -conf "/path/toyour/matterbridge.toml")

Usage of ./matterbridge:
  -conf string
        config file (default "matterbridge.toml")
  -debug
        enable debug
  -gops
        enable gops agent
  -version
        show version

Docker

Create your matterbridge.toml file locally eg in /tmp/matterbridge.toml

docker run -ti -v /tmp/matterbridge.toml:/matterbridge.toml 42wim/matterbridge

Changelog

See changelog.md

FAQ

Please look at 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 API version you'll need to:

  • setting PrefixMessagesWithNick to true in mattermost section of your matterbridge.toml.

Also look at the RemoteNickFormat setting.

Thanks

Matterbridge wouldn't exist without these libraries: