cwinfo/matterbridge
5
0
Fork 0
mirror of https://github.com/cwinfo/matterbridge.git synced 2024-12-24 18:25:40 +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!)
1,462 Commits 2 Branches 81 Tags 113 MiB
Go 99.4%
Dockerfile 0.5%
Shell 0.1%
a0bca42a7a
Go to file
Wim a0bca42a7a
Update vendor (#1461) 
* Update vendored libs

* Fix slack api changes
2021-05-05 22:03:28 +02:00
.github Use go1.16 as binary builder. Remove go1.14 (#1407) 2021-02-17 21:37:14 +01:00
bridge Update vendor (#1461) 2021-05-05 22:03:28 +02: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 Update vendor (#1446) 2021-04-03 19:16:46 +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
internal move stripCustomoji logic to default Tengo script (#973) 2020-01-09 18:02:53 +01:00
matterclient Use mattermost v5 module (#1192) 2020-08-10 00:29:54 +02:00
matterhook Use upstream slack-go/slack again (#1018) 2020-03-01 20:59:19 +01:00
vendor Update vendor (#1461) 2021-05-05 22:03:28 +02:00
.dockerignore Add Dockerimage for tgs conversion (#1211) 2020-08-25 13:15:24 +02: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 Remove locale from golangci misspell (#1324) 2020-12-05 15:22:23 +01:00
.goreleaser.yml Fix deprecation in goreleaser 2019-09-07 23:37:49 +02:00
changelog.md Release v1.22.1 (#1447) 2021-04-03 23:55:06 +02:00
Dockerfile Optimize Dockerfile (#1361) 2021-01-15 22:44:01 +01:00
go.mod Update vendor (#1461) 2021-05-05 22:03:28 +02:00
go.sum Update vendor (#1461) 2021-05-05 22:03:28 +02:00
LICENSE Initial commit 2015-10-23 17:07:05 +02:00
matterbridge.go Bump version 2021-04-04 00:09:43 +02:00
matterbridge.toml.sample Fix missing word in matterbridge.toml.sample (#1398) 2021-02-11 13:11:59 +00:00
matterbridge.toml.simple remove useAPI from sample configuration (#250) 2017-09-04 15:16:29 +02:00
README.md Release v1.22.1 (#1447) 2021-04-03 23:55:06 +02:00
tgs.Dockerfile Follow up to 536823ce55 for the tgs.Dockerfile (#1448) 2021-05-03 23:47:36 +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.

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

Download stable 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.22.1
  • Development releases (follows master) can be downloaded here selecting the latest green build and then artifacts.

To install or upgrade just download the latest binary. On *nix platforms you may need to make the binary executable - you can do this by running chmod a+x on the binary (example: chmod a+x matterbridge-1.20.0-linux-64bit). After downloading (and making the binary executable, if necessary), 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.13+ 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 / Tutorials

Thanks

This project is supported by:

Matterbridge wouldn't exist without these libraries: