0

matterbridge

bridge between mattermost, IRC, gitter, xmpp, slack, discord, telegram, rocket.chat,hipchat (via xmpp), steam, twitch, ssh-chat, zulip and matrix with REST API (mattermost not required!)

Github repo
Main metrics

Github stars Tracking Chart

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.5
  • 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.12+ is required. Make sure you have Go properly installed.

go get github.com/42wim/matterbridge

You should now have matterbridge binary in the ~/go/bin directory:

$ ls ~/go/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}> "


name="mygateway"
enable=true
    
    account="irc.freenode"
    channel="#testing"

    
    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}> "


    name = "mygateway"
    enable=true

    
    account = "discord.test"
    channel="general"

    
    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

Please take a look at the Docker Wiki page for more information.

Changelog

See changelog.md

FAQ

See FAQ

Articles

Thanks

Matterbridge wouldn't exist without these libraries:

Overview

Name With Owner42wim/matterbridge
Primary LanguageGo
Program languageGo (Language Count: 3)
Platform
License:Apache License 2.0
Release Count116
Last Release Namev1.26.0 (Posted on )
First Release Namev0.1 (Posted on )
Created At2015-10-23 15:07:05
Pushed At2024-04-27 23:29:09
Last Commit At2023-08-05 20:43:19
Stargazers Count6.3k
Watchers Count113
Fork Count590
Commits Count1.7k
Has Issues Enabled
Issues Count1306
Issue Open Count250
Pull Requests Count625
Pull Requests Open Count34
Pull Requests Close Count82
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private
To the top