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.
Gitter | IRC | Discord | Matrix | Slack | Mattermost | Rocket.Chat | XMPP | Twitch | WhatsApp | Zulip | Telegram | Keybase | And more...
Note: Mattermost isn't required to run matterbridge.
- Features
- Chat with us
- Screenshots
- Installing/upgrading
- Building
- Configuration
- Running
- Changelog
- FAQ
- Related projects
- Articles
- 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
- Mattermost 4.x, 5.x
- IRC
- XMPP
- Gitter
- Slack
- Discord
- Telegram
- Rocket.chat
- Matrix
- Steam
- Twitch
- Ssh-chat
- Zulip
- Keybase
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 Server chat)
- pyCord (crossplatform chatbot)
- Mattereddit (Reddit chat support)
- fbridge (Facebook messenger support)
- matterbabble (Discourse support)
- MatterAMXX (Counter-Strike, half-life and more via AMXX mod)
Questions or want to test on your favorite platform? Join below:
- Gitter
- IRC
- Discord
- Matrix
- Slack
- Mattermost
- Rocket.Chat
- XMPP (matterbridge@conference.jabber.de)
- Twitch
- Zulip
- Telegram
See https://github.com/42wim/matterbridge/wiki
To install or upgrade just download the latest binary and follow the instructions on the howto for a step by step walkthrough for creating your configuration.
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.12+ is required. Make sure you have Go properly installed.
go get github.com/42wim/matterbridge
You should now have matterbridge binary in the ~/go/bin directory:
$ ls ~/go/bin/
matterbridge
See howto for a step by step walkthrough for creating your configuration.
All possible settings for each bridge.
- matterbridge.toml.sample for documentation and an example.
[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"
[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"
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
Create your matterbridge.toml file locally eg in /tmp/matterbridge.toml
docker run -ti -v /tmp/matterbridge.toml:/matterbridge.toml 42wim/matterbridge
See changelog.md
See FAQ
- 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)
- 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/
- 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
- https://daniele.tech/2019/02/how-to-use-matterbridge-to-connect-2-different-slack-workspaces/
This project is supported by:
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
- sshchat - https://github.com/shazow/ssh-chat
- 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
- whatsapp - https://github.com/Rhymen/go-whatsapp/
- zulip - https://github.com/ifo/gozulipbot
- tengo - https://github.com/d5/tengo
- keybase - https://github.com/keybase/go-keybase-chat-bot