3
0
mirror of https://github.com/42wim/matterbridge.git synced 2024-12-26 21:22:35 +01:00
matterbridge/README.md

297 lines
11 KiB
Markdown
Raw Normal View History

<div align="center">
2017-02-20 13:48:45 +01:00
# matterbridge
![Matterbridge Logo](img/matterbridge-notext.gif)<br />
**A simple chat bridge**<br />
Letting people be where they want to be.<br />
2019-02-05 20:40:57 +01:00
<sub>Bridges between a growing number of protocols. Click below to demo or join the development chat.</sub>
<sup>
[Gitter][mb-gitter] |
[IRC][mb-irc] |
[Discord][mb-discord] |
[Matrix][mb-matrix] |
[Slack][mb-slack] |
[Mattermost][mb-mattermost] |
2019-02-10 23:32:02 +01:00
[Rocket.Chat][mb-rocketchat] |
[XMPP][mb-xmpp] |
[Twitch][mb-twitch] |
2019-02-21 20:28:13 +01:00
[WhatsApp][mb-whatsapp] |
[Zulip][mb-zulip] |
[Telegram][mb-telegram] |
And more...
</sup>
----
[![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)<br />
<hr />
</div>
<div align="right"><sup>
**Note:** Matter<em>most</em> isn't required to run matter<em>bridge</em>.</sup></div>
### Table of Contents
2018-02-04 16:07:37 +01:00
* [Features](https://github.com/42wim/matterbridge/wiki/Features)
2019-02-12 17:21:27 +01:00
* [Natively supported](#natively-supported)
* [3rd party via matterbridge api](#3rd-party-via-matterbridge-api)
2018-10-28 14:54:25 +01:00
* [API](#API)
2019-02-10 23:32:02 +01:00
* [Chat with us](#chat-with-us)
2017-07-24 17:36:57 +02:00
* [Screenshots](https://github.com/42wim/matterbridge/wiki/)
2017-02-20 13:48:45 +01:00
* [Installing](#installing)
* [Binaries](#binaries)
* [Building](#building)
* [Configuration](#configuration)
2017-07-10 22:21:11 +02:00
* [Howto](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config)
* [Examples](#examples)
2017-02-20 13:48:45 +01:00
* [Running](#running)
* [Docker](#docker)
* [Changelog](#changelog)
* [FAQ](#faq)
2018-10-28 14:54:25 +01:00
* [Related projects](#related-projects)
* [Articles](#articles)
2017-02-20 13:48:45 +01:00
* [Thanks](#thanks)
## Features
2018-02-04 16:07:37 +01: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
2018-02-04 16:07:37 +01:00
* [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-11-25 22:38:15 +01:00
* [Mattermost](https://github.com/mattermost/mattermost-server/) 4.x, 5.x
2017-02-20 13:48:45 +01:00
* [IRC](http://www.mirc.com/servers.html)
* [XMPP](https://xmpp.org)
2017-02-20 13:48:45 +01:00
* [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)
2017-06-30 00:01:25 +02:00
* [Steam](https://store.steampowered.com/)
2018-01-20 23:38:58 +01:00
* [Twitch](https://twitch.tv)
2018-02-21 01:42:43 +01:00
* [Ssh-chat](https://github.com/shazow/ssh-chat)
2019-02-21 20:28:13 +01:00
* [WhatsApp](https://www.whatsapp.com/)
2018-05-07 21:35:48 +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
* [Minecraft](https://github.com/elytra/MatterLink)
* [Reddit](https://github.com/bonehurtingjuice/mattereddit)
* [Facebook messenger](https://github.com/VictorNine/fbridge)
### API
The API is very 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)
2019-02-10 23:32:02 +01:00
## 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]
* [Twitch][mb-twitch]
* [Zulip][mb-zulip]
* [Telegram][mb-telegram]
2019-02-10 23:32:02 +01:00
## Screenshots
2017-07-24 17:36:57 +02:00
See https://github.com/42wim/matterbridge/wiki
## Installing
### Binaries
2019-01-31 17:38:02 +01:00
* Latest stable release [v1.13.1](https://github.com/42wim/matterbridge/releases/latest)
* Development releases (follows master) can be downloaded [here](https://dl.bintray.com/42wim/nightly/)
2015-10-23 23:02:14 +02:00
2018-12-07 23:55:08 +01:00
### Packages
* [Overview](https://repology.org/metapackage/matterbridge/versions)
### Building
2019-01-31 17:38:02 +01:00
Go 1.9+ 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).
After Go is setup, download matterbridge to your $GOPATH directory.
2015-10-23 22:34:37 +02:00
```
cd $GOPATH
2015-10-30 09:57:23 +01:00
go get github.com/42wim/matterbridge
2015-10-23 22:34:37 +02:00
```
You should now have matterbridge binary in the bin directory:
```
$ ls bin/
matterbridge
```
## Configuration
### Basic configuration
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.
### Advanced configuration
2017-07-10 22:19:51 +02:00
* [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
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"
```
#### Bridge slack (#general) - discord (general)
```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"
```
## 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
```
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
### Docker
Create your matterbridge.toml file locally eg in `/tmp/matterbridge.toml`
2017-02-20 13:48:45 +01:00
```
docker run -ti -v /tmp/matterbridge.toml:/matterbridge.toml 42wim/matterbridge
```
2015-10-23 22:34:37 +02:00
## Changelog
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
## 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
## Related projects
* [FOSSRIT/infrastructure - roles/matterbridge](https://github.com/FOSSRIT/infrastructure/tree/master/roles/matterbridge) (Ansible role used to automate deployments of Matterbridge)
2018-10-28 14:54:25 +01: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)
2018-10-28 14:54:25 +01:00
* [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)
2019-02-12 17:21:27 +01:00
* [fbridge](https://github.com/VictorNine/fbridge) (Facebook messenger support)
2018-10-28 14:54:25 +01:00
## Articles
* [matterbridge on kubernetes](https://medium.freecodecamp.org/using-kubernetes-to-deploy-a-chat-gateway-or-when-technology-works-like-its-supposed-to-a169a8cd69a3)
2018-10-28 14:54:25 +01: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/
* 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
2019-02-15 19:02:23 +01:00
* https://daniele.tech/2019/02/how-to-use-matterbridge-to-connect-2-different-slack-workspaces/
2018-10-28 14:54:25 +01:00
## Thanks
2018-05-26 14:09:07 +02:00
[![Digitalocean](https://snag.gy/3LVifX.jpg)](https://www.digitalocean.com/) for sponsoring demo/testing droplets.
2018-05-26 14:01:01 +02:00
2017-02-20 13:48:45 +01:00
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
2017-03-25 21:35:13 +01:00
* gops - https://github.com/google/gops
2018-05-07 21:35:48 +02:00
* gozulipbot - https://github.com/ifo/gozulipbot
* irc - https://github.com/lrstanley/girc
* mattermost - https://github.com/mattermost/mattermost-server
2017-02-20 13:48:45 +01:00
* matrix - https://github.com/matrix-org/gomatrix
2019-01-31 17:38:02 +01:00
* sshchat - https://github.com/shazow/ssh-chat
2017-02-20 13:48:45 +01:00
* slack - https://github.com/nlopes/slack
2017-07-09 14:05:17 +02:00
* steam - https://github.com/Philipp15b/go-steam
2017-02-20 13:48:45 +01:00
* telegram - https://github.com/go-telegram-bot-api/telegram-bot-api
* xmpp - https://github.com/mattn/go-xmpp
2019-02-21 20:28:13 +01:00
* whatsapp - https://github.com/Rhymen/go-whatsapp/
2018-05-26 14:01:01 +02:00
* zulip - https://github.com/ifo/gozulipbot
* tengo - https://github.com/d5/tengo
<!-- Links -->
[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
2019-02-10 23:32:02 +01:00
[mb-rocketchat]: https://open.rocket.chat/channel/matterbridge
[mb-xmpp]: https://inverse.chat/
[mb-twitch]: https://www.twitch.tv/matterbridge
2019-02-21 20:28:13 +01:00
[mb-whatsapp]: https://www.whatsapp.com/
[mb-zulip]: https://matterbridge.zulipchat.com/register/
[mb-telegram]: https://t.me/Matterbridge