2018-11-09 21:19:36 +01:00
< div align = "center" >
2017-02-20 13:48:45 +01:00
2018-11-09 21:19:36 +01:00
# matterbridge
2018-04-25 22:20:06 +02:00
2018-11-09 21:19:36 +01:00
![Matterbridge Logo ](img/matterbridge-notext.gif )< br />
2019-08-26 21:00:31 +02:00
**A simple chat bridge**< br / >
Letting people be where they want to be.< br / >
< sub > Bridges between a growing number of protocols. Click below to demo or join the development chat.< / sub >
2018-11-09 21:19:36 +01:00
< sup >
2020-04-18 18:12:16 +02:00
[Discord][mb-discord] |
2019-08-26 21:00:31 +02:00
[Gitter][mb-gitter] |
[IRC][mb-irc] |
2020-04-18 18:12:16 +02:00
[Keybase][mb-keybase] |
2019-08-26 21:00:31 +02:00
[Matrix][mb-matrix] |
[Mattermost][mb-mattermost] |
2020-04-18 18:12:16 +02:00
[MSTeams][mb-msteams] |
2019-08-26 21:00:31 +02:00
[Rocket.Chat][mb-rocketchat] |
2020-04-18 18:12:16 +02:00
[Slack][mb-slack] |
[Telegram][mb-telegram] |
2019-08-26 21:00:31 +02:00
[Twitch][mb-twitch] |
[WhatsApp][mb-whatsapp] |
2020-04-18 18:12:16 +02:00
[XMPP][mb-xmpp] |
2019-08-26 21:00:31 +02:00
[Zulip][mb-zulip] |
And more...
< / sup >
---
2018-11-09 21:19:36 +01:00
[![Download stable ](https://img.shields.io/github/release/42wim/matterbridge.svg?label=download%20stable )](https://github.com/42wim/matterbridge/releases/latest)
2019-08-26 21:00:31 +02:00
[![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)< br />
2018-11-09 21:19:36 +01:00
< hr / >
< / div >
< div align = "right" > < sup >
**Note:** Matter< em > most< / em > isn't required to run matter< em > bridge< / em > .< / sup > < / div >
2019-03-25 20:45:30 +01:00
< p >
< a href = "https://www.digitalocean.com/" >
< img src = "https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/PoweredByDO/DO_Powered_by_Badge_blue.svg" width = "201px" >
< / a >
< / p >
2020-02-02 22:36:07 +01:00
# 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 )
2021-01-15 23:21:48 +01:00
- [Articles / Tutorials ](#articles--tutorials )
2020-02-02 22:36:07 +01:00
- [Thanks ](#thanks )
2017-02-20 13:48:45 +01:00
2018-11-09 21:19:36 +01:00
## Features
2019-08-26 21:00:31 +02:00
- [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 )
2016-11-23 00:13:59 +01:00
2019-02-12 17:21:27 +01:00
### Natively supported
2018-01-28 19:47:48 +01:00
2019-08-26 21:00:31 +02:00
- [Discord ](https://discordapp.com )
2020-04-18 18:12:16 +02:00
- [Gitter ](https://gitter.im )
- [IRC ](http://www.mirc.com/servers.html )
- [Keybase ](https://keybase.io )
2019-08-26 21:00:31 +02:00
- [Matrix ](https://matrix.org )
2021-01-02 00:12:10 +01:00
- [Mattermost ](https://github.com/mattermost/mattermost-server/ )
2020-03-21 23:30:22 +01:00
- [Microsoft Teams ](https://teams.microsoft.com )
2020-10-01 22:50:56 +02:00
- [Mumble ](https://www.mumble.info/ )
2020-07-18 17:26:19 +02:00
- [Nextcloud Talk ](https://nextcloud.com/talk/ )
2020-04-18 18:12:16 +02:00
- [Rocket.chat ](https://rocket.chat )
- [Slack ](https://slack.com )
- [Ssh-chat ](https://github.com/shazow/ssh-chat )
2021-01-02 00:12:10 +01:00
- ~~[Steam](https://store.steampowered.com/)~~
- Not supported anymore, see [here ](https://github.com/Philipp15b/go-steam/issues/94 ) for more info.
2020-04-18 18:12:16 +02:00
- [Telegram ](https://telegram.org )
2019-08-26 21:00:31 +02:00
- [Twitch ](https://twitch.tv )
- [WhatsApp ](https://www.whatsapp.com/ )
2020-04-18 18:12:16 +02:00
- [XMPP ](https://xmpp.org )
2019-08-26 21:00:31 +02:00
- [Zulip ](https://zulipchat.com )
2017-02-20 13:48:45 +01:00
2019-02-12 17:21:27 +01:00
### 3rd party via matterbridge api
2019-08-26 21:00:31 +02:00
2020-04-18 18:12:16 +02:00
- [Discourse ](https://github.com/DeclanHoare/matterbabble )
- [Facebook messenger ](https://github.com/VictorNine/fbridge )
2019-08-26 21:00:31 +02:00
- [Minecraft ](https://github.com/elytra/MatterLink )
2021-01-15 23:21:48 +01:00
- [Minecraft ](https://github.com/raws/mattercraft )
2019-08-26 21:00:31 +02:00
- [Reddit ](https://github.com/bonehurtingjuice/mattereddit )
2019-11-04 23:20:44 +01:00
- [Counter-Strike, half-life and more ](https://forums.alliedmods.net/showthread.php?t=319430 )
2020-07-18 17:26:19 +02:00
- [MatterAMXX ](https://github.com/GabeIggy/MatterAMXX )
2021-01-15 23:21:48 +01:00
- [Vintage Story ](https://github.com/NikkyAI/vs-matterbridge )
2019-02-12 17:21:27 +01:00
### API
2019-08-26 21:00:31 +02:00
2019-04-14 23:48:54 +02:00
The API is basic at the moment.
2019-02-12 17:21:27 +01:00
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.
2019-08-26 21:00:31 +02:00
- [MatterLink ](https://github.com/elytra/MatterLink ) (Matterbridge link for Minecraft Server chat)
2021-01-15 23:21:48 +01:00
- [Minecraft ](https://github.com/raws/mattercraft ) (Matterbridge link for Minecraft Server chat)
2019-08-26 21:00:31 +02:00
- [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)
2019-11-04 23:20:44 +01:00
- [MatterAMXX ](https://forums.alliedmods.net/showthread.php?t=319430 ) (Counter-Strike, half-life and more via AMXX mod)
2021-01-15 23:21:48 +01:00
- [Vintage Story ](https://github.com/NikkyAI/vs-matterbridge )
2019-02-12 17:21:27 +01:00
2019-02-10 23:32:02 +01:00
## Chat with us
Questions or want to test on your favorite platform? Join below:
2020-04-18 18:12:16 +02:00
- [Discord][mb-discord]
2019-08-26 21:00:31 +02:00
- [Gitter][mb-gitter]
- [IRC][mb-irc]
2020-04-18 18:12:16 +02:00
- [Keybase][mb-keybase]
2019-08-26 21:00:31 +02:00
- [Matrix][mb-matrix]
- [Mattermost][mb-mattermost]
- [Rocket.Chat][mb-rocketchat]
2020-04-18 18:12:16 +02:00
- [Slack][mb-slack]
- [Telegram][mb-telegram]
2019-08-26 21:00:31 +02:00
- [Twitch][mb-twitch]
2020-04-18 18:12:16 +02:00
- [XMPP][mb-xmpp] (matterbridge@conference.jabber.de)
2019-08-26 21:00:31 +02:00
- [Zulip][mb-zulip]
2019-02-10 23:32:02 +01:00
2018-11-09 21:19:36 +01:00
## Screenshots
2019-08-26 21:00:31 +02:00
2020-08-24 00:50:32 +02:00
See < https: / / github . com / 42wim / matterbridge / wiki >
2017-07-24 17:36:57 +02:00
2019-06-16 23:45:18 +02:00
## Installing / upgrading
2019-08-26 21:00:31 +02:00
2018-11-09 21:19:36 +01:00
### Binaries
2019-08-26 21:00:31 +02:00
2020-12-31 22:32:13 +01:00
- Latest stable release [v1.21.0 ](https://github.com/42wim/matterbridge/releases/latest )
2020-06-28 19:02:28 +02:00
- Development releases (follows master) can be downloaded [here ](https://github.com/42wim/matterbridge/actions ) selecting the latest green build and then artifacts.
2015-10-23 23:02:14 +02:00
2020-12-29 20:42:00 +01:00
To install or upgrade just download the latest [binary ](https://github.com/42wim/matterbridge/releases/latest ). 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.20.0-linux-64bit` ). After downloading (and making the binary executable, if necessary), 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.
2019-06-16 23:45:18 +02:00
2018-12-07 23:55:08 +01:00
### Packages
2019-08-26 21:00:31 +02:00
- [Overview ](https://repology.org/metapackage/matterbridge/versions )
2020-07-18 17:26:19 +02:00
- [snap ](https://snapcraft.io/matterbridge )
2018-12-07 23:55:08 +01:00
2019-04-14 23:48:54 +02:00
## Building
2019-08-26 21:00:31 +02:00
2019-06-16 23:45:18 +02:00
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:
2021-01-02 00:12:10 +01:00
Go 1.13+ is required. Make sure you have [Go ](https://golang.org/doc/install ) properly installed.
2018-06-18 23:00:12 +02:00
2020-08-24 00:50:32 +02:00
```bash
2015-10-30 09:57:23 +01:00
go get github.com/42wim/matterbridge
2015-10-23 22:34:37 +02:00
```
2019-11-17 23:25:08 +01:00
You should now have matterbridge binary in the ~/go/bin directory:
2015-10-23 22:34:37 +02:00
2020-08-24 00:50:32 +02:00
```bash
2019-11-17 23:25:08 +01:00
$ ls ~/go/bin/
2015-10-23 22:34:37 +02:00
matterbridge
```
2018-11-09 21:19:36 +01:00
## Configuration
2019-08-26 21:00:31 +02:00
2018-11-09 21:19:36 +01:00
### Basic configuration
2019-08-26 21:00:31 +02:00
2017-06-30 01:10:38 +02:00
See [howto ](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config ) for a step by step walkthrough for creating your configuration.
2019-04-14 23:48:54 +02:00
### Settings
2019-08-26 21:00:31 +02:00
2019-04-14 23:48:54 +02:00
All possible [settings ](https://github.com/42wim/matterbridge/wiki/Settings ) for each bridge.
2018-11-09 21:19:36 +01:00
### Advanced configuration
2019-08-26 21:00:31 +02:00
- [matterbridge.toml.sample ](https://github.com/42wim/matterbridge/blob/master/matterbridge.toml.sample ) for documentation and an example.
2017-07-10 22:19:51 +02:00
2018-11-09 21:19:36 +01:00
### Examples
2019-08-26 21:00:31 +02:00
2018-11-09 21:19:36 +01:00
#### Bridge mattermost (off-topic) - irc (#testing)
2019-08-26 21:00:31 +02:00
2018-11-09 21:19:36 +01:00
```toml
2017-02-20 13:48:45 +01:00
[irc]
[irc.freenode]
Server="irc.freenode.net:6667"
Nick="yourbotname"
[mattermost]
[mattermost.work]
Server="yourmattermostserver.tld"
Team="yourteam"
Login="yourlogin"
Password="yourpass"
PrefixMessagesWithNick=true
2017-07-22 17:50:34 +02:00
RemoteNickFormat="[{PROTOCOL}] < {NICK}> "
2017-02-20 13:48:45 +01:00
[[gateway]]
name="mygateway"
enable=true
[[gateway.inout]]
account="irc.freenode"
channel="#testing"
[[gateway.inout]]
account="mattermost.work"
channel="off-topic"
```
2018-11-09 21:19:36 +01:00
#### Bridge slack (#general) - discord (general)
2019-08-26 21:00:31 +02:00
2018-11-09 21:19:36 +01:00
```toml
2017-03-20 12:12:12 +01:00
[slack]
2017-02-20 13:48:45 +01:00
[slack.test]
Token="yourslacktoken"
PrefixMessagesWithNick=true
2017-03-20 12:12:12 +01:00
[discord]
2017-02-20 13:48:45 +01:00
[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"
```
2018-11-09 21:19:36 +01:00
## Running
2017-03-25 21:35:13 +01:00
2017-07-22 17:50:34 +02:00
See [howto ](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config ) for a step by step walkthrough for creating your configuration.
2015-12-19 16:55:49 +01:00
2020-08-24 00:50:32 +02:00
```bash
2016-07-11 23:22:56 +02:00
Usage of ./matterbridge:
-conf string
2016-09-18 21:04:28 +02:00
config file (default "matterbridge.toml")
2016-07-11 23:22:56 +02:00
-debug
enable debug
2017-03-25 21:35:13 +01:00
-gops
enable gops agent
2016-07-11 23:22:56 +02:00
-version
show version
2015-12-19 16:55:49 +01:00
```
2015-10-23 22:34:37 +02:00
2018-11-09 21:19:36 +01:00
### Docker
2019-08-26 21:00:31 +02:00
2020-02-02 21:14:19 +01:00
Please take a look at the [Docker Wiki page ](https://github.com/42wim/matterbridge/wiki/Deploy:-Docker ) for more information.
2015-10-23 22:34:37 +02:00
2018-11-09 21:19:36 +01:00
## Changelog
2019-08-26 21:00:31 +02:00
2017-02-20 13:48:45 +01:00
See [changelog.md ](https://github.com/42wim/matterbridge/blob/master/changelog.md )
2015-10-23 22:34:37 +02:00
2018-11-09 21:19:36 +01:00
## FAQ
2015-10-23 22:34:37 +02:00
2017-07-22 17:50:34 +02:00
See [FAQ ](https://github.com/42wim/matterbridge/wiki/FAQ )
2017-02-20 13:48:45 +01:00
2018-11-09 21:19:36 +01:00
## Related projects
2019-08-26 21:00:31 +02:00
2020-01-01 21:38:26 +01:00
- [jwflory/ansible-role-matterbridge ](https://galaxy.ansible.com/jwflory/matterbridge ) (Ansible role to simplify deploying Matterbridge)
2019-08-26 21:00:31 +02:00
- [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)
2021-01-02 00:12:10 +01:00
- [nextcloud talk ](https://github.com/nextcloud/talk_matterbridge ) (Integrates matterbridge in Nextcloud Talk)
2021-01-15 23:21:48 +01:00
- [mattercraft ](https://github.com/raws/mattercraft ) (Minecraft bridge)
- [vs-matterbridge ](https://github.com/NikkyAI/vs-matterbridge ) (Vintage Story bridge)
2018-10-28 14:54:25 +01:00
2021-01-15 23:21:48 +01:00
## Articles / Tutorials
2019-08-26 21:00:31 +02:00
- [matterbridge on kubernetes ](https://medium.freecodecamp.org/using-kubernetes-to-deploy-a-chat-gateway-or-when-technology-works-like-its-supposed-to-a169a8cd69a3 )
2020-08-24 00:50:32 +02:00
- < 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 >
2021-01-02 00:12:10 +01:00
- < https: // nextcloud . com / blog / bridging-chat-services-in-talk />
2021-01-15 23:21:48 +01:00
- Youtube: [whatsapp - telegram bridging ](https://www.youtube.com/watch?v=W-VXISoKtNc )
2018-10-28 14:54:25 +01:00
2018-11-09 21:19:36 +01:00
## Thanks
2019-03-25 20:45:30 +01:00
< p > This project is supported by:< / p >
< p >
< a href = "https://www.digitalocean.com/" >
< img src = "https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg" width = "201px" >
< / a >
< / p >
2018-05-26 14:01:01 +02:00
2017-02-20 13:48:45 +01:00
Matterbridge wouldn't exist without these libraries:
2019-08-26 21:00:31 +02:00
2020-08-24 00:50:32 +02:00
- 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 >
2020-10-01 22:50:56 +02:00
- gumble - < https: // github . com / layeh / gumble >
2020-08-24 00:50:32 +02:00
- 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 >
2020-10-20 23:34:41 +02:00
- mumble - < https: // github . com / layeh / gumble >
2020-08-24 00:50:32 +02:00
- nctalk - < https: // github . com / gary-kim / go-nc-talk >
- 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 >
- whatsapp - < https: // github . com / Rhymen / go-whatsapp >
- xmpp - < https: // github . com / mattn / go-xmpp >
- zulip - < https: // github . com / ifo / gozulipbot >
2018-11-09 21:19:36 +01:00
<!-- Links -->
2020-04-18 18:12:16 +02:00
[mb-discord]: https://discord.gg/AkKPtrQ
2019-08-26 21:00:31 +02:00
[mb-gitter]: https://gitter.im/42wim/matterbridge
[mb-irc]: https://webchat.freenode.net/?channels=matterbridgechat
2020-04-18 18:12:16 +02:00
[mb-keybase]: https://keybase.io/team/matterbridge
2019-08-26 21:00:31 +02:00
[mb-matrix]: https://riot.im/app/#/room/#matterbridge:matrix.org
[mb-mattermost]: https://framateam.org/signup_user_complete/?id=tfqm33ggop8x3qgu4boeieta6e
2020-04-18 18:12:16 +02:00
[mb-msteams]: https://teams.microsoft.com/join/hj92x75gd3y7
2019-08-26 21:00:31 +02:00
[mb-rocketchat]: https://open.rocket.chat/channel/matterbridge
2020-10-24 21:04:24 +02:00
[mb-slack]: https://join.slack.com/t/matterbridgechat/shared_invite/zt-2ourq2h2-7YvyYBq2WFGC~~zEzA68_Q
2020-04-18 18:12:16 +02:00
[mb-telegram]: https://t.me/Matterbridge
2019-08-26 21:00:31 +02:00
[mb-twitch]: https://www.twitch.tv/matterbridge
[mb-whatsapp]: https://www.whatsapp.com/
2020-04-18 18:12:16 +02:00
[mb-xmpp]: https://inverse.chat/
2019-08-26 21:00:31 +02:00
[mb-zulip]: https://matterbridge.zulipchat.com/register/