Archives/matterbridge
2
0
Fork 0
mirror of https://github.com/42wim/matterbridge synced 2024-11-03 15:40:24 +00:00
Code Issues Projects Releases Wiki Activity
1,092 Commits 6 Branches 116 Tags 268 MiB
Go 99.4%
Dockerfile 0.5%
Shell 0.1%
8513a07416
Go to file
Wim 8513a07416 Update README
2019-04-14 23:48:54 +02:00
.github Update issue templates 2018-05-05 18:04:03 +02:00
bridge Add useraction support (rocketchat). Closes #772 (#794) 2019-04-08 23:30:22 +02:00
ci Add CI fixes and improvements (#780) 2019-04-04 22:54:51 +02:00
contrib Add remotenickformat-zerowidth.tengo to contrib (#799) 2019-04-14 23:42:16 +02:00
docker/arm Try building arm docker image 2018-12-26 17:27:25 +01:00
gateway Add tengo support to RemoteNickFormat (#793) 2019-04-08 20:58:21 +02:00
hook/rockethook Enable gosec linter (#645) 2018-12-06 00:40:55 +01:00
img Replace documentation image 2018-11-18 00:16:49 +00:00
matterclient Send channel_created and deleted event through message channel (mattermost) 2019-04-13 21:52:39 +02:00
matterhook Enable gosec linter (#645) 2018-12-06 00:40:55 +01:00
vendor Update tengo vendor and load the stdlib. Fixes #789 (#792) 2019-04-06 22:18:25 +02:00
.golangci.yaml Add CI fixes and improvements (#780) 2019-04-04 22:54:51 +02:00
.goreleaser.yml Add goreleaser.yml 2019-02-24 01:09:53 +01:00
.travis.yml Build on every branch (travis) 2019-04-07 23:57:47 +02:00
changelog.md Release v1.14.2 2019-04-06 23:29:49 +02:00
Dockerfile Add githash to docker builds 2017-02-17 22:32:42 +01:00
go.mod Update tengo vendor and load the stdlib. Fixes #789 (#792) 2019-04-06 22:18:25 +02:00
go.sum Update tengo vendor and load the stdlib. Fixes #789 (#792) 2019-04-06 22:18:25 +02:00
LICENSE Initial commit 2015-10-23 17:07:05 +02:00
matterbridge.go Bump version 2019-04-07 15:41:14 +02:00
matterbridge.toml.sample Add tengo support to RemoteNickFormat (#793) 2019-04-08 20:58:21 +02:00
matterbridge.toml.simple remove useAPI from sample configuration (#250) 2017-09-04 15:16:29 +02:00
README.md Update README 2019-04-14 23:48:54 +02:00

README.md

matterbridge

Matterbridge Logo
A simple chat bridge
Letting people be where they want to be.
Bridges between a growing number of protocols. Click below to demo or join the development chat.

Gitter | IRC | Discord | Matrix | Slack | Mattermost | Rocket.Chat | XMPP | Twitch | WhatsApp | Zulip | Telegram | And more...

Download stable Download dev Maintainability Test Coverage

Note: Mattermost isn't required to run matterbridge.

Table of Contents

Features

Natively supported

3rd party via matterbridge api

API

The API is basic at the moment. More info and examples on the wiki.

Used by the projects below. Feel free to make a PR to add your project to this list.

Chat with us

Questions or want to test on your favorite platform? Join below:

Screenshots

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

Installing

Binaries

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

Packages

Building

Go 1.9+ is required. Make sure you have Go properly installed, including setting up your GOPATH.

After Go is setup, download matterbridge to your $GOPATH directory.

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.

Settings

All possible settings for each bridge.

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

Related projects

Articles

Thanks

This project is supported by:

Matterbridge wouldn't exist without these libraries: