Upstream: github.com/42wim/matterbridge
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.
 
 
PapaTutuWawa ca7866b8fa Implement Discord Emotes on XMPP 1 month ago
.github Create codeql-analysis.yml 3 months ago
bridge Implement Discord Emotes on XMPP 1 month ago
contrib Create outmessage-discordemoji.tengo (#979) 11 months ago
docker/arm Try building arm docker image 2 years ago
gateway Allow tengo to drop messages using msgDrop (#1272) 3 months ago
hook/rockethook Enable gosec linter (#645) 2 years ago
img Replace documentation image 2 years ago
internal move stripCustomoji logic to default Tengo script (#973) 1 year ago
matterclient Use mattermost v5 module (#1192) 5 months ago
matterhook Use upstream slack-go/slack again (#1018) 10 months ago
vendor Update vendor (#1265) 3 months ago
.dockerignore Add Dockerimage for tgs conversion (#1211) 4 months ago
.fixmie.yml Create .fixmie.yml 1 year ago
.gitignore Re-add binary to .gitignore (#951) 1 year ago
.golangci.yaml Update linter config 5 months ago
.goreleaser.yml Fix deprecation in goreleaser 1 year ago
Dockerfile Use alpine stable for docker 4 months ago
LICENSE Initial commit 5 years ago
README.md Update slack invite 2 months ago
changelog.md Release v1.19.0 (#1268) 3 months ago
go.mod Implement Discord Emotes on XMPP 1 month ago
go.sum Implement Discord Emotes on XMPP 1 month ago
matterbridge.go Bump version 3 months ago
matterbridge.toml.sample Add NoTLS option to allow plaintext XMPP connections (#1288) 2 months ago
matterbridge.toml.simple remove useAPI from sample configuration (#250) 3 years ago
tgs.Dockerfile Use alpine stable for docker 4 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.19.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 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}> "

[[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

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

Changelog

See changelog.md

FAQ

See FAQ

Articles

Thanks

This project is supported by:

Matterbridge wouldn't exist without these libraries: