Skip to content
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!)
Go Other
  1. Go 99.0%
  2. Other 1.0%
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update issue templates May 5, 2018
bridge Specify correct GuildID on unknown user query (discord). Fixes #879 (#… Sep 15, 2019
ci Update dependencies (#886) Sep 7, 2019
contrib Add tengo example for nick color filter. See #881 Sep 7, 2019
docker/arm Try building arm docker image Dec 26, 2018
gateway Do configuration validation on start-up. Fixes #888 (#889) Sep 9, 2019
hook/rockethook Enable gosec linter (#645) Dec 5, 2018
img Replace documentation image Nov 18, 2018
internal Add scripting (tengo) support for every outgoing message (#806) Apr 19, 2019
matterclient Make getChannelIdTeam behave like GetChannelId for groups (mattermost) ( Sep 7, 2019
matterhook Enable gosec linter (#645) Dec 5, 2018
vendor Update dependencies (#886) Sep 7, 2019
.fixmie.yml Create .fixmie.yml Aug 26, 2019
.gitignore Add .gitignore (#850) Jun 16, 2019
.golangci.yaml Add CI fixes and improvements (#780) Apr 4, 2019
.goreleaser.yml Fix deprecation in goreleaser Sep 7, 2019
.travis.yml Update to golanci-lint v1.17.1 Jun 30, 2019
Dockerfile Add githash to docker builds Feb 17, 2017
LICENSE Initial commit Oct 23, 2015
README.md Release v1.16.0 Sep 7, 2019
changelog.md Bump version and fix changelog Sep 7, 2019
go.mod Update dependencies (#886) Sep 7, 2019
go.sum Update dependencies (#886) Sep 7, 2019
matterbridge.go Bump version and fix changelog Sep 7, 2019
matterbridge.toml.sample Add token support (RocketChat) (#892) Sep 13, 2019
matterbridge.toml.simple remove useAPI from sample configuration (#250) Sep 4, 2017

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 | Keybase | 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 / upgrading

Binaries

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

To install or upgrade just download the latest binary and follow the instructions on the howto for a step by step walkthrough for creating your configuration.

Packages

Building

Most people just want to use binaries, you can find those here

If you really want to build from source, follow these instructions: 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:

You can’t perform that action at this time.