mirror of https://github.com/42wim/matterbridge.git synced 2024-12-24 04:02:37 +01:00

Wim 1aaa992250 Update acknowledgements

2017-07-09 14:05:17 +02:00

6.2 KiB

Raw Blame History

matterbridge

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

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

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.
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 * Mattermost 3.5.x - 3.10.x * IRC * XMPP * Gitter * Slack * Discord * Telegram * Hipchat * Rocket.chat * Matrix * Steam

Installing

Binaries

Binaries can be found [here] (https://github.com/42wim/matterbridge/releases/) * Latest rc release (with steam support) v0.16.0-rc2 * Latest stable release v0.15.0

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

matterbridge.toml.sample for documentation and an example.
matterbridge.toml.simple for a simple example.

Create a configuration.

See howto for a step by step walkthrough for creating your 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

Copy the matterbridge.toml.sample to matterbridge.toml
Edit matterbridge.toml with the settings for your environment.
Now you can run matterbridge. (./matterbridge)

(Matterbridge will only look for the config file in your current directory, if it isn’t there specify -conf “/path/toyour/matterbridge.toml”)

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

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

6.2 KiB Raw Blame History Unescape Escape