jshiffer/matterbridge
1
0
Fork 1
mirror of https://github.com/42wim/matterbridge.git synced 2024-11-21 02:02:00 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity
bridge between mattermost, IRC, gitter, xmpp, slack, discord, telegram, rocketchat, twitch, ssh-chat, zulip, whatsapp, keybase, matrix, microsoft teams, nextcloud, mumble, vk and more with REST API (mattermost not required!)
1,234 Commits 6 Branches 116 Tags 281 MiB
Go 99.4%
Dockerfile 0.5%
Shell 0.1%
6616d105d1
Go to file
burner1024 6616d105d1
Add markdownv2 mode for telegram documentation, see #1032 (#1037)
2020-03-18 22:43:11 +01:00
.github Fix typo in feature_request.md (#1009) 2020-02-10 22:35:11 +01:00
bridge Remove replace directives and use own fork to make go get work again (#1028) 2020-03-08 17:08:18 +01:00
ci Update to go1.14 and golangci-lint 1.23.7 (#1020) 2020-03-01 21:50:21 +01:00
contrib Create outmessage-discordemoji.tengo (#979) 2020-01-30 00:00:57 +01:00
docker/arm Try building arm docker image 2018-12-26 17:27:25 +01:00
gateway Add initial Microsoft Teams support 2020-03-01 22:19:33 +01: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
internal move stripCustomoji logic to default Tengo script (#973) 2020-01-09 18:02:53 +01:00
matterclient Make getChannelIdTeam behave like GetChannelId for groups (mattermost) (#873) 2019-09-07 21:39:44 +02:00
matterhook Use upstream slack-go/slack again (#1018) 2020-03-01 20:59:19 +01:00
vendor Update vendor shazow/ssh-chat (#1029) 2020-03-08 23:55:09 +01:00
.fixmie.yml Create .fixmie.yml 2019-08-26 23:49:06 +02:00
.gitignore Re-add binary to .gitignore (#951) 2019-11-26 00:16:40 +01:00
.golangci.yaml Do not lint gomnd (#1021) 2020-03-01 22:05:50 +01:00
.goreleaser.yml Fix deprecation in goreleaser 2019-09-07 23:37:49 +02:00
.travis.yml Update to go1.14 and golangci-lint 1.23.7 (#1020) 2020-03-01 21:50:21 +01:00
changelog.md Release v1.16.5 2020-02-02 22:36:07 +01:00
Dockerfile Add extra mimetypes to docker image. Fixes #969 2020-01-07 23:34:11 +01:00
go.mod Update vendor shazow/ssh-chat (#1029) 2020-03-08 23:55:09 +01:00
go.sum Update vendor shazow/ssh-chat (#1029) 2020-03-08 23:55:09 +01:00
LICENSE Initial commit 2015-10-23 17:07:05 +02:00
matterbridge.go Bump version 2020-02-02 22:40:44 +01:00
matterbridge.toml.sample Add markdownv2 mode for telegram documentation, see #1032 (#1037) 2020-03-18 22:43:11 +01:00
matterbridge.toml.simple remove useAPI from sample configuration (#250) 2017-09-04 15:16:29 +02:00
README.md Make Keybase link point to the team directly (#1013) 2020-02-19 21:02:44 +01: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 | Keybase | 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 / upgrading

Binaries

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

To install or upgrade just download the latest binary and follow the instructions on the howto for a step by step walkthrough for creating your configuration.

Packages

Building

Most people just want to use binaries, you can find those here

If you really want to build from source, follow these instructions: Go 1.12+ is required. Make sure you have Go properly installed.

go get github.com/42wim/matterbridge

You should now have matterbridge binary in the ~/go/bin directory:

$ ls ~/go/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

Please take a look at the Docker Wiki page for more information.

Changelog

See changelog.md

FAQ

See FAQ

Related projects

Articles

Thanks

This project is supported by:

Matterbridge wouldn't exist without these libraries: