bridge between mattermost, IRC, gitter, xmpp, slack, discord, telegram, rocket.chat, steam, twitch, ssh-chat, zulip, whatsapp, keybase and matrix with REST API (mattermost not required!)

Go to file

cori hudson 921f2dfcdf Add initial Keybase Chat support (#877 ) * initial work on native keybase bridging * Hopefully make a functional keybase bridge * add keybase to bridgemap * send to right channel, try to figure out received msgs * add account and userid * i am a Dam Fool * Fix formatting for messages, handle /me * update vendors, ran golint and goimports * move handlers to handlers.go, clean up unused config options * add sample config, fix inconsistent remote nick handling * Update readme with keybase links * Resolve fixmie errors * Error -> Errorf * fix linting errors in go.mod and go.sum * explicitly join channels, ignore messages from non-specified channels * check that team names match before bridging message		2019-08-26 21:00:31 +02:00
.github	Update issue templates	2018-05-05 18:04:03 +02:00
bridge	Add initial Keybase Chat support (#877 )	2019-08-26 21:00:31 +02:00
ci	Add CI fixes and improvements (#780 )	2019-04-04 22:54:51 +02:00
contrib	Add scripting (tengo) support for every outgoing message (#806 )	2019-04-19 18:27:31 +02:00
docker/arm	Try building arm docker image	2018-12-26 17:27:25 +01:00
gateway	Add initial Keybase Chat support (#877 )	2019-08-26 21:00:31 +02:00
hook/rockethook	Enable gosec linter (#645 )	2018-12-06 00:40:55 +01:00
img	Replace documentation image	2018-11-18 00:16:49 +00:00
internal	Add scripting (tengo) support for every outgoing message (#806 )	2019-04-19 18:27:31 +02:00
matterclient	Add an option to skip the Mattermost server version check (#849 )	2019-06-16 16:23:50 +02:00
matterhook	Enable gosec linter (#645 )	2018-12-06 00:40:55 +01:00
vendor	Add initial Keybase Chat support (#877 )	2019-08-26 21:00:31 +02:00
.gitignore	Add .gitignore (#850 )	2019-06-16 16:37:38 +02:00
.golangci.yaml	Add CI fixes and improvements (#780 )	2019-04-04 22:54:51 +02:00
.goreleaser.yml	Add goreleaser.yml	2019-02-24 01:09:53 +01:00
.travis.yml	Update to golanci-lint v1.17.1	2019-06-30 18:43:54 +02:00
Dockerfile	Add githash to docker builds	2017-02-17 22:32:42 +01:00
LICENSE	Initial commit	2015-10-23 17:07:05 +02:00
README.md	Add initial Keybase Chat support (#877 )	2019-08-26 21:00:31 +02:00
changelog.md	Bump version	2019-07-15 23:23:32 +02:00
go.mod	Add initial Keybase Chat support (#877 )	2019-08-26 21:00:31 +02:00
go.sum	Add initial Keybase Chat support (#877 )	2019-08-26 21:00:31 +02:00
matterbridge.go	Bump version	2019-07-15 23:23:32 +02:00
matterbridge.toml.sample	Add initial Keybase Chat support (#877 )	2019-08-26 21:00:31 +02:00
matterbridge.toml.simple	remove useAPI from sample configuration (#250 )	2017-09-04 15:16:29 +02:00

README.md

matterbridge

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.}

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

^{Note: Mattermost isn't required to run matterbridge.}

Features
Chat with us
Screenshots
Installing/upgrading
- Binaries
Building
Configuration
- Howto
- Settings
- Examples
Running
- Docker
Changelog
FAQ
Related projects
Articles
Thanks

Features

Support bridging between any protocols
Support multiple gateways(bridges) for your protocols
Message edits and deletes
Preserves threading when possible
Attachment / files handling
Username and avatar spoofing
Private groups
API

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.

MatterLink (Matterbridge link for Minecraft Server chat)
pyCord (crossplatform chatbot)
Mattereddit (Reddit chat support)
fbridge (Facebook messenger support)
matterbabble (Discourse support)

Chat with us

Questions or want to test on your favorite platform? Join below:

Gitter
IRC
Discord
Matrix
Slack
Mattermost
Rocket.Chat
XMPP (matterbridge@conference.jabber.de)
Twitch
Zulip
Telegram

Screenshots

See https://github.com/42wim/matterbridge/wiki

Installing / upgrading

Binaries

Latest stable release v1.15.1
Development releases (follows master) can be downloaded here

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

Overview

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.9+ is required. Make sure you have Go properly installed, including setting up your GOPATH.

After Go is setup, download matterbridge to your $GOPATH directory.

cd $GOPATH
go get github.com/42wim/matterbridge

You should now have matterbridge binary in the bin directory:

$ ls 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

matterbridge.toml.sample for documentation and an example.

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

Create your matterbridge.toml file locally eg in /tmp/matterbridge.toml

docker run -ti -v /tmp/matterbridge.toml:/matterbridge.toml 42wim/matterbridge

Changelog

See changelog.md

FAQ

See FAQ

FOSSRIT/infrastructure - roles/matterbridge (Ansible role used to automate deployments of Matterbridge)
matterbridge autoconfig
matterbridge config viewer
matterbridge-heroku
mattereddit
matterlink
mattermost-plugin - Run matterbridge as a plugin in mattermost
pyCord (crossplatform chatbot)
fbridge (Facebook messenger support)
isla (Bot for Discord-Telegram groups used alongside matterbridge)
matterbabble (Connect Discourse threads to Matterbridge)

Articles

Thanks

This project is supported by:

Matterbridge wouldn't exist without these libraries:

discord - https://github.com/bwmarrin/discordgo
echo - https://github.com/labstack/echo
gitter - https://github.com/sromku/go-gitter
gops - https://github.com/google/gops
gozulipbot - https://github.com/ifo/gozulipbot
irc - https://github.com/lrstanley/girc
mattermost - https://github.com/mattermost/mattermost-server
matrix - https://github.com/matrix-org/gomatrix
sshchat - https://github.com/shazow/ssh-chat
slack - https://github.com/nlopes/slack
steam - https://github.com/Philipp15b/go-steam
telegram - https://github.com/go-telegram-bot-api/telegram-bot-api
xmpp - https://github.com/mattn/go-xmpp
whatsapp - https://github.com/Rhymen/go-whatsapp/
zulip - https://github.com/ifo/gozulipbot
tengo - https://github.com/d5/tengo
keybase - https://github.com/keybase/go-keybase-chat-bot