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,114 Commits 14 Branches 83 Tags 278 MiB
Go 98.3%
Solidity 1.2%
Dockerfile 0.4%
Shell 0.1%
Go to file
Duco van Amstel b79bf7d414 Forward only user-typing messages if supported by protocol (#832) 
Fixes issue #814.

This is a somewhat hacky way of achieving the required goal but it seems
like this is the least problematic way of getting there.

We might want to redesign some bridge information later such that we
have a standardised way of specifying what is and what isn't supported
by each chat protocol / bridge.
 		2019-05-30 15:00:40 +02:00
.github Update issue templates 2018-05-05 18:04:03 +02:00
bridge Clean-up XMPP handling code (#831) 2019-05-30 12:31:54 +02:00
ci Add CI fixes and improvements (#780) 2019-04-04 22:54:51 +02:00
contrib Add scripting (tengo) support for every outgoing message (#806) 2019-04-19 18:27:31 +02:00
docker/arm Try building arm docker image 2018-12-26 17:27:25 +01:00
gateway Forward only user-typing messages if supported by protocol (#832) 2019-05-30 15:00:40 +02: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
internal Add scripting (tengo) support for every outgoing message (#806) 2019-04-19 18:27:31 +02:00
matterclient Linter fixes 2019-05-27 17:38:31 +01:00
matterhook Enable gosec linter (#645) 2018-12-06 00:40:55 +01:00
vendor Use upstream whatsapp again (#809) 2019-05-30 12:20:56 +02:00
.golangci.yaml Add CI fixes and improvements (#780) 2019-04-04 22:54:51 +02:00
.goreleaser.yml Add goreleaser.yml 2019-02-24 01:09:53 +01:00
.travis.yml Build on every branch (travis) 2019-04-07 23:57:47 +02: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 Update README with v1.14.4 2019-04-23 23:36:30 +02:00
changelog.md Update changelog 2019-04-23 23:35:48 +02:00
go.mod Use upstream whatsapp again (#809) 2019-05-30 12:20:56 +02:00
go.sum Use upstream whatsapp again (#809) 2019-05-30 12:20:56 +02:00
matterbridge.go Bump version 2019-04-19 18:24:13 +02:00
matterbridge.toml.sample Add msg event to tengo 2019-04-24 22:47:37 +02: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 | WhatsApp | Zulip | Telegram | 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 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.14.4
  • 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.

Settings

All possible settings for each bridge.

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

Related projects

Articles

Thanks

This project is supported by:

Matterbridge wouldn't exist without these libraries: