status-im
/
matterbridge
mirror of https://github.com/status-im/matterbridge.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
bridge between mattermost, IRC, gitter, xmpp, slack, discord, telegram, rocket.chat, steam, twitch, ssh-chat, zulip, whatsapp, keybase and matrix with REST API (mattermost not required!)
1,006 Commits 14 Branches 83 Tags 278 MiB
Go 98.3%
Solidity 1.2%
Dockerfile 0.4%
Shell 0.1%
Go to file
Wim 5af1d80055 Do not panic on non-json response from server (zulip) 2019-02-13 00:29:34 +01:00
.github Update issue templates 2018-05-05 18:04:03 +02:00
bridge Do not panic on non-json response from server (zulip) 2019-02-13 00:29:34 +01:00
ci Bump Go version in Travis CI (#518) 2018-10-12 23:14:36 +02:00
contrib Add api.yaml to contrib 2019-01-09 00:32:04 +01:00
docker/arm Try building arm docker image 2018-12-26 17:27:25 +01:00
gateway Hint at thread replies when messages are unthreaded (slack) (#684) 2019-02-10 17:23:50 +01:00
hook/rockethook Enable gosec linter (#645) 2018-12-06 00:40:55 +01:00
img Replace documentation image 2018-11-18 00:16:49 +00:00
matterclient Add support for mattermost threading (#627) 2019-01-09 21:50:03 +01:00
matterhook Enable gosec linter (#645) 2018-12-06 00:40:55 +01:00
vendor Do not panic on non-json response from server (zulip) 2019-02-13 00:29:34 +01:00
.golangci.yaml Update golangci-lint. Disable hugeParam check for now 2019-02-12 20:30:36 +01:00
.travis.yml Update golangci-lint. Disable hugeParam check for now 2019-02-12 20:30:36 +01:00
Dockerfile Add githash to docker builds 2017-02-17 22:32:42 +01:00
LICENSE Initial commit 2015-10-23 17:07:05 +02:00
README.md Add fbridge to README 2019-02-12 17:21:27 +01:00
changelog.md Release v1.13.1 2019-01-31 17:10:57 +01:00
go.mod Do not panic on non-json response from server (zulip) 2019-02-13 00:29:34 +01:00
go.sum Do not panic on non-json response from server (zulip) 2019-02-13 00:29:34 +01:00
matterbridge.go Bump version 2019-01-31 17:26:07 +01:00
matterbridge.toml.sample Add note about slack/slack-legacy issues on threading. (#634) 2018-12-03 16:50:37 +01:00
matterbridge.toml.simple remove useAPI from sample configuration (#250) 2017-09-04 15:16:29 +02:00

README.md

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 or join the development chat.

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

Download stable Download dev Maintainability Test Coverage

Note: Mattermost isn't required to run matterbridge.

Table of Contents

Features

Natively supported

3rd party via matterbridge api

API

The API is very basic at the moment.
More info and examples on the wiki.

Used by the projects below. Feel free to make a PR to add your project to this list.

Chat with us

Questions or want to test on your favorite platform? Join below:

Screenshots

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

Installing

Binaries

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

Packages

Building

Go 1.9+ 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

Related projects

Articles

Thanks

Digitalocean for sponsoring demo/testing droplets.

Matterbridge wouldn't exist without these libraries: