matterbridge

A simple chat bridge
Letting people be where they want to be.
_{Bridges between a growing number of protocols. Click below to demo.}

Gitter | IRC | Discord | Matrix | Slack | Mattermost | XMPP | Twitch | Zulip | And more...

---

---

Note: Mattermost isn't required to run matterbridge.

Table of Contents

• Features
  • API
• Requirements
• Screenshots
• Installing
  • Binaries
  • Building
• Configuration
  • Howto
  • Examples
• Running
  • Docker
• Changelog
• FAQ
• Related projects
• Articles
• Thanks

Features

• Support bridging between any protocols
• Support multiple gateways(bridges) for your protocols
• Message edits and deletes
• Preserves threading when possible
• Attachment / files handling
• Username and avatar spoofing
• Private groups
• API

API

The API is very basic at the moment and rather undocumented.

Used by at least 3 projects. Feel free to make a PR to add your project to this list.

• MatterLink (Matterbridge link for Minecraft Server chat)
• pyCord (crossplatform chatbot)
• Mattereddit (Reddit chat support)

Requirements

Accounts to one of the supported bridges

• Mattermost 4.x, 5.x
• IRC
• XMPP
• Gitter
• Slack
• Discord
• Telegram
• Hipchat
• Rocket.chat
• Matrix
• Steam
• Twitch
• Ssh-chat
• Zulip

Screenshots

See https://github.com/42wim/matterbridge/wiki

Installing

Binaries

• Latest stable release v1.12.2
• Development releases (follows master) can be downloaded here

Building

Go 1.8+ is required. Make sure you have Go properly installed, including setting up your GOPATH.

After Go is setup, download matterbridge to your $GOPATH directory.

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

• matterbridge.toml.sample for documentation and an example.

Examples

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

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

[mattermost]
    [mattermost.work]
    Server="yourmattermostserver.tld"
    Team="yourteam"
    Login="yourlogin"
    Password="yourpass"
    PrefixMessagesWithNick=true
    RemoteNickFormat="[{PROTOCOL}] <{NICK}> "

[[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]
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

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

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

See FAQ

Want to tip ?

• eth: 0xb3f9b5387c66ad6be892bcb7bbc67862f3abc16f
• btc: 1N7cKHj5SfqBHBzDJ6kad4BzeqUBBS2zhs

Related projects

• FOSSRIT/infrastructure - roles/matterbridge (Ansible role used to automate deployments of Matterbridge)
• matterbridge autoconfig
• matterbridge config viewer
• matterbridge-heroku
• mattereddit
• matterlink
• mattermost-plugin - Run matterbridge as a plugin in mattermost
• pyCord (crossplatform chatbot)

Articles

• https://mattermost.com/blog/connect-irc-to-mattermost/
• https://blog.valvin.fr/2016/09/17/mattermost-et-un-channel-irc-cest-possible/
• https://blog.brightscout.com/top-10-mattermost-integrations/
• http://bencey.co.nz/2018/09/17/bridge/
• https://www.algoo.fr/blog/2018/01/19/recouvrez-votre-liberte-en-quittant-slack-pour-un-mattermost-auto-heberge/
• https://kopano.com/blog/matterbridge-bridging-mattermost-chat/
• https://www.stitcher.com/s/?eid=52382713

Thanks

for sponsoring demo/testing droplets.

Matterbridge wouldn't exist without these libraries:

• discord - https://github.com/bwmarrin/discordgo
• echo - https://github.com/labstack/echo
• gitter - https://github.com/sromku/go-gitter
• gops - https://github.com/google/gops
• gozulipbot - https://github.com/ifo/gozulipbot
• irc - https://github.com/lrstanley/girc
• mattermost - https://github.com/mattermost/mattermost-server
• matrix - https://github.com/matrix-org/gomatrix
• slack - https://github.com/nlopes/slack
• steam - https://github.com/Philipp15b/go-steam
• telegram - https://github.com/go-telegram-bot-api/telegram-bot-api
• xmpp - https://github.com/mattn/go-xmpp
• zulip - https://github.com/ifo/gozulipbot