42wim/matterbridge 42wim/matterbridge

  • Stars
    star
    6,030
  • Rank 6,675 (Top 0.2 %)
  • Language
    Go
  • License
    Apache License 2.0
  • Created about 9 years ago
  • Updated about 1 year ago
Twitter logo Share LinkedIn logo Share Facebook logo Share
42wim/matterbridge
github

42wim

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

bridge between mattermost, IRC, gitter, xmpp, slack, discord, telegram, rocketchat, twitch, ssh-chat, zulip, whatsapp, keybase, matrix, microsoft teams, nextcloud, mumble, vk and more with REST API (mattermost not required!)

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

Related projects

Articles / Tutorials

Thanks

This project is supported by:

Matterbridge wouldn't exist without these libraries:

More Repositories

1

dt

DNS tool - display information about your domain
Go
352
star
2

matterircd

Connect to your mattermost or slack using your IRC-client of choice.
Go
284
star
3

caddy-gitea

Github pages (and more) for gitea using caddy
Go
105
star
4

gomphs

A tool to ping multiple hosts at once with a CLI and web-based overview
Go
71
star
5

nomadctld

ssh server with ability to exec/attach/logs/tail/stop/restart hashicorp nomad containers
Go
67
star
6

matterstuff

Various tools for mattermost
Shell
57
star
7

cssh

Tool to connect to / automate (via ssh only) Cisco switches and accesspoints
Go
39
star
8

rl

Rate limit from stdin to stdout (drop or keep messages)
Go
37
star
9

cost

bitcoin, litecoin, ethereum, altcoin address (pubkey/privkey) generator
Go
22
star
10

vault-plugin-auth-ssh

A Vault plugin to allow authentication via SSH certificates and public keys
Go
20
star
11

asallow

whitelist providers and/or countries using ipset, iptables and ripe data
Go
19
star
12

matterbridge-plus

bridge between mattermost and IRC (using mattermost API instead of webhooks)
Go
11
star
13

bm

bookmark tool inspired by saved.io
Go
11
star
14

ipsetd

ipset daemon (for fast remote ipset manipulation, runs ipset in interactive mode)
Go
10
star
15

ssh-agentx

Extended ssh-agent which supports git commit signing and yubikey signing over ssh
Go
10
star
16

scoop-bucket

Personal scoop bucket. Support for chrome and ms edge.
PowerShell
10
star
17

ulog2queue

Sends ulogd / netfilter json to elasticsearch backend (logstash replacement for your firewall)
Go
9
star
18

teamscli

control microsoft teams from cli, currently only for presence changes and status message updates (needs a working teams app installed)
Go
9
star
19

dhcprelay

simple dhcp relay in go. Ability to bind to a specific outgoing IP
Go
8
star
20

caddy-saml

saml plugin for caddy
Go
8
star
21

isc-dhcp

https://source.isc.org/git/dhcp.git mirror with own patch(es)
C
6
star
22

sshsig

Go library to create/verify armored SSH signatures (https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.sshsig)
Go
5
star
23

csm

Cisco Syslog to Mattermost - logging cisco IOS changes realtime to mattermost
Go
5
star
24

vshare

Share easily read-once and time-limited secrets, configurations or small files with your coworkers or customers.
Go
5
star
25

vim-shfmt

vim plugin for shfmt
Vim Script
5
star
26

nomadgen

Generate nomad plan (hcl) from toml config
Go
4
star
27

plugctl

Smartplug Maginon controller
Go
4
star
28

gomul

Joins multicast ipv4/ipv6 groups on specified interface (used for debugging multicast issues)
Go
3
star
29

docker-netdot_deploy

Shell
3
star
30

sagent

windows ssh agent, implements pageant and supports age ssh decryption
Go
3
star
31

regtag

Tags docker images directly on a remote docker registry without pulling/pushing them first
Go
3
star
32

dotfiles

2
star
33

chromeupdates

Shell
2
star
34

mattermost-dev-docker

Shell
2
star
35

docker-netdot

Shell
2
star
36

minidiary2memoires

1
star
37

registrator-work

Go
1
star
38

rpms

1
star
39

til

Today I learned
1
star
40

winlocked

Very simple library to check if your windows desktop is locked
Go
1
star
41

edgeupdate-provision

Finds latest Microsoft Edge releases and links to full downloads
Rust
1
star
42

snmp-info

snmp-info follows sf.net
Perl
1
star
43

registrator-netfilter

ipv6 firewall (netfilter) module for registrator (https://github.com/gliderlabs/registrator/)
Go
1
star
44

Scoop-core

PowerShell
1
star
45

wptvscraper

Perl
1
star
46

matterclient

Go
1
star
47

edgeupdates

1
star