2
0
mirror of https://github.com/42wim/matterbridge synced 2024-11-19 03:25:33 +00:00
Go to file
2017-09-19 22:33:26 +02:00
.github Update issue template 2017-07-08 12:25:52 +02:00
bridge Try to not forward slack unfurls. Closes #266 2017-09-19 22:33:26 +02:00
ci Add darwin-amd64 to nightly builds 2017-09-09 14:42:45 +02:00
gateway Relay attachments from mattermost to slack (slack). Closes #260 2017-09-18 23:51:27 +02:00
hook/rockethook Fix megacheck / go vet issues 2017-07-14 00:35:01 +02:00
matterclient Allow empty message if we have a slack attachment 2017-09-18 23:44:16 +02:00
matterhook Add props 2017-09-18 23:43:21 +02:00
vendor Update vendor (nlopes/slack) 2017-09-11 23:33:58 +02:00
.travis.yml Update travis to go 1.9 2017-08-29 20:34:32 +02:00
changelog.md Release v1.2.0 2017-09-11 23:41:13 +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
matterbridge.go Bump version 2017-09-18 21:18:59 +02:00
matterbridge.toml.sample remove comment about useAPI in sample configuration (#251) 2017-09-04 15:16:58 +02:00
matterbridge.toml.simple remove useAPI from sample configuration (#250) 2017-09-04 15:16:29 +02:00
README.md Update readme 2017-09-11 23:49:15 +02:00

matterbridge

Click on one of the badges below to join the chat

Gitter Join the IRC chat at https://webchat.freenode.net/?channels=matterbridgechat Discord Matrix Slack Mattermost Xmpp

Download stable Download dev

matterbridge.gif

Simple bridge between Mattermost, IRC, XMPP, Gitter, Slack, Discord, Telegram, Rocket.Chat, Hipchat(via xmpp), Matrix and Steam. Has a REST API.

Table of Contents

Features

  • Relays public channel messages between multiple mattermost, IRC, XMPP, Gitter, Slack, Discord, Telegram, Rocket.Chat, Hipchat (via xmpp), Matrix and Steam. Pick and mix.
  • Support private groups on your mattermost/slack.
  • Allow for bridging the same bridges, which means you can eg bridge between multiple mattermosts.
  • The bridge is now a gateway which has support multiple in and out bridges. (and supports multiple gateways).
  • Edits and delete messages across bridges that support it (mattermost,slack,discord,gitter,telegram)
  • REST API to read/post messages to bridges (WIP).

Requirements

Accounts to one of the supported bridges

Screenshots

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

Installing

Binaries

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

Building

Go 1.7+ 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

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

Matterbridge wouldn't exist without these libraries: