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.
 
 
Wim 831ff6d0a9
Update matterclient dep. Fixes #1617
1 day ago
.github Update matterclient dep. Fixes #1617 1 day ago
bridge Add UserName and RealName options for IRC (#1590) 6 days ago
contrib Create outmessage-discordemoji.tengo (#979) 2 years ago
docker/arm Update arm dockerfile to build 1.22.3 fixes #1602 (#1603) 6 days ago
gateway Update vendor (#1446) 7 months ago
hook/rockethook Enable gosec linter (#645) 3 years ago
img Improve README formatting (incl codeclimate badges) (#578) 3 years ago
internal move stripCustomoji logic to default Tengo script (#973) 2 years ago
matterclient Update dependencies (#1610) 6 days ago
matterhook Use upstream slack-go/slack again (#1018) 2 years ago
vendor Update matterclient dep. Fixes #1617 1 day ago
.dockerignore Add Dockerimage for tgs conversion (#1211) 1 year ago
.fixmie.yml Create .fixmie.yml 2 years ago
.gitignore Re-add binary to .gitignore (#951) 2 years ago
.golangci.yaml Disable exhaustivestruct linter 6 days ago
.goreleaser.yml Update .goreleaser.yml 4 months ago
Dockerfile Fix docker build 5 days ago
LICENSE Initial commit 6 years ago
README.md Release v1.23.0 (#1615) 5 days ago
changelog.md Release v1.23.0 (#1615) 5 days ago
go.mod Update matterclient dep. Fixes #1617 1 day ago
go.sum Update matterclient dep. Fixes #1617 1 day ago
matterbridge.go Bump version 4 days ago
matterbridge.toml.sample Add UserName and RealName options for IRC (#1590) 6 days ago
matterbridge.toml.simple remove useAPI from sample configuration (#250) 4 years ago
tgs.Dockerfile Add libwebp-dev to tgs.Dockerfile fixes Telegram sticker to WebP rendering (#1476) 5 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.23.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.20.0-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.17+ is required. Make sure you have Go properly installed.

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

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: