# matterbridge
Click on one of the badges below to join the chat
[](https://gitter.im/42wim/matterbridge) [](https://webchat.freenode.net/?channels=matterbridgechat) [](https://discord.gg/AkKPtrQ) [](https://riot.im/app/#/room/#matterbridge:matrix.org) [](https://join.slack.com/matterbridgechat/shared_invite/MjEwODMxNjU1NDMwLTE0OTk2MTU3NTMtMzZkZmRiNDZhOA) [](https://framateam.org/signup_user_complete/?id=tfqm33ggop8x3qgu4boeieta6e) [](https://inverse.chat) [](https://www.twitch.tv/matterbridge)
[](https://github.com/42wim/matterbridge/releases/latest) [](https://bintray.com/42wim/nightly/Matterbridge/_latestVersion)
Simple bridge between Mattermost, IRC, XMPP, Gitter, Slack, Discord, Telegram, Rocket.Chat, Hipchat(via xmpp), Matrix and Steam.
Has a REST API.
# Table of Contents
* [Features ](#features )
* [Requirements ](#requirements )
* [Screenshots ](https://github.com/42wim/matterbridge/wiki/ )
* [Installing ](#installing )
* [Binaries ](#binaries )
* [Building ](#building )
* [Configuration ](#configuration )
* [Howto ](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config )
* [Examples ](#examples )
* [Running ](#running )
* [Docker ](#docker )
* [Changelog ](#changelog )
* [FAQ ](#faq )
* [Thanks ](#thanks )
# Features
* Relays public channel messages between multiple mattermost, IRC, XMPP, Gitter, Slack, Discord, Telegram, Rocket.Chat, Hipchat (via xmpp), Matrix and Steam.
Pick and mix.
* Support private groups on your mattermost/slack.
* Allow for bridging the same bridges, which means you can eg bridge between multiple mattermosts.
* The bridge is now a gateway which has support multiple in and out bridges. (and supports multiple gateways).
* Edits and delete messages across bridges that support it (mattermost,slack,discord,gitter,telegram)
* REST API to read/post messages to bridges (WIP).
# Requirements
Accounts to one of the supported bridges
* [Mattermost ](https://github.com/mattermost/platform/ ) 3.8.x - 3.10.x, 4.x
* [IRC ](http://www.mirc.com/servers.html )
* [XMPP ](https://jabber.org )
* [Gitter ](https://gitter.im )
* [Slack ](https://slack.com )
* [Discord ](https://discordapp.com )
* [Telegram ](https://telegram.org )
* [Hipchat ](https://www.hipchat.com )
* [Rocket.chat ](https://rocket.chat )
* [Matrix ](https://matrix.org )
* [Steam ](https://store.steampowered.com/ )
* [Twitch ](https://twitch.tv )
# Screenshots
See https://github.com/42wim/matterbridge/wiki
# Installing
## Binaries
* Latest stable release [v1.7.0 ](https://github.com/42wim/matterbridge/releases/latest )
* Development releases (follows master) can be downloaded [here ](https://dl.bintray.com/42wim/nightly/ )
## Building
Go 1.8+ is required. Make sure you have [Go ](https://golang.org/doc/install ) properly installed, including setting up your [GOPATH] (https://golang.org/doc/code.html#GOPATH)
```
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 ](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config ) for a step by step walkthrough for creating your configuration.
## 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)
```
[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 ](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
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 ](https://github.com/42wim/matterbridge/blob/master/changelog.md )
# FAQ
See [FAQ ](https://github.com/42wim/matterbridge/wiki/FAQ )
Want to tip ?
* eth: 0xb3f9b5387c66ad6be892bcb7bbc67862f3abc16f
* btc: 1N7cKHj5SfqBHBzDJ6kad4BzeqUBBS2zhs
# Thanks
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
* irc - https://github.com/lrstanley/girc
* mattermost - https://github.com/mattermost/platform
* 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
