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,337 Commits 6 Branches 116 Tags 268 MiB
Go 99.4%
Dockerfile 0.5%
Shell 0.1%
b2af76e7dc
Go to file
Ben Wiederhake b2af76e7dc
Support Telegram animated stickers (tgs) format (#1173) 
This is half a fix for #874

This patch introduces a new config flag:
- MediaConvertTgs

These need to be treated independently from the existing
MediaConvertWebPToPNG flag because Tgs→WebP results in an
*animated* WebP, and the WebP→PNG converter can't handle
animated WebP files yet.

Furthermore, some platforms (like discord) don't even support
animated WebP files, so the user may want to fall back to
static PNGs (not APNGs).

The final reason why this is only half a fix is that this
introduces an external dependency, namely lottie, to be
installed like this:

$ pip3 install lottie cairosvg

This patch works by writing the tgs to a temporary file in /tmp,
calling lottie to convert it (this conversion may take several seconds!),
and then deleting the temporary file.
The temporary file is absolutely necessary, as lottie refuses to
work on non-seekable files.
If anyone comes up with a reasonable use case where /tmp is
unavailable, I can add yet another config option for that, if desired.

Telegram will bail out if the option is configured but lottie isn't found.
2020-08-23 22:34:28 +02:00
.github Update workflow builds to go 1.15 2020-08-21 00:29:59 +02:00
bridge Support Telegram animated stickers (tgs) format (#1173) 2020-08-23 22:34: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 Add Nextcloud Talk support (#1167) 2020-07-18 16:08:25 +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 Sync with upstream gozulipbot fixes (#1202) 2020-08-21 00:14:33 +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 Update linter config 2020-07-26 15:05:52 +02:00
.goreleaser.yml Fix deprecation in goreleaser 2019-09-07 23:37:49 +02:00
changelog.md Release v1.18.0 (#1176) 2020-07-24 21:00:57 +02:00
Dockerfile Combine runs to one layer (#1151) 2020-05-28 00:31:32 +02:00
go.mod Sync with upstream gozulipbot fixes (#1202) 2020-08-21 00:14:33 +02:00
go.sum Sync with upstream gozulipbot fixes (#1202) 2020-08-21 00:14:33 +02:00
LICENSE Initial commit 2015-10-23 17:07:05 +02:00
matterbridge.go Bump version 2020-07-24 21:31:28 +02:00
matterbridge.toml.sample Fix typo in documentation (#1183) 2020-07-30 23:46:03 +02:00
matterbridge.toml.simple remove useAPI from sample configuration (#250) 2017-09-04 15:16:29 +02:00
README.md Release v1.18.0 (#1176) 2020-07-24 21:00:57 +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.18.0
  • 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 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: