cwinfo/matterbridge
5
0
Fork 0
mirror of https://github.com/cwinfo/matterbridge.git synced 2024-11-09 16:50:30 +00:00
Code Releases Activity
bridge between mattermost, IRC, gitter, xmpp, slack, discord, telegram, rocket.chat,hipchat (via xmpp), steam, twitch, ssh-chat, zulip, whatsapp and matrix with REST API (mattermost not required!)
756 Commits 2 Branches 81 Tags 75 MiB
Go 99.4%
Dockerfile 0.5%
Shell 0.1%
96a47a60ad
Go to file
Wim 96a47a60ad Add support for reloading all settings automatically after changing config except connection and gateway configuration. Closes #373
2018-05-01 22:23:37 +02:00
.github Update issue template 2018-02-15 22:35:29 +01:00
bridge Add support for reloading all settings automatically after changing config except connection and gateway configuration. Closes #373 2018-05-01 22:23:37 +02:00
ci Update travis to go 1.10 2018-02-23 00:56:43 +01:00
contrib Add systemd service file (#291) 2017-11-03 20:42:50 +01:00
docker/arm Use cmosh/alpine-arm to build arm docker images (#347) 2018-01-27 13:49:13 +01:00
gateway Fix regression on empty text with files attached 2018-03-06 21:30:59 +01:00
hook/rockethook Fix megacheck / go vet issues 2017-07-14 00:35:01 +02:00
img Add image to repo. Make more clear that mattermost is not required to run matterbridge 2018-04-25 22:20:06 +02:00
matterclient Update GetFileLinks to API_V4 2018-04-21 20:49:44 +02:00
matterhook Add slack attachment support to matterhook 2018-02-23 00:48:25 +01:00
vendor Add vendor files for spf13/viper 2018-03-04 23:46:13 +01:00
.travis.yml Fix bintray build 2018-03-17 23:13:27 +01:00
changelog.md Release v1.9.1 2018-04-20 00:32:11 +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 2018-04-20 00:39:57 +02:00
matterbridge.toml.sample Add support for reloading all settings automatically after changing config except connection and gateway configuration. Closes #373 2018-05-01 22:23:37 +02:00
matterbridge.toml.simple remove useAPI from sample configuration (#250) 2017-09-04 15:16:29 +02:00
README.md Fix alignment 2018-04-25 22:21:16 +02:00

README.md

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 Twitch

Download stable Download dev

matterbridge.gif

Simple bridge between IRC, XMPP, Gitter, Mattermost, Slack, Discord, Telegram, Rocket.Chat, Hipchat(via xmpp), Matrix, Steam and ssh-chat
Has a REST API.
Minecraft server chat support via MatterLink

Mattermost isn't required to run matterbridge. It bridges between any supported protocol.
(The name matterbridge is a remnant when it was only bridging mattermost)

Table of Contents

Features

API

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

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

  • MatterLink (Matterbridge link for Minecraft Server chat)
  • pyCord (crossplatform chatbot)

Requirements

Accounts to one of the supported bridges

Screenshots

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

Installing

Binaries

  • Latest stable release v1.9.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] (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: