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

Remi Reuvekamp 33bd60528b Add config option MediaDownloadPath (#443 ) * Add config option MediaUploadPath MediaDownloadPath can be used instead of MediaServerUpload, for when your webserver is on the same system as matterbridge and matterbridge has write access to the serve dir. * Limit length of hash in MediaServer urls to 8chars Full SHA256 is unnecessary for uniqueness. Also; if a file has the same first 8 charachters of the SHA256 hash, it's still not a problem, as long as the filename is not the same.		2018-06-08 22:30:35 +02:00
.github	Update issue templates	2018-05-05 18:04:03 +02:00
bridge	Add config option MediaDownloadPath (#443 )	2018-06-08 22:30:35 +02:00
ci	Update travis to go 1.10	2018-02-23 00:56:43 +01:00
contrib	Add systemd service file (#291 )	2017-11-03 20:42:50 +01:00
docker/arm	Use cmosh/alpine-arm to build arm docker images (#347 )	2018-01-27 13:49:13 +01:00
gateway	Add config option MediaDownloadPath (#443 )	2018-06-08 22:30:35 +02:00
hook/rockethook	Fix megacheck / go vet issues	2017-07-14 00:35:01 +02:00
img	Add image to repo. Make more clear that mattermost is not required to run matterbridge	2018-04-25 22:20:06 +02:00
matterclient	Update GetFileLinks to API_V4	2018-04-21 20:49:44 +02:00
matterhook	Add slack attachment support to matterhook	2018-02-23 00:48:25 +01:00
vendor	Update vendor matterbridge/go-xmpp	2018-05-29 23:28:19 +02:00
.travis.yml	Fix bintray build	2018-03-17 23:13:27 +01: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	Release v1.10.1	2018-05-27 22:45:37 +02:00
changelog.md	Update changelog	2018-05-27 23:02:32 +02:00
matterbridge.go	Add config option MediaDownloadPath (#443 )	2018-06-08 22:30:35 +02:00
matterbridge.toml.sample	Add config option MediaDownloadPath (#443 )	2018-06-08 22:30:35 +02:00
matterbridge.toml.simple	remove useAPI from sample configuration (#250 )	2017-09-04 15:16:29 +02:00

README.md

matterbridge

Click on one of the badges below to join the chat

Simple bridge between IRC, XMPP, Gitter, Mattermost, Slack, Discord, Telegram, Rocket.Chat, Hipchat(via xmpp), Matrix, Steam, ssh-chat and Zulip Has a REST API.
Minecraft server chat support via MatterLink

Mattermost isn't required to run matterbridge. It bridges between any supported protocol.
(The name matterbridge is a remnant when it was only bridging mattermost)

Features
Requirements
Screenshots
Installing
- Binaries
- Building
Configuration
- Howto
- Examples
Running
- Docker
Changelog
FAQ
Thanks

Features

API

The API is very basic at the moment and rather undocumented.

Used by at least 2 projects. Feel free to make a PR to add your project to this list.

MatterLink (Matterbridge link for Minecraft Server chat)
pyCord (crossplatform chatbot)

Requirements

Accounts to one of the supported bridges

Screenshots

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

Installing

Binaries

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

Building

Go 1.8+ is required. Make sure you have Go properly installed, including setting up your [GOPATH] (https://golang.org/doc/code.html#GOPATH)

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.

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

Want to tip ?

eth: 0xb3f9b5387c66ad6be892bcb7bbc67862f3abc16f
btc: 1N7cKHj5SfqBHBzDJ6kad4BzeqUBBS2zhs

Thanks

for sponsoring demo/testing droplets.

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/platform
matrix - https://github.com/matrix-org/gomatrix
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
zulip - https://github.com/ifo/gozulipbot