mirror of
https://github.com/cwinfo/matterbridge.git
synced 2024-11-22 10:30:26 +00:00
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!)
b2af76e7dc
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. |
||
|---|---|---|
| .github | ||
| bridge | ||
| contrib | ||
| docker/arm | ||
| gateway | ||
| hook/rockethook | ||
| img | ||
| internal | ||
| matterclient | ||
| matterhook | ||
| vendor | ||
| .fixmie.yml | ||
| .gitignore | ||
| .golangci.yaml | ||
| .goreleaser.yml | ||
| changelog.md | ||
| Dockerfile | ||
| go.mod | ||
| go.sum | ||
| LICENSE | ||
| matterbridge.go | ||
| matterbridge.toml.sample | ||
| matterbridge.toml.simple | ||
| README.md | ||
matterbridge
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...
Note: Mattermost isn't required to run matterbridge.
Table of Contents
- matterbridge
- Table of Contents
Features
- Support bridging between any protocols
- Support multiple gateways(bridges) for your protocols
- Message edits and deletes
- Preserves threading when possible
- Attachment / files handling
- Username and avatar spoofing
- Private groups
- API
Natively supported
- Discord
- Gitter
- IRC
- Keybase
- Matrix
- Mattermost 4.x, 5.x
- Microsoft Teams
- Nextcloud Talk
- Rocket.chat
- Slack
- Ssh-chat
- Steam
- Telegram
- Twitch
- XMPP
- Zulip
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.
- MatterLink (Matterbridge link for Minecraft Server chat)
- pyCord (crossplatform chatbot)
- Mattereddit (Reddit chat support)
- fbridge (Facebook messenger support)
- matterbabble (Discourse support)
- MatterAMXX (Counter-Strike, half-life and more via AMXX mod)
Chat with us
Questions or want to test on your favorite platform? Join below:
- Discord
- Gitter
- IRC
- Keybase
- Matrix
- Mattermost
- Rocket.Chat
- Slack
- Telegram
- Twitch
- XMPP (matterbridge@conference.jabber.de)
- Zulip
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
- matterbridge.toml.sample for documentation and an example.
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
- jwflory/ansible-role-matterbridge (Ansible role to simplify deploying Matterbridge)
- matterbridge autoconfig
- matterbridge config viewer
- matterbridge-heroku
- mattereddit
- matterlink
- mattermost-plugin - Run matterbridge as a plugin in mattermost
- pyCord (crossplatform chatbot)
- fbridge (Facebook messenger support)
- isla (Bot for Discord-Telegram groups used alongside matterbridge)
- matterbabble (Connect Discourse threads to Matterbridge)
Articles
- matterbridge on kubernetes
- https://mattermost.com/blog/connect-irc-to-mattermost/
- https://blog.valvin.fr/2016/09/17/mattermost-et-un-channel-irc-cest-possible/
- https://blog.brightscout.com/top-10-mattermost-integrations/
- http://bencey.co.nz/2018/09/17/bridge/
- https://www.algoo.fr/blog/2018/01/19/recouvrez-votre-liberte-en-quittant-slack-pour-un-mattermost-auto-heberge/
- https://kopano.com/blog/matterbridge-bridging-mattermost-chat/
- https://www.stitcher.com/s/?eid=52382713
- https://daniele.tech/2019/02/how-to-use-matterbridge-to-connect-2-different-slack-workspaces/
- https://userlinux.net/mattermost-and-matterbridge.html
Thanks
This project is supported by:
Matterbridge wouldn't exist without these libraries:
- discord - https://github.com/bwmarrin/discordgo
- echo - https://github.com/labstack/echo
- gitter - https://github.com/sromku/go-gitter
- gops - https://github.com/google/gops
- gozulipbot - https://github.com/ifo/gozulipbot
- irc - https://github.com/lrstanley/girc
- keybase - https://github.com/keybase/go-keybase-chat-bot
- matrix - https://github.com/matrix-org/gomatrix
- mattermost - https://github.com/mattermost/mattermost-server
- msgraph.go - https://github.com/yaegashi/msgraph.go
- slack - https://github.com/nlopes/slack
- sshchat - https://github.com/shazow/ssh-chat
- steam - https://github.com/Philipp15b/go-steam
- telegram - https://github.com/go-telegram-bot-api/telegram-bot-api
- tengo - https://github.com/d5/tengo
- whatsapp - https://github.com/Rhymen/go-whatsapp/
- xmpp - https://github.com/mattn/go-xmpp
- zulip - https://github.com/ifo/gozulipbot