mirror of
https://github.com/cwinfo/matterbridge.git
synced 2024-11-14 03:50:26 +00:00
180 lines
5.8 KiB
Markdown
180 lines
5.8 KiB
Markdown
# matterbridge
|
|
[](https://gitter.im/42wim/matterbridge) [](https://webchat.freenode.net/?channels=matterbridgechat) [](https://discord.gg/AkKPtrQ) [](https://riot.im/app/#/room/#matterbridge:matrix.org)
|
|
|
|
|
|
|
|
Simple bridge between Mattermost, IRC, XMPP, Gitter, Slack, Discord, Telegram, Rocket.Chat, Hipchat(via xmpp) and Matrix with REST API.
|
|
|
|
# Table of Contents
|
|
* [Features](#features)
|
|
* [Requirements](#requirements)
|
|
* [Installing](#installing)
|
|
* [Binaries](#binaries)
|
|
* [Building](#building)
|
|
* [Configuration](#configuration)
|
|
* [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) and Matrix. Pick and mix.
|
|
* Matterbridge can also work with 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).
|
|
* REST API to read/post messages to bridges (WIP).
|
|
|
|
# Requirements
|
|
Accounts to one of the supported bridges
|
|
* [Mattermost](https://github.com/mattermost/platform/) 3.5.x - 3.7.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)
|
|
|
|
# Installing
|
|
## Binaries
|
|
Binaries can be found [here] (https://github.com/42wim/matterbridge/releases/)
|
|
* Latest release [v0.10.3](https://github.com/42wim/matterbridge/releases/latest)
|
|
|
|
## Building
|
|
Go 1.6+ 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
|
|
* [matterbridge.toml.sample](https://github.com/42wim/matterbridge/blob/master/matterbridge.toml.sample) for documentation and an example.
|
|
* [matterbridge.toml.simple](https://github.com/42wim/matterbridge/blob/master/matterbridge.toml.simple) for a simple example.
|
|
|
|
## Examples
|
|
### Bridge mattermost (off-topic) - irc (#testing)
|
|
```
|
|
[irc]
|
|
[irc.freenode]
|
|
Server="irc.freenode.net:6667"
|
|
Nick="yourbotname"
|
|
|
|
[mattermost]
|
|
[mattermost.work]
|
|
useAPI=true
|
|
Server="yourmattermostserver.tld"
|
|
Team="yourteam"
|
|
Login="yourlogin"
|
|
Password="yourpass"
|
|
PrefixMessagesWithNick=true
|
|
|
|
[[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]
|
|
useAPI=true
|
|
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
|
|
1) Copy the matterbridge.toml.sample to matterbridge.toml
|
|
2) Edit matterbridge.toml with the settings for your environment.
|
|
3) Now you can run matterbridge. (```./matterbridge```)
|
|
|
|
(Matterbridge will only look for the config file in your current directory, if it isn't there specify -conf "/path/toyour/matterbridge.toml")
|
|
|
|
```
|
|
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
|
|
|
|
Please look at [matterbridge.toml.sample](https://github.com/42wim/matterbridge/blob/master/matterbridge.toml.sample) for more information first.
|
|
|
|
## Mattermost doesn't show the IRC nicks
|
|
If you're running the webhooks version, this can be fixed by either:
|
|
* enabling "override usernames". See [mattermost documentation](http://docs.mattermost.com/developer/webhooks-incoming.html#enabling-incoming-webhooks)
|
|
* setting ```PrefixMessagesWithNick``` to ```true``` in ```mattermost``` section of your matterbridge.toml.
|
|
|
|
If you're running the API version you'll need to:
|
|
* setting ```PrefixMessagesWithNick``` to ```true``` in ```mattermost``` section of your matterbridge.toml.
|
|
|
|
Also look at the ```RemoteNickFormat``` setting.
|
|
|
|
|
|
# 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/thoj/go-ircevent
|
|
* mattermost - https://github.com/mattermost/platform
|
|
* matrix - https://github.com/matrix-org/gomatrix
|
|
* slack - https://github.com/nlopes/slack
|
|
* telegram - https://github.com/go-telegram-bot-api/telegram-bot-api
|
|
* xmpp - https://github.com/mattn/go-xmpp
|
|
|