matterbridge

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

Discord | Gitter | IRC | Keybase | Matrix | Mattermost | MSTeams | Rocket.Chat | Slack | Telegram | Twitch | WhatsApp | XMPP | Zulip | And more...

---

---

Note: Mattermost isn't required to run matterbridge.

Table of Contents

• matterbridge
• Table of Contents
  • Features
    • Natively supported
    • 3rd party via matterbridge api
    • API
  • Chat with us
  • Screenshots
  • Installing / upgrading
    • Binaries
    • Packages
  • Building
  • Building with whatsapp (beta) multidevice support
  • Configuration
    • Basic configuration
    • Settings
    • Advanced configuration
      • Examples
        • Bridge mattermost (off-topic) - irc (#testing)
        • Bridge slack (#general) - discord (general)
    • Running
      • Docker
      • Systemd
    • Changelog
    • FAQ
    • Related projects
    • Articles / Tutorials
    • 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

Natively supported

• Discord
• Gitter
• Harmony
• IRC
• Keybase
• Matrix
• Mattermost
• Microsoft Teams
• Mumble
• Nextcloud Talk
• Rocket.chat
• Slack
• Ssh-chat
• Steam
  • Not supported anymore, see here for more info.
• Telegram
• Twitch
• VK
• WhatsApp
  • Whatsapp legacy is natively supported
  • Whatsapp multidevice beta is natively supported but you need to build yourself, see here
• XMPP
• Zulip

3rd party via matterbridge api

• Delta Chat
• Minecraft
• Minecraft

Past 3rd party projects

• Discourse
• Facebook messenger
• Facebook messenger
• Minecraft
• Reddit
• MatterAMXX: Counter-Strike, half-life and more
• Vintage Story
• Ultima Online Emulator
• Teamspeak

API

The API is basic at the moment. More info and examples on the wiki.

Used by the projects below. Feel free to make a PR to add your project to this list.

• MatterLink (Matterbridge link for Minecraft Forge server chat, archived)
• MatterCraft (Matterbridge link for Minecraft Forge server chat)
• MatterBukkit (Matterbridge link for Minecraft Bukkit/Spigot server chat)
• pyCord (crossplatform chatbot)
• Mattereddit (Reddit chat support)
• fbridge-asyncio (Facebook messenger support)
• fbridge (Facebook messenger support)
• matterbabble (Discourse support)
• MatterAMXX (Counter-Strike, half-life and more via AMXX mod)
• Vintage Story
• ServUO-matterbridge (A matterbridge connector for ServUO servers)
• ts-matterbridge (Integrate teamspeak chat with matterbridge)
• beerchat (Matterbridge link for minetest)

Chat with us

Questions or want to test on your favorite platform? Join below:

• Discord
• Gitter
• IRC
• Keybase
• Matrix
• Mattermost
• Rocket.Chat
• Slack
• Telegram
• Twitch
• XMPP ([email protected])
• Zulip

Screenshots

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

Installing / upgrading

Binaries

• Latest stable release v1.26.0
• Development releases (follows master) can be downloaded here selecting the latest green build and then artifacts.

To install or upgrade just download the latest binary. On *nix platforms you may need to make the binary executable - you can do this by running chmod a+x on the binary (example: chmod a+x matterbridge-1.24.1-linux-64bit). After downloading (and making the binary executable, if necessary), follow the instructions on the howto for a step by step walkthrough for creating your configuration.

Packages

• Overview
• snap
• scoop

Building

Most people just want to use binaries, you can find those here

If you really want to build from source, follow these instructions: Go 1.18+ is required. Make sure you have Go properly installed.

Building the binary with all the bridges enabled needs about 3GB RAM to compile. You can reduce this memory requirement to 0,5GB RAM by adding the nomsteams tag if you don't need/use the Microsoft Teams bridge.

Matterbridge can be build without gcc/c-compiler: If you're running on windows first run set CGO_ENABLED=0 on other platforms you prepend CGO_ENABLED=0 to the go build command. (eg CGO_ENABLED=0 go install github.com/42wim/matterbridge)

To install the latest stable run:

go install github.com/42wim/matterbridge

To install the latest dev run:

go install github.com/42wim/matterbridge@master

To install the latest stable run without msteams or zulip bridge:

go install -tags nomsteams,nozulip github.com/42wim/matterbridge

You should now have matterbridge binary in the ~/go/bin directory:

$ ls ~/go/bin/
matterbridge

Building with whatsapp (beta) multidevice support

Because the library we use for Whatsapp multidevice support includes a GPL3 library we can not provide you binaries. (as this would require the Matterbridge to change it license to GPL)

Matterbridge can be build without gcc/c-compiler: If you're running on windows first run set CGO_ENABLED=0 on other platforms you prepend CGO_ENABLED=0 to the go build command. (eg CGO_ENABLED=0 go install github.com/42wim/matterbridge)

So this means you have to build it yourself using the instructions below:

go install -tags whatsappmulti github.com/42wim/matterbridge@master

If you're low on memory and don't need msteams:

go install -tags nomsteams,whatsappmulti github.com/42wim/matterbridge@master

You should now have matterbridge binary in the ~/go/bin directory:

$ ls ~/go/bin/
matterbridge

Configuration

Basic configuration

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

Settings

All possible settings for each bridge.

Advanced configuration

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

Examples

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

[irc]
    [irc.libera]
    Server="irc.libera.chat: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.libera"
    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

Please take a look at the Docker Wiki page for more information.

Systemd

Please take a look at the Service Files page for more information.

Changelog

See changelog.md

FAQ

See FAQ

Related projects

• jwflory/ansible-role-matterbridge (Ansible role to simplify deploying Matterbridge)
• matterbridge autoconfig
• matterbridge config viewer
• matterbridge-heroku
• mattereddit
• matterlink
• mattermost-plugin - Run matterbridge as a plugin in mattermost
• pyCord (crossplatform chatbot)
• fbridge (Facebook messenger support)
• isla (Bot for Discord-Telegram groups used alongside matterbridge)
• matterbabble (Connect Discourse threads to Matterbridge)
• nextcloud talk (Integrates matterbridge in Nextcloud Talk)
• mattercraft (Minecraft bridge)
• vs-matterbridge (Vintage Story bridge)
• ServUO-matterbridge (A matterbridge connector for ServUO servers)
• ts-matterbridge (Integrate teamspeak chat with matterbridge)

Articles / Tutorials

• matterbridge on kubernetes
• 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/
• 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
• https://daniele.tech/2019/02/how-to-use-matterbridge-to-connect-2-different-slack-workspaces/
• https://userlinux.net/mattermost-and-matterbridge.html
• https://nextcloud.com/blog/bridging-chat-services-in-talk/
• https://minecraftchest1.wordpress.com/2021/06/05/how-to-install-and-setup-matterbridge/
• Youtube: whatsapp - telegram bridging

Thanks

This project is supported by:

Matterbridge wouldn't exist without these libraries:

• discord - https://github.com/bwmarrin/discordgo
• echo - https://github.com/labstack/echo
• gops - https://github.com/google/gops
• gozulipbot - https://github.com/ifo/gozulipbot
• gumble - https://github.com/layeh/gumble
• harmony - https://github.com/harmony-development/shibshib
• irc - https://github.com/lrstanley/girc
• keybase - https://github.com/keybase/go-keybase-chat-bot
• matrix - https://github.com/matrix-org/gomatrix
• mattermost - https://github.com/mattermost/mattermost-server
• msgraph.go - https://github.com/yaegashi/msgraph.go
• mumble - https://github.com/layeh/gumble
• nctalk - https://github.com/gary-kim/go-nc-talk
• rocketchat - https://github.com/RocketChat/Rocket.Chat.Go.SDK
• slack - https://github.com/nlopes/slack
• sshchat - https://github.com/shazow/ssh-chat
• steam - https://github.com/Philipp15b/go-steam
• telegram - https://github.com/go-telegram-bot-api/telegram-bot-api
• tengo - https://github.com/d5/tengo
• vk - https://github.com/SevereCloud/vksdk
• whatsapp - https://github.com/Rhymen/go-whatsapp
• whatsapp - https://github.com/tulir/whatsmeow
• xmpp - https://github.com/mattn/go-xmpp
• zulip - https://github.com/ifo/gozulipbot