3
0
mirror of https://github.com/42wim/matterbridge.git synced 2024-12-21 02:22:34 +01:00
Go to file
2018-12-03 16:50:37 +01:00
.github Update issue templates 2018-05-05 18:04:03 +02:00
bridge Fix multiple channel join regression. Closes 2018-12-03 16:37:12 +01:00
ci Bump Go version in Travis CI () 2018-10-12 23:14:36 +02:00
contrib Add systemd service file () 2017-11-03 20:42:50 +01:00
docker/arm Use cmosh/alpine-arm to build arm docker images () 2018-01-27 13:49:13 +01:00
gateway Tidy up fetching of config values. () 2018-12-01 00:24:07 +01:00
hook/rockethook Fix megacheck / go vet issues 2017-07-14 00:35:01 +02:00
img Replace documentation image 2018-11-18 00:16:49 +00:00
matterclient Refactor matterclient () 2018-11-29 23:53:43 +01:00
matterhook Fix golint linter issues and enable it in CI () 2018-11-15 20:43:43 +01:00
vendor Update nlopes/slack to 4.1-dev () 2018-12-01 19:55:35 +01:00
.travis.yml Clean-up TravisCI config and add test coverage () 2018-12-03 00:07:15 +01:00
changelog.md Update changelog 2018-11-29 00:19:27 +01:00
Dockerfile Add githash to docker builds 2017-02-17 22:32:42 +01:00
go.mod Update nlopes/slack to 4.1-dev () 2018-12-01 19:55:35 +01:00
go.sum Update nlopes/slack to 4.1-dev () 2018-12-01 19:55:35 +01:00
LICENSE Initial commit 2015-10-23 17:07:05 +02:00
matterbridge.go Extract bridgeMap into own package to improve testability () 2018-11-30 23:53:00 +01:00
matterbridge.toml.sample Add note about slack/slack-legacy issues on threading. () 2018-12-03 16:50:37 +01:00
matterbridge.toml.simple remove useAPI from sample configuration () 2017-09-04 15:16:29 +02:00
README.md Bump version 2018-11-29 00:20:09 +01:00

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.

Gitter | IRC | Discord | Matrix | Slack | Mattermost | XMPP | Twitch | Zulip | And more…


Download stable Download dev Maintainability Test Coverage

Note: Mattermost isnt required to run matterbridge.

Table of Contents

Features

API

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

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

Requirements

Accounts to one of the supported bridges * Mattermost 4.x, 5.x * IRC * XMPP * Gitter * Slack * Discord * Telegram * Hipchat * Rocket.chat * Matrix * Steam * Twitch * Ssh-chat * Zulip

Screenshots

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

Installing

Binaries

  • Latest stable release v1.12.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.

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.

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

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

Articles

Thanks

Digitalocean for sponsoring demo/testing droplets.

Matterbridge wouldnt 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 * 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