bridge between mattermost, IRC, gitter, xmpp, slack, discord, telegram, rocket.chat,hipchat (via xmpp), steam, twitch, ssh-chat, zulip, whatsapp and matrix with REST API (mattermost not required!)
Go to file
Wim 56e7bd01ca
Update dependencies and remove old matterclient lib (#2067)
2023-08-05 20:43:19 +02:00
.github Update to actions v3 (#2009) 2023-03-10 22:29:44 +01:00
bridge Remove gitter bridge (#2035) 2023-04-05 23:39:15 +02:00
contrib Create mumble-autolink.tengo (#2029) 2023-04-03 23:00:54 +02:00
docker/arm Update arm dockerfile to build 1.22.3 fixes #1602 (#1603) 2021-10-16 23:42:00 +02:00
gateway Remove gitter bridge (#2035) 2023-04-05 23:39:15 +02:00
hook/rockethook Fix codeql warnings 2021-12-19 14:39:24 +01:00
img Delete now-unused `img/slack-setup-*.png` files (#1491) 2021-05-25 03:51:52 +01:00
internal move stripCustomoji logic to default Tengo script (#973) 2020-01-09 18:02:53 +01:00
matterclient Update dependencies and remove old matterclient lib (#2067) 2023-08-05 20:43:19 +02:00
matterhook Use upstream slack-go/slack again (#1018) 2020-03-01 20:59:19 +01:00
vendor Update dependencies and remove old matterclient lib (#2067) 2023-08-05 20:43:19 +02:00
version Bump version 2023-01-29 18:57:41 +01:00
.dockerignore Add Dockerimage for tgs conversion (#1211) 2020-08-25 13:15:24 +02:00
.fixmie.yml Create .fixmie.yml 2019-08-26 23:49:06 +02:00
.gitignore Add comments to messages (telegram) (#1652) 2021-12-12 01:40:31 +01:00
.golangci.yaml Update dependencies and go1.18 (#1873) 2022-08-13 16:14:26 +02:00
.goreleaser.yml Add better error handling on Zulip (#1589) 2021-10-23 23:46:27 +02:00
Dockerfile Use Alpine stable again in Dockerfile (#1643) 2021-11-29 01:19:10 +01:00
Dockerfile_whatsappmulti Add Dockerfile_whatsappmulti for building with WhatsApp Multi-Device support (Whatsmeow) (#1774) 2022-03-22 10:05:32 +01:00
LICENSE Initial commit 2015-10-23 17:07:05 +02:00
README.md Remove gitter bridge (#2035) 2023-04-05 23:39:15 +02:00
changelog.md Release v1.26.0 (#1957) 2023-01-29 18:26:52 +01:00
go.mod Update dependencies and remove old matterclient lib (#2067) 2023-08-05 20:43:19 +02:00
go.sum Update dependencies and remove old matterclient lib (#2067) 2023-08-05 20:43:19 +02:00
matterbridge.go Fix typo in logging (#2056) 2023-08-05 20:39:46 +02:00
matterbridge.toml.multi Provide a multi-room multi-bridge example (#1972) 2023-03-09 21:51:11 +01:00
matterbridge.toml.sample Remove gitter bridge (#2035) 2023-04-05 23:39:15 +02:00
matterbridge.toml.simple Rename freenode to libera in simple config (#1870) 2022-08-13 18:51:21 +02:00
tgs.Dockerfile Use Alpine stable again in Dockerfile (#1643) 2021-11-29 01:19:10 +01: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.

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.26.0
  • 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: