5
0
mirror of https://github.com/cwinfo/matterbridge.git synced 2024-12-26 15:35:40 +00:00
bridge between mattermost, IRC, gitter, xmpp, slack, discord, telegram, rocket.chat,hipchat (via xmpp), steam, twitch, ssh-chat, zulip, whatsapp and matrix with REST API (mattermost not required!)
Go to file
2018-11-19 21:49:21 +01:00
.github Update issue templates 2018-05-05 18:04:03 +02:00
bridge Add protocol to msg.ID in cache (#596) 2018-11-19 21:28:23 +01:00
ci Bump Go version in Travis CI (#518) 2018-10-12 23:14:36 +02:00
contrib Add systemd service file (#291) 2017-11-03 20:42:50 +01:00
docker/arm Use cmosh/alpine-arm to build arm docker images (#347) 2018-01-27 13:49:13 +01:00
gateway Add protocol to msg.ID in cache (#596) 2018-11-19 21:28:23 +01:00
hook/rockethook Fix megacheck / go vet issues 2017-07-14 00:35:01 +02:00
img Replace documentation image 2018-11-18 00:16:49 +00:00
matterclient Fix golint linter issues and enable it in CI (#593) 2018-11-15 20:43:43 +01:00
matterhook Fix golint linter issues and enable it in CI (#593) 2018-11-15 20:43:43 +01:00
vendor Upgrade logrus / testify to stable versions 2018-11-18 01:10:15 +00:00
.travis.yml Fix golint linter issues and enable it in CI (#593) 2018-11-15 20:43:43 +01:00
changelog.md Release v1.12.0 2018-11-19 21:40:46 +01:00
Dockerfile Add githash to docker builds 2017-02-17 22:32:42 +01:00
go.mod Upgrade logrus / testify to stable versions 2018-11-18 01:10:15 +00:00
go.sum Upgrade logrus / testify to stable versions 2018-11-18 01:10:15 +00:00
LICENSE Initial commit 2015-10-23 17:07:05 +02:00
matterbridge.go Bump version 2018-11-19 21:49:21 +01:00
matterbridge.toml.sample Improve user_typing botname suggestion. (#580) 2018-11-09 21:52:37 +01:00
matterbridge.toml.simple remove useAPI from sample configuration (#250) 2017-09-04 15:16:29 +02:00
README.md Release v1.12.0 2018-11-19 21:40:46 +01:00

matterbridge

Matterbridge Logo
A simple chat bridge
Letting people be where they want to be.
Bridges between a growing number of protocols. Click below to demo.

Gitter | IRC | Discord | Matrix | Slack | Mattermost | XMPP | Twitch | Zulip | And more...


Download stable Download dev Maintainability Test Coverage


Note: Mattermost isn't required to run matterbridge.

Table of Contents

Features

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.

Requirements

Accounts to one of the supported bridges

Screenshots

See https://github.com/42wim/matterbridge/wiki

Installing

Binaries

  • Latest stable release v1.12.0
  • Development releases (follows master) can be downloaded here

Building

Go 1.8+ is required. Make sure you have Go properly installed, including setting up your 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 for a step by step walkthrough for creating your configuration.

Advanced configuration

Examples

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
    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)

[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 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

FAQ

See FAQ

Want to tip ?

  • eth: 0xb3f9b5387c66ad6be892bcb7bbc67862f3abc16f
  • btc: 1N7cKHj5SfqBHBzDJ6kad4BzeqUBBS2zhs

Articles

Thanks

Digitalocean for sponsoring demo/testing droplets.

Matterbridge wouldn't exist without these libraries: