3
0
mirror of https://github.com/42wim/matterbridge.git synced 2024-12-23 03:32:37 +01:00
matterbridge/README.md

201 lines
7.8 KiB
Markdown
Raw Normal View History

2015-10-23 22:34:37 +02:00
# matterbridge
2017-07-09 18:08:30 +02:00
Click on one of the badges below to join the chat
2018-05-07 22:33:29 +02:00
[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg?colorB=42f4242)](https://gitter.im/42wim/matterbridge) [![Join the IRC chat at https://webchat.freenode.net/?channels=matterbridgechat](https://img.shields.io/badge/IRC-matterbridgechat-green.svg?colorB=42f4242)](https://webchat.freenode.net/?channels=matterbridgechat) [![Discord](https://img.shields.io/badge/discord-matterbridge-green.svg?colorB=42f4242)](https://discord.gg/AkKPtrQ) [![Matrix](https://img.shields.io/badge/matrix-matterbridge-green.svg?colorB=42f4242)](https://riot.im/app/#/room/#matterbridge:matrix.org) [![Slack](https://img.shields.io/badge/slack-matterbridgechat-green.svg?colorB=42f4242)](https://join.slack.com/matterbridgechat/shared_invite/MjEwODMxNjU1NDMwLTE0OTk2MTU3NTMtMzZkZmRiNDZhOA) [![Mattermost](https://img.shields.io/badge/mattermost-matterbridge-green.svg?colorB=42f4242)](https://framateam.org/signup_user_complete/?id=tfqm33ggop8x3qgu4boeieta6e) [![Xmpp](https://img.shields.io/badge/xmpp-matterbridge@conference.jabber.de-green.svg?colorB=42f4242)](https://inverse.chat) [![Twitch](https://img.shields.io/badge/twitch-matterbridge-green.svg?colorB=42f4242)](https://www.twitch.tv/matterbridge) [![Zulip](https://img.shields.io/badge/zulip-matterbridge-green.svg?colorB=42f4242)](https://matterbridge.zulipchat.com/register/)
2017-03-18 22:16:25 +01:00
2017-07-16 23:14:18 +02:00
[![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)
2017-07-16 22:56:26 +02:00
![matterbridge.gif](https://github.com/42wim/matterbridge/blob/master/img/matterbridge.gif)
2016-11-23 00:13:59 +01:00
2018-05-07 21:35:48 +02:00
Simple bridge between IRC, XMPP, Gitter, Mattermost, Slack, Discord, Telegram, Rocket.Chat, Hipchat(via xmpp), Matrix, Steam, ssh-chat and Zulip
2018-04-25 22:21:16 +02:00
Has a REST API.
Minecraft server chat support via [MatterLink](https://github.com/elytra/MatterLink)
2017-02-20 13:48:45 +01:00
**Mattermost isn't required to run matterbridge. It bridges between any supported protocol.**
2018-04-25 22:21:16 +02:00
(The name matterbridge is a remnant when it was only bridging mattermost)
2017-02-20 13:48:45 +01:00
# Table of Contents
2018-02-04 16:07:37 +01:00
* [Features](https://github.com/42wim/matterbridge/wiki/Features)
2017-02-20 13:48:45 +01:00
* [Requirements](#requirements)
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)
2017-02-20 13:48:45 +01:00
* [Examples](#examples)
* [Running](#running)
* [Docker](#docker)
* [Changelog](#changelog)
* [FAQ](#faq)
* [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)
* [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
## API
The API is very basic at the moment and rather undocumented.
Used by at least 2 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)
2017-02-20 13:48:45 +01:00
# Requirements
2016-09-04 20:41:03 +02:00
Accounts to one of the supported bridges
2017-10-15 22:57:14 +02:00
* [Mattermost](https://github.com/mattermost/platform/) 3.8.x - 3.10.x, 4.x
2017-02-20 13:48:45 +01:00
* [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)
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)
2018-05-07 21:35:48 +02:00
* [Zulip](https://zulipchat.com)
2017-02-20 13:48:45 +01:00
2017-07-24 17:36:57 +02:00
# Screenshots
See https://github.com/42wim/matterbridge/wiki
2017-02-20 13:48:45 +01:00
# Installing
## Binaries
2018-05-07 22:07:17 +02:00
* Latest stable release [v1.10.0](https://github.com/42wim/matterbridge/releases/latest)
2017-07-16 22:56:26 +02:00
* Development releases (follows master) can be downloaded [here](https://dl.bintray.com/42wim/nightly/)
2015-10-23 23:02:14 +02:00
2017-02-20 13:48:45 +01:00
## Building
2017-11-08 23:22:31 +01:00
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)
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
```
2017-02-20 13:48:45 +01:00
# Configuration
2017-07-10 22:19:51 +02:00
## 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.
2017-07-10 22:19:51 +02:00
## Advanced configuration
* [matterbridge.toml.sample](https://github.com/42wim/matterbridge/blob/master/matterbridge.toml.sample) for documentation and an example.
2017-06-30 01:10:38 +02:00
## Examples
2017-02-20 13:48:45 +01:00
### 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
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)
```
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
2017-02-20 13:48:45 +01:00
## Docker
Create your matterbridge.toml file locally eg in ```/tmp/matterbridge.toml```
```
docker run -ti -v /tmp/matterbridge.toml:/matterbridge.toml 42wim/matterbridge
```
2015-10-23 22:34:37 +02:00
2017-02-20 13:48:45 +01:00
# Changelog
See [changelog.md](https://github.com/42wim/matterbridge/blob/master/changelog.md)
2015-10-23 22:34:37 +02:00
2017-02-20 13:48:45 +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
2017-07-26 22:37:48 +02:00
Want to tip ?
* eth: 0xb3f9b5387c66ad6be892bcb7bbc67862f3abc16f
* btc: 1N7cKHj5SfqBHBzDJ6kad4BzeqUBBS2zhs
2017-02-20 13:48:45 +01:00
# 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
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
2017-02-20 13:48:45 +01:00
* mattermost - https://github.com/mattermost/platform
* matrix - https://github.com/matrix-org/gomatrix
* 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