# matterbridge ![Matterbridge Logo](img/matterbridge-notext.gif)
**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][mb-gitter] | [IRC][mb-irc] | [Discord][mb-discord] | [Matrix][mb-matrix] | [Slack][mb-slack] | [Mattermost][mb-mattermost] | [Rocket.Chat][mb-rocketchat] | [XMPP][mb-xmpp] | [Twitch][mb-twitch] | [WhatsApp][mb-whatsapp] | [Zulip][mb-zulip] | [Telegram][mb-telegram] | [Keybase][mb-keybase] | And more... --- [![Download stable](https://img.shields.io/github/release/42wim/matterbridge.svg?label=download%20stable)](https://github.com/42wim/matterbridge/releases/latest) [![Download dev](https://img.shields.io/bintray/v/42wim/nightly/Matterbridge.svg?label=download%20dev&colorB=007ec6)](https://bintray.com/42wim/nightly/Matterbridge/_latestVersion) [![Maintainability](https://api.codeclimate.com/v1/badges/82dff70ef2ba85a6173a/maintainability)](https://codeclimate.com/github/42wim/matterbridge/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/82dff70ef2ba85a6173a/test_coverage)](https://codeclimate.com/github/42wim/matterbridge/test_coverage)
**Note:** Mattermost isn't required to run matterbridge.

# Table of Contents - [matterbridge](#matterbridge) - [Table of Contents](#table-of-contents) - [Features](#features) - [Natively supported](#natively-supported) - [3rd party via matterbridge api](#3rd-party-via-matterbridge-api) - [API](#api) - [Chat with us](#chat-with-us) - [Screenshots](#screenshots) - [Installing / upgrading](#installing--upgrading) - [Binaries](#binaries) - [Packages](#packages) - [Building](#building) - [Configuration](#configuration) - [Basic configuration](#basic-configuration) - [Settings](#settings) - [Advanced configuration](#advanced-configuration) - [Examples](#examples) - [Bridge mattermost (off-topic) - irc (#testing)](#bridge-mattermost-off-topic---irc-testing) - [Bridge slack (#general) - discord (general)](#bridge-slack-general---discord-general) - [Running](#running) - [Docker](#docker) - [Changelog](#changelog) - [FAQ](#faq) - [Related projects](#related-projects) - [Articles](#articles) - [Thanks](#thanks) ## Features - [Support bridging between any protocols](https://github.com/42wim/matterbridge/wiki/Features#support-bridging-between-any-protocols) - [Support multiple gateways(bridges) for your protocols](https://github.com/42wim/matterbridge/wiki/Features#support-multiple-gatewaysbridges-for-your-protocols) - [Message edits and deletes](https://github.com/42wim/matterbridge/wiki/Features#message-edits-and-deletes) - Preserves threading when possible - [Attachment / files handling](https://github.com/42wim/matterbridge/wiki/Features#attachment--files-handling) - [Username and avatar spoofing](https://github.com/42wim/matterbridge/wiki/Features#username-and-avatar-spoofing) - [Private groups](https://github.com/42wim/matterbridge/wiki/Features#private-groups) - [API](https://github.com/42wim/matterbridge/wiki/Features#api) ### Natively supported - [Mattermost](https://github.com/mattermost/mattermost-server/) 4.x, 5.x - [IRC](http://www.mirc.com/servers.html) - [XMPP](https://xmpp.org) - [Gitter](https://gitter.im) - [Slack](https://slack.com) - [Discord](https://discordapp.com) - [Telegram](https://telegram.org) - [Rocket.chat](https://rocket.chat) - [Matrix](https://matrix.org) - [Steam](https://store.steampowered.com/) - [Twitch](https://twitch.tv) - [Ssh-chat](https://github.com/shazow/ssh-chat) - [WhatsApp](https://www.whatsapp.com/) - [Zulip](https://zulipchat.com) - [Keybase](https://keybase.io) ### 3rd party via matterbridge api - [Minecraft](https://github.com/elytra/MatterLink) - [Reddit](https://github.com/bonehurtingjuice/mattereddit) - [Facebook messenger](https://github.com/VictorNine/fbridge) - [Discourse](https://github.com/DeclanHoare/matterbabble) - [Counter-Strike, half-life and more](https://forums.alliedmods.net/showthread.php?t=319430) ### API The API is basic at the moment. More info and examples on the [wiki](https://github.com/42wim/matterbridge/wiki/Api). Used by the projects below. Feel free to make a PR to add your project to this list. - [MatterLink](https://github.com/elytra/MatterLink) (Matterbridge link for Minecraft Server chat) - [pyCord](https://github.com/NikkyAI/pyCord) (crossplatform chatbot) - [Mattereddit](https://github.com/bonehurtingjuice/mattereddit) (Reddit chat support) - [fbridge](https://github.com/VictorNine/fbridge) (Facebook messenger support) - [matterbabble](https://github.com/DeclanHoare/matterbabble) (Discourse support) - [MatterAMXX](https://forums.alliedmods.net/showthread.php?t=319430) (Counter-Strike, half-life and more via AMXX mod) ## Chat with us Questions or want to test on your favorite platform? Join below: - [Gitter][mb-gitter] - [IRC][mb-irc] - [Discord][mb-discord] - [Matrix][mb-matrix] - [Slack][mb-slack] - [Mattermost][mb-mattermost] - [Rocket.Chat][mb-rocketchat] - [XMPP][mb-xmpp] (matterbridge@conference.jabber.de) - [Twitch][mb-twitch] - [Zulip][mb-zulip] - [Telegram][mb-telegram] - [Keybase][mb-keybase] ## Screenshots See https://github.com/42wim/matterbridge/wiki ## Installing / upgrading ### Binaries - Latest stable release [v1.17.0](https://github.com/42wim/matterbridge/releases/latest) - Development releases (follows master) can be downloaded [here](https://dl.bintray.com/42wim/nightly/) To install or upgrade just download the latest [binary](https://github.com/42wim/matterbridge/releases/latest) and follow the instructions on the [howto](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config) for a step by step walkthrough for creating your configuration. ### Packages - [Overview](https://repology.org/metapackage/matterbridge/versions) ## Building Most people just want to use binaries, you can find those [here](https://github.com/42wim/matterbridge/releases/latest) If you really want to build from source, follow these instructions: Go 1.12+ is required. Make sure you have [Go](https://golang.org/doc/install) properly installed. ``` go get github.com/42wim/matterbridge ``` You should now have matterbridge binary in the ~/go/bin directory: ``` $ ls ~/go/bin/ matterbridge ``` ## Configuration ### Basic configuration See [howto](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config) for a step by step walkthrough for creating your configuration. ### Settings All possible [settings](https://github.com/42wim/matterbridge/wiki/Settings) for each bridge. ### Advanced configuration - [matterbridge.toml.sample](https://github.com/42wim/matterbridge/blob/master/matterbridge.toml.sample) for documentation and an example. ### Examples #### Bridge mattermost (off-topic) - irc (#testing) ```toml [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) ```toml [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](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config) 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](https://github.com/42wim/matterbridge/wiki/Deploy:-Docker) for more information. ## Changelog See [changelog.md](https://github.com/42wim/matterbridge/blob/master/changelog.md) ## FAQ See [FAQ](https://github.com/42wim/matterbridge/wiki/FAQ) ## Related projects - [jwflory/ansible-role-matterbridge](https://galaxy.ansible.com/jwflory/matterbridge) (Ansible role to simplify deploying Matterbridge) - [matterbridge autoconfig](https://github.com/patcon/matterbridge-autoconfig) - [matterbridge config viewer](https://github.com/patcon/matterbridge-heroku-viewer) - [matterbridge-heroku](https://github.com/cadecairos/matterbridge-heroku) - [mattereddit](https://github.com/bonehurtingjuice/mattereddit) - [matterlink](https://github.com/elytra/MatterLink) - [mattermost-plugin](https://github.com/matterbridge/mattermost-plugin) - Run matterbridge as a plugin in mattermost - [pyCord](https://github.com/NikkyAI/pyCord) (crossplatform chatbot) - [fbridge](https://github.com/VictorNine/fbridge) (Facebook messenger support) - [isla](https://github.com/alphachung/isla) (Bot for Discord-Telegram groups used alongside matterbridge) - [matterbabble](https://github.com/DeclanHoare/matterbabble) (Connect Discourse threads to Matterbridge) ## Articles - [matterbridge on kubernetes](https://medium.freecodecamp.org/using-kubernetes-to-deploy-a-chat-gateway-or-when-technology-works-like-its-supposed-to-a169a8cd69a3) - 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/ ## 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 - 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 [mb-gitter]: https://gitter.im/42wim/matterbridge [mb-irc]: https://webchat.freenode.net/?channels=matterbridgechat [mb-discord]: https://discord.gg/AkKPtrQ [mb-matrix]: https://riot.im/app/#/room/#matterbridge:matrix.org [mb-slack]: https://join.slack.com/matterbridgechat/shared_invite/MjEwODMxNjU1NDMwLTE0OTk2MTU3NTMtMzZkZmRiNDZhOA [mb-mattermost]: https://framateam.org/signup_user_complete/?id=tfqm33ggop8x3qgu4boeieta6e [mb-rocketchat]: https://open.rocket.chat/channel/matterbridge [mb-xmpp]: https://inverse.chat/ [mb-twitch]: https://www.twitch.tv/matterbridge [mb-whatsapp]: https://www.whatsapp.com/ [mb-keybase]: https://keybase.io/team/matterbridge [mb-zulip]: https://matterbridge.zulipchat.com/register/ [mb-telegram]: https://t.me/Matterbridge