Repository files navigation

• 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

• 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

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

• Delta Chat
• Minecraft
• Minecraft

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

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

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)

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

• Discord
• Gitter
• IRC
• Keybase
• Matrix
• Mattermost
• Rocket.Chat
• Slack
• Telegram
• Twitch
• XMPP (matterbridge@conference.jabber.de)
• Zulip

Seehttps://github.com/42wim/matterbridge/wiki

• Latest stable releasev1.26.0
• Development releases (follows master) can be downloadedhere selecting the latest green build and then artifacts.

To install or upgrade just download the latestbinary. On *nix platforms you may need to make the binary executable - you can do this by runningchmod 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 thehowto for a step by step walkthrough for creating your configuration.

• Overview
• snap
• scoop

Most people just want to use binaries, you can find thosehere

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

Building the binary withall the bridges enabled needs about 3GB RAM to compile.You can reduce this memory requirement to 0,5GB RAM by adding thenomsteams 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 runset CGO_ENABLED=0 on other platforms you prependCGO_ENABLED=0 to thego build command. (egCGO_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

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 runset CGO_ENABLED=0 on other platforms you prependCGO_ENABLED=0 to thego build command. (egCGO_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

Seehowto for a step by step walkthrough for creating your configuration.

All possiblesettings for each bridge.

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

[irc]    [irc.libera]Server="irc.libera.chat:6667"Nick="yourbotname"[mattermost]    [mattermost.work]Server="yourmattermostserver.tld"Team="yourteam"Login="yourlogin"Password="yourpass"PrefixMessagesWithNick=trueRemoteNickFormat="[{PROTOCOL}] <{NICK}>"[[gateway]]name="mygateway"enable=true    [[gateway.inout]]account="irc.libera"channel="#testing"    [[gateway.inout]]account="mattermost.work"channel="off-topic"

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

Seehowto for a step by step walkthrough for creating your configuration.

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

Please take a look at theDocker Wiki page for more information.

Please take a look at theService Files page for more information.

Seechangelog.md

SeeFAQ

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

• 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

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