mirror of
https://github.com/42wim/matterbridge.git
synced 2024-11-30 14:42:00 -08:00
259 lines
8.9 KiB
Markdown
259 lines
8.9 KiB
Markdown
<div align="center">
|
|
|
|
# matterbridge
|
|
|
|
<br />
|
|
**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.</sub>
|
|
|
|
<sup>
|
|
|
|
[Gitter][mb-gitter] |
|
|
[IRC][mb-irc] |
|
|
[Discord][mb-discord] |
|
|
[Matrix][mb-matrix] |
|
|
[Slack][mb-slack] |
|
|
[Mattermost][mb-mattermost] |
|
|
[XMPP][mb-xmpp] |
|
|
[Twitch][mb-twitch] |
|
|
[Zulip][mb-zulip] |
|
|
And more...
|
|
</sup>
|
|
|
|
----
|
|
[](https://github.com/42wim/matterbridge/releases/latest)
|
|
[](https://bintray.com/42wim/nightly/Matterbridge/_latestVersion)
|
|
[](https://codeclimate.com/github/42wim/matterbridge/maintainability)
|
|
[](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
|
|
* [Features](https://github.com/42wim/matterbridge/wiki/Features)
|
|
* [API](#API)
|
|
* [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)
|
|
* [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)
|
|
|
|
### API
|
|
The API is very basic at the moment and rather undocumented.
|
|
|
|
Used by at least 3 projects. 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)
|
|
|
|
## Requirements
|
|
Accounts to one of the supported bridges
|
|
* [Mattermost](https://github.com/mattermost/platform/) 3.8.x - 3.10.x, 4.x, 5.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)
|
|
* [Ssh-chat](https://github.com/shazow/ssh-chat)
|
|
* [Zulip](https://zulipchat.com)
|
|
|
|
## Screenshots
|
|
See https://github.com/42wim/matterbridge/wiki
|
|
|
|
## Installing
|
|
### Binaries
|
|
* Latest stable release [v1.11.3](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).
|
|
|
|
After Go is setup, download matterbridge to your $GOPATH directory.
|
|
|
|
```
|
|
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)
|
|
```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
|
|
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
|
|
|
|
## Related projects
|
|
* [matterbridge-heroku](https://github.com/cadecairos/matterbridge-heroku)
|
|
* [matterbridge config viewer](https://github.com/patcon/matterbridge-heroku-viewer)
|
|
* [matterbridge autoconfig](https://github.com/patcon/matterbridge-autoconfig)
|
|
* [matterlink](https://github.com/elytra/MatterLink)
|
|
* [mattereddit](https://github.com/bonehurtingjuice/mattereddit)
|
|
* [pyCord](https://github.com/NikkyAI/pyCord) (crossplatform chatbot)
|
|
* [mattermost-plugin](https://github.com/matterbridge/mattermost-plugin) - Run matterbridge as a plugin in mattermost
|
|
|
|
## Articles
|
|
* 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
|
|
|
|
## Thanks
|
|
[](https://www.digitalocean.com/) for sponsoring demo/testing droplets.
|
|
|
|
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/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
|
|
* zulip - https://github.com/ifo/gozulipbot
|
|
|
|
<!-- 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
|
|
[mb-xmpp]: https://inverse.chat/
|
|
[mb-twitch]: https://www.twitch.tv/matterbridge
|
|
[mb-zulip]: https://matterbridge.zulipchat.com/register/
|