Sign inSign up

computeronix/matterbridge-test

By computeronix

•Updated about 5 years ago

Image
0

483

computeronix/matterbridge-test repository overview

⁠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.3⁠
  • 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.libera]
    Server="irc.libera.chat: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.libera"
    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.

⁠Systemd

Please take a look at the Service Files page⁠ for more information.

⁠Changelog

See changelog.md⁠

⁠FAQ

See FAQ⁠

⁠Articles / Tutorials

⁠Thanks

This project is supported by:

⁠

Matterbridge wouldn't exist without these libraries:

Tag summary

Content type

Image

Digest

Size

203.3 MB

Last updated

about 5 years ago

docker pull computeronix/matterbridge-test