You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Glandos 0482cd191d
Rename freenode to libera in simple config (#1870)
6 days ago
.github Update dependencies and go1.18 (#1873) 7 days ago
bridge Fix message html entities escaping when sending to Telegram (#1855) 1 month ago
contrib Create inmessage-logger.tengo (#1688) (#1747) 5 months ago
docker/arm Update arm dockerfile to build 1.22.3 fixes #1602 (#1603) 10 months ago
gateway Ignore sending file with comment, if comment contains IgnoreMessages value (#1783) 5 months ago
hook/rockethook Fix codeql warnings 8 months ago
img Delete now-unused `img/slack-setup-*.png` files (#1491) 1 year ago
internal move stripCustomoji logic to default Tengo script (#973) 3 years ago
matterclient Do not check cache on deleted messages (mattermost). Fixes #1555 (#1624) 10 months ago
matterhook Use upstream slack-go/slack again (#1018) 3 years ago
vendor Update dependencies and go1.18 (#1873) 7 days ago
version Bump version 2 months ago
.dockerignore Add Dockerimage for tgs conversion (#1211) 2 years ago
.fixmie.yml Create .fixmie.yml 3 years ago
.gitignore Add comments to messages (telegram) (#1652) 8 months ago
.golangci.yaml Update dependencies and go1.18 (#1873) 7 days ago
.goreleaser.yml Add better error handling on Zulip (#1589) 10 months ago
Dockerfile Use Alpine stable again in Dockerfile (#1643) 9 months ago
Dockerfile_whatsappmulti Add Dockerfile_whatsappmulti for building with WhatsApp Multi-Device support (Whatsmeow) (#1774) 5 months ago
LICENSE Initial commit 7 years ago
README.md Update dependencies and go1.18 (#1873) 7 days ago
changelog.md Release v1.25.2 (#1853) 2 months ago
go.mod Update dependencies and go1.18 (#1873) 7 days ago
go.sum Update dependencies and go1.18 (#1873) 7 days ago
matterbridge.go Add better error handling on Zulip (#1589) 10 months ago
matterbridge.toml.sample Ignore events from other guilds, add nosendjoinpart support (discord) (#1846) 2 months ago
matterbridge.toml.simple Rename freenode to libera in simple config (#1870) 6 days ago
tgs.Dockerfile Use Alpine stable again in Dockerfile (#1643) 9 months ago

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.

Discord | Gitter | IRC | Keybase | Matrix | Mattermost | MSTeams | Rocket.Chat | Slack | Telegram | Twitch | WhatsApp | XMPP | Zulip | And more...


Download stable 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.25.2
  • Development releases (follows master) can be downloaded here selecting the latest green build and then artifacts.

To install or upgrade just download the latest binary. On *nix platforms you may need to make the binary executable - you can do this by running chmod a+x on the binary (example: chmod a+x matterbridge-1.24.1-linux-64bit). After downloading (and making the binary executable, if necessary), 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.18+ is required. Make sure you have Go properly installed.

Building the binary with all the bridges enabled needs about 3GB RAM to compile. You can reduce this memory requirement to 0,5GB RAM by adding the nomsteams tag if you don't need/use the Microsoft Teams bridge.

Matterbridge can be build without gcc/c-compiler: If you're running on windows first run set CGO_ENABLED=0 on other platforms you prepend CGO_ENABLED=0 to the go build command. (eg CGO_ENABLED=0 go install github.com/42wim/matterbridge)

To install the latest stable run:

go install github.com/42wim/matterbridge

To install the latest dev run:

go install github.com/42wim/matterbridge@master

To install the latest stable run without msteams or zulip bridge:

go install -tags nomsteams,nozulip github.com/42wim/matterbridge

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

$ ls ~/go/bin/
matterbridge

Building with whatsapp (beta) multidevice support

Because the library we use for Whatsapp multidevice support includes a GPL3 library we can not provide you binaries. (as this would require the Matterbridge to change it license to GPL)

Matterbridge can be build without gcc/c-compiler: If you're running on windows first run set CGO_ENABLED=0 on other platforms you prepend CGO_ENABLED=0 to the go build command. (eg CGO_ENABLED=0 go install github.com/42wim/matterbridge)

So this means you have to build it yourself using the instructions below:

go install -tags whatsappmulti github.com/42wim/matterbridge@master

If you're low on memory and don't need msteams:

go install -tags nomsteams,whatsappmulti github.com/42wim/matterbridge@master

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.libera]
    Server="irc.libera.chat: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.libera"
    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

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

Systemd

Please take a look at the Service Files page for more information.

Changelog

See changelog.md

FAQ

See FAQ

Articles / Tutorials

Thanks

This project is supported by:

Matterbridge wouldn't exist without these libraries: