matterbridge travis-ci docker

bridge between mattermost, IRC, gitter, xmpp, slack, discord, telegram, rocket.chat,hipchat (via xmpp) and matrix with REST API

matterbridge

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

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]
[slack.test]
useAPI=true
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

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:

Related Repositories

platform

platform

Open source Slack-alternative in Golang and React - Mattermost ...

platform

platform

Open source Slack-alternative in Golang and React - Mattermost ...

csm

csm

Cisco Syslog to Mattermost - logging cisco IOS changes realtime to mattermost ...

ircmost

ircmost

...

platform

platform

...


Top Contributors

42wim Helcaraxan patcon fdevibe ValdikSS jheiselman yuvallanger markusgraube ryantm ishitatsuyuki alecdwm Aketzu daysofwineandroses 0xbb NetwideRogue fflorent fti7 jorosp janza znz lrstanley mvaleev OyyoDams rreuvekamp saury07 fgrsnau syamgk Thracky anon724 ckartchner

Releases

-   v1.11.3 zip tar
-   v1.11.2 zip tar
-   v1.11.1 zip tar
-   v1.11.0 zip tar
-   v1.10.1 zip tar
-   v1.10.0 zip tar
-   v1.9.1 zip tar
-   v1.9.0 zip tar
-   v1.8.0 zip tar
-   v1.7.1 zip tar
-   v1.7.0 zip tar
-   v1.6.3 zip tar
-   v1.6.2 zip tar
-   v1.6.1 zip tar
-   v1.6.0 zip tar
-   v1.5.1 zip tar
-   v1.5.0 zip tar
-   v1.4.1 zip tar
-   v1.4.0 zip tar
-   v1.3.1 zip tar
-   v1.3.0 zip tar
-   v1.2.0 zip tar
-   v1.1.2 zip tar
-   v1.1.1 zip tar
-   v1.1.0 zip tar
-   v1.0.1 zip tar
-   v1.0.0 zip tar
-   v1.0.0-rc1 zip tar
-   v0.16.3 zip tar
-   v0.16.2 zip tar