Archives/matterbridge
2
0
Fork 0
mirror of https://github.com/42wim/matterbridge synced 2024-11-09 07:10:25 +00:00
Code Issues Projects Releases Wiki Activity
259 Commits 6 Branches 116 Tags 268 MiB
Go 99.4%
Dockerfile 0.5%
Shell 0.1%
84c0b745af
Go to file
Wim 84c0b745af Use roomalias instead of internal ID (matrix)
2017-02-24 17:58:51 +01:00
.github Create ISSUE_TEMPLATE.md 2016-11-23 20:22:27 +01:00
bridge Use roomalias instead of internal ID (matrix) 2017-02-24 17:58:51 +01:00
gateway Add REST API support 2017-02-18 23:13:46 +01:00
hook/rockethook Add initial Rocket.Chat support 2016-12-03 00:10:29 +01:00
matterclient Set http timeout to 10 seconds 2017-02-17 17:51:07 +01:00
matterhook Add ReadTimeout to close lingering connections (mattermost). See #125 2017-02-21 22:13:34 +01:00
vendor Add matrix support 2017-02-20 00:50:37 +01:00
changelog.md Add matrix support 2017-02-20 00:50:37 +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
matterbridge.go Add matrix support 2017-02-20 00:50:37 +01:00
matterbridge.toml.sample Use roomalias instead of internal ID (matrix) 2017-02-24 17:58:51 +01:00
matterbridge.toml.simple Release v0.9.0 2016-12-01 22:15:40 +01:00
migration.md Add migration info 2016-07-12 01:23:36 +02:00
README-0.6.md Update documentation 2016-09-18 21:04:28 +02:00
README.md Update README 2017-02-20 13:48:45 +01:00

README.md

matterbridge

matterbridge.gif

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

Table of Contents

Features

  • Relays public channel messages between multiple mattermost, IRC, XMPP, Gitter, Slack, Discord, Telegram, Rocket.Chat, Hipchat (via xmpp) and Matrix. Pick and mix.
  • Matterbridge can also work with 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).
  • REST API to read/post messages to bridges (WIP).

Requirements

Accounts to one of the supported bridges

Installing

Binaries

Binaries can be found [here] (https://github.com/42wim/matterbridge/releases/)

Building

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

Examples

Bridge mattermost (off-topic) - irc (#testing)

[irc]
    [irc.freenode]
    Server="irc.freenode.net:6667"
    Nick="yourbotname"

[mattermost]
    [mattermost.work]
    useAPI=true
    Server="yourmattermostserver.tld"
    Team="yourteam"
    Login="yourlogin"
    Password="yourpass"
    PrefixMessagesWithNick=true

[[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.test]
Token="yourslacktoken"
PrefixMessagesWithNick=true

[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

  1. Copy the matterbridge.toml.sample to matterbridge.toml in the same directory as the matterbridge binary.
  2. Edit matterbridge.toml with the settings for your environment.
  3. Now you can run matterbridge. (./matterbridge)
Usage of ./matterbridge:
  -conf string
        config file (default "matterbridge.toml")
  -debug
        enable debug
  -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

Please look at matterbridge.toml.sample for more information first.

Mattermost doesn't show the IRC nicks

If you're running the webhooks version, this can be fixed by either:

  • enabling "override usernames". See mattermost documentation
  • setting PrefixMessagesWithNick to true in mattermost section of your matterbridge.toml.

If you're running the API version you'll need to:

  • setting PrefixMessagesWithNick to true in mattermost section of your matterbridge.toml.

Also look at the RemoteNickFormat setting.

Thanks

Matterbridge wouldn't exist without these libraries: