lug/matterbridge
10
0
Fork 2
Code Issues 4 Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Update readme with keybase links

Browse Source
This commit is contained in:
Cori Hudson
2019-08-24 13:52:31 -04:00
parent fa57aa2b91
commit 8cd53369a5
1 changed files with 164 additions and 136 deletions
Download Patch File Download Diff File Expand all files Collapse all files

300
README.md
View File

@@ -3,32 +3,35 @@
# matterbridge # matterbridge
![Matterbridge Logo](img/matterbridge-notext.gif)<br /> ![Matterbridge Logo](img/matterbridge-notext.gif)<br />
**A simple chat bridge**<br /> **A simple chat bridge**<br />
Letting people be where they want to be.<br /> Letting people be where they want to be.<br />
<sub>Bridges between a growing number of protocols. Click below to demo or join the development chat.</sub> <sub>Bridges between a growing number of protocols. Click below to demo or join the development chat.</sub>
<sup> <sup>
[Gitter][mb-gitter] | [Gitter][mb-gitter] |
[IRC][mb-irc] | [IRC][mb-irc] |
[Discord][mb-discord] | [Discord][mb-discord] |
[Matrix][mb-matrix] | [Matrix][mb-matrix] |
[Slack][mb-slack] | [Slack][mb-slack] |
[Mattermost][mb-mattermost] | [Mattermost][mb-mattermost] |
[Rocket.Chat][mb-rocketchat] | [Rocket.Chat][mb-rocketchat] |
[XMPP][mb-xmpp] | [XMPP][mb-xmpp] |
[Twitch][mb-twitch] | [Twitch][mb-twitch] |
[WhatsApp][mb-whatsapp] | [WhatsApp][mb-whatsapp] |
[Zulip][mb-zulip] | [Zulip][mb-zulip] |
[Telegram][mb-telegram] | [Telegram][mb-telegram] |
And more... [Keybase][mb-keybase] |
</sup> And more...
</sup>
---
----
[![Download stable](https://img.shields.io/github/release/42wim/matterbridge.svg?label=download%20stable)](https://github.com/42wim/matterbridge/releases/latest) [![Download stable](https://img.shields.io/github/release/42wim/matterbridge.svg?label=download%20stable)](https://github.com/42wim/matterbridge/releases/latest)
[![Download dev](https://img.shields.io/bintray/v/42wim/nightly/Matterbridge.svg?label=download%20dev&colorB=007ec6)](https://bintray.com/42wim/nightly/Matterbridge/_latestVersion) [![Download dev](https://img.shields.io/bintray/v/42wim/nightly/Matterbridge.svg?label=download%20dev&colorB=007ec6)](https://bintray.com/42wim/nightly/Matterbridge/_latestVersion)
[![Maintainability](https://api.codeclimate.com/v1/badges/82dff70ef2ba85a6173a/maintainability)](https://codeclimate.com/github/42wim/matterbridge/maintainability) [![Maintainability](https://api.codeclimate.com/v1/badges/82dff70ef2ba85a6173a/maintainability)](https://codeclimate.com/github/42wim/matterbridge/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/82dff70ef2ba85a6173a/test_coverage)](https://codeclimate.com/github/42wim/matterbridge/test_coverage)<br /> [![Test Coverage](https://api.codeclimate.com/v1/badges/82dff70ef2ba85a6173a/test_coverage)](https://codeclimate.com/github/42wim/matterbridge/test_coverage)<br />
<hr /> <hr />
</div> </div>
<div align="right"><sup> <div align="right"><sup>
@@ -42,108 +45,118 @@
</p> </p>
### Table of Contents ### Table of Contents
* [Features](https://github.com/42wim/matterbridge/wiki/Features)
* [Natively supported](#natively-supported) - [Features](https://github.com/42wim/matterbridge/wiki/Features)
* [3rd party via matterbridge api](#3rd-party-via-matterbridge-api) - [Natively supported](#natively-supported)
* [API](#API) - [3rd party via matterbridge api](#3rd-party-via-matterbridge-api)
* [Chat with us](#chat-with-us) - [API](#API)
* [Screenshots](https://github.com/42wim/matterbridge/wiki/) - [Chat with us](#chat-with-us)
* [Installing/upgrading](#installing--upgrading) - [Screenshots](https://github.com/42wim/matterbridge/wiki/)
* [Binaries](#binaries) - [Installing/upgrading](#installing--upgrading)
* [Building](#building) - [Binaries](#binaries)
* [Configuration](#configuration) - [Building](#building)
* [Howto](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config) - [Configuration](#configuration)
* [Settings](#settings) - [Howto](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config)
* [Examples](#examples) - [Settings](#settings)
* [Running](#running) - [Examples](#examples)
* [Docker](#docker) - [Running](#running)
* [Changelog](#changelog) - [Docker](#docker)
* [FAQ](#faq) - [Changelog](#changelog)
* [Related projects](#related-projects) - [FAQ](#faq)
* [Articles](#articles) - [Related projects](#related-projects)
* [Thanks](#thanks) - [Articles](#articles)
- [Thanks](#thanks)
## Features ## Features
* [Support bridging between any protocols](https://github.com/42wim/matterbridge/wiki/Features#support-bridging-between-any-protocols)
* [Support multiple gateways(bridges) for your protocols](https://github.com/42wim/matterbridge/wiki/Features#support-multiple-gatewaysbridges-for-your-protocols) - [Support bridging between any protocols](https://github.com/42wim/matterbridge/wiki/Features#support-bridging-between-any-protocols)
* [Message edits and deletes](https://github.com/42wim/matterbridge/wiki/Features#message-edits-and-deletes) - [Support multiple gateways(bridges) for your protocols](https://github.com/42wim/matterbridge/wiki/Features#support-multiple-gatewaysbridges-for-your-protocols)
* Preserves threading when possible - [Message edits and deletes](https://github.com/42wim/matterbridge/wiki/Features#message-edits-and-deletes)
* [Attachment / files handling](https://github.com/42wim/matterbridge/wiki/Features#attachment--files-handling) - Preserves threading when possible
* [Username and avatar spoofing](https://github.com/42wim/matterbridge/wiki/Features#username-and-avatar-spoofing) - [Attachment / files handling](https://github.com/42wim/matterbridge/wiki/Features#attachment--files-handling)
* [Private groups](https://github.com/42wim/matterbridge/wiki/Features#private-groups) - [Username and avatar spoofing](https://github.com/42wim/matterbridge/wiki/Features#username-and-avatar-spoofing)
* [API](https://github.com/42wim/matterbridge/wiki/Features#api) - [Private groups](https://github.com/42wim/matterbridge/wiki/Features#private-groups)
- [API](https://github.com/42wim/matterbridge/wiki/Features#api)
### Natively supported ### Natively supported
* [Mattermost](https://github.com/mattermost/mattermost-server/) 4.x, 5.x - [Mattermost](https://github.com/mattermost/mattermost-server/) 4.x, 5.x
* [IRC](http://www.mirc.com/servers.html) - [IRC](http://www.mirc.com/servers.html)
* [XMPP](https://xmpp.org) - [XMPP](https://xmpp.org)
* [Gitter](https://gitter.im) - [Gitter](https://gitter.im)
* [Slack](https://slack.com) - [Slack](https://slack.com)
* [Discord](https://discordapp.com) - [Discord](https://discordapp.com)
* [Telegram](https://telegram.org) - [Telegram](https://telegram.org)
* [Rocket.chat](https://rocket.chat) - [Rocket.chat](https://rocket.chat)
* [Matrix](https://matrix.org) - [Matrix](https://matrix.org)
* [Steam](https://store.steampowered.com/) - [Steam](https://store.steampowered.com/)
* [Twitch](https://twitch.tv) - [Twitch](https://twitch.tv)
* [Ssh-chat](https://github.com/shazow/ssh-chat) - [Ssh-chat](https://github.com/shazow/ssh-chat)
* [WhatsApp](https://www.whatsapp.com/) - [WhatsApp](https://www.whatsapp.com/)
* [Zulip](https://zulipchat.com) - [Zulip](https://zulipchat.com)
- [Keybase](https://keybase.io)
### 3rd party via matterbridge api ### 3rd party via matterbridge api
* [Minecraft](https://github.com/elytra/MatterLink)
* [Reddit](https://github.com/bonehurtingjuice/mattereddit) - [Minecraft](https://github.com/elytra/MatterLink)
* [Facebook messenger](https://github.com/VictorNine/fbridge) - [Reddit](https://github.com/bonehurtingjuice/mattereddit)
* [Discourse](https://github.com/DeclanHoare/matterbabble) - [Facebook messenger](https://github.com/VictorNine/fbridge)
- [Discourse](https://github.com/DeclanHoare/matterbabble)
### API ### API
The API is basic at the moment. The API is basic at the moment.
More info and examples on the [wiki](https://github.com/42wim/matterbridge/wiki/Api). More info and examples on the [wiki](https://github.com/42wim/matterbridge/wiki/Api).
Used by the projects below. Feel free to make a PR to add your project to this list. Used by the projects below. Feel free to make a PR to add your project to this list.
* [MatterLink](https://github.com/elytra/MatterLink) (Matterbridge link for Minecraft Server chat) - [MatterLink](https://github.com/elytra/MatterLink) (Matterbridge link for Minecraft Server chat)
* [pyCord](https://github.com/NikkyAI/pyCord) (crossplatform chatbot) - [pyCord](https://github.com/NikkyAI/pyCord) (crossplatform chatbot)
* [Mattereddit](https://github.com/bonehurtingjuice/mattereddit) (Reddit chat support) - [Mattereddit](https://github.com/bonehurtingjuice/mattereddit) (Reddit chat support)
* [fbridge](https://github.com/VictorNine/fbridge) (Facebook messenger support) - [fbridge](https://github.com/VictorNine/fbridge) (Facebook messenger support)
* [matterbabble](https://github.com/DeclanHoare/matterbabble) (Discourse support) - [matterbabble](https://github.com/DeclanHoare/matterbabble) (Discourse support)
## Chat with us ## Chat with us
Questions or want to test on your favorite platform? Join below: Questions or want to test on your favorite platform? Join below:
* [Gitter][mb-gitter] - [Gitter][mb-gitter]
* [IRC][mb-irc] - [IRC][mb-irc]
* [Discord][mb-discord] - [Discord][mb-discord]
* [Matrix][mb-matrix] - [Matrix][mb-matrix]
* [Slack][mb-slack] - [Slack][mb-slack]
* [Mattermost][mb-mattermost] - [Mattermost][mb-mattermost]
* [Rocket.Chat][mb-rocketchat] - [Rocket.Chat][mb-rocketchat]
* [XMPP][mb-xmpp] (matterbridge@conference.jabber.de) - [XMPP][mb-xmpp] (matterbridge@conference.jabber.de)
* [Twitch][mb-twitch] - [Twitch][mb-twitch]
* [Zulip][mb-zulip] - [Zulip][mb-zulip]
* [Telegram][mb-telegram] - [Telegram][mb-telegram]
## Screenshots ## Screenshots
See https://github.com/42wim/matterbridge/wiki See https://github.com/42wim/matterbridge/wiki
## Installing / upgrading ## Installing / upgrading
### Binaries ### Binaries
* Latest stable release [v1.15.1](https://github.com/42wim/matterbridge/releases/latest)
* Development releases (follows master) can be downloaded [here](https://dl.bintray.com/42wim/nightly/) - Latest stable release [v1.15.1](https://github.com/42wim/matterbridge/releases/latest)
- Development releases (follows master) can be downloaded [here](https://dl.bintray.com/42wim/nightly/)
To install or upgrade just download the latest [binary](https://github.com/42wim/matterbridge/releases/latest) and follow the instructions on the [howto](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config) for a step by step walkthrough for creating your configuration. To install or upgrade just download the latest [binary](https://github.com/42wim/matterbridge/releases/latest) and follow the instructions on the [howto](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config) for a step by step walkthrough for creating your configuration.
### Packages ### Packages
* [Overview](https://repology.org/metapackage/matterbridge/versions)
- [Overview](https://repology.org/metapackage/matterbridge/versions)
## Building ## Building
Most people just want to use binaries, you can find those [here](https://github.com/42wim/matterbridge/releases/latest) Most people just want to use binaries, you can find those [here](https://github.com/42wim/matterbridge/releases/latest)
If you really want to build from source, follow these instructions: If you really want to build from source, follow these instructions:
Go 1.9+ is required. Make sure you have [Go](https://golang.org/doc/install) properly installed, including setting up your [GOPATH](https://golang.org/doc/code.html#GOPATH). Go 1.9+ is required. Make sure you have [Go](https://golang.org/doc/install) properly installed, including setting up your [GOPATH](https://golang.org/doc/code.html#GOPATH).
After Go is setup, download matterbridge to your $GOPATH directory. After Go is setup, download matterbridge to your \$GOPATH directory.
``` ```
cd $GOPATH cd $GOPATH
@@ -158,17 +171,23 @@ matterbridge
``` ```
## Configuration ## Configuration
### Basic configuration ### Basic configuration
See [howto](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config) for a step by step walkthrough for creating your configuration. See [howto](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config) for a step by step walkthrough for creating your configuration.
### Settings ### Settings
All possible [settings](https://github.com/42wim/matterbridge/wiki/Settings) for each bridge. All possible [settings](https://github.com/42wim/matterbridge/wiki/Settings) for each bridge.
### Advanced configuration ### Advanced configuration
* [matterbridge.toml.sample](https://github.com/42wim/matterbridge/blob/master/matterbridge.toml.sample) for documentation and an example.
- [matterbridge.toml.sample](https://github.com/42wim/matterbridge/blob/master/matterbridge.toml.sample) for documentation and an example.
### Examples ### Examples
#### Bridge mattermost (off-topic) - irc (#testing) #### Bridge mattermost (off-topic) - irc (#testing)
```toml ```toml
[irc] [irc]
[irc.freenode] [irc.freenode]
@@ -197,6 +216,7 @@ enable=true
``` ```
#### Bridge slack (#general) - discord (general) #### Bridge slack (#general) - discord (general)
```toml ```toml
[slack] [slack]
[slack.test] [slack.test]
@@ -241,12 +261,15 @@ Usage of ./matterbridge:
``` ```
### Docker ### Docker
Create your matterbridge.toml file locally eg in `/tmp/matterbridge.toml` Create your matterbridge.toml file locally eg in `/tmp/matterbridge.toml`
``` ```
docker run -ti -v /tmp/matterbridge.toml:/matterbridge.toml 42wim/matterbridge docker run -ti -v /tmp/matterbridge.toml:/matterbridge.toml 42wim/matterbridge
``` ```
## Changelog ## Changelog
See [changelog.md](https://github.com/42wim/matterbridge/blob/master/changelog.md) See [changelog.md](https://github.com/42wim/matterbridge/blob/master/changelog.md)
## FAQ ## FAQ
@@ -254,28 +277,30 @@ See [changelog.md](https://github.com/42wim/matterbridge/blob/master/changelog.m
See [FAQ](https://github.com/42wim/matterbridge/wiki/FAQ) See [FAQ](https://github.com/42wim/matterbridge/wiki/FAQ)
## Related projects ## Related projects
* [FOSSRIT/infrastructure - roles/matterbridge](https://github.com/FOSSRIT/infrastructure/tree/master/roles/matterbridge) (Ansible role used to automate deployments of Matterbridge)
* [matterbridge autoconfig](https://github.com/patcon/matterbridge-autoconfig) - [FOSSRIT/infrastructure - roles/matterbridge](https://github.com/FOSSRIT/infrastructure/tree/master/roles/matterbridge) (Ansible role used to automate deployments of Matterbridge)
* [matterbridge config viewer](https://github.com/patcon/matterbridge-heroku-viewer) - [matterbridge autoconfig](https://github.com/patcon/matterbridge-autoconfig)
* [matterbridge-heroku](https://github.com/cadecairos/matterbridge-heroku) - [matterbridge config viewer](https://github.com/patcon/matterbridge-heroku-viewer)
* [mattereddit](https://github.com/bonehurtingjuice/mattereddit) - [matterbridge-heroku](https://github.com/cadecairos/matterbridge-heroku)
* [matterlink](https://github.com/elytra/MatterLink) - [mattereddit](https://github.com/bonehurtingjuice/mattereddit)
* [mattermost-plugin](https://github.com/matterbridge/mattermost-plugin) - Run matterbridge as a plugin in mattermost - [matterlink](https://github.com/elytra/MatterLink)
* [pyCord](https://github.com/NikkyAI/pyCord) (crossplatform chatbot) - [mattermost-plugin](https://github.com/matterbridge/mattermost-plugin) - Run matterbridge as a plugin in mattermost
* [fbridge](https://github.com/VictorNine/fbridge) (Facebook messenger support) - [pyCord](https://github.com/NikkyAI/pyCord) (crossplatform chatbot)
* [isla](https://github.com/alphachung/isla) (Bot for Discord-Telegram groups used alongside matterbridge) - [fbridge](https://github.com/VictorNine/fbridge) (Facebook messenger support)
* [matterbabble](https://github.com/DeclanHoare/matterbabble) (Connect Discourse threads to Matterbridge) - [isla](https://github.com/alphachung/isla) (Bot for Discord-Telegram groups used alongside matterbridge)
- [matterbabble](https://github.com/DeclanHoare/matterbabble) (Connect Discourse threads to Matterbridge)
## Articles ## Articles
* [matterbridge on kubernetes](https://medium.freecodecamp.org/using-kubernetes-to-deploy-a-chat-gateway-or-when-technology-works-like-its-supposed-to-a169a8cd69a3)
* https://mattermost.com/blog/connect-irc-to-mattermost/ - [matterbridge on kubernetes](https://medium.freecodecamp.org/using-kubernetes-to-deploy-a-chat-gateway-or-when-technology-works-like-its-supposed-to-a169a8cd69a3)
* https://blog.valvin.fr/2016/09/17/mattermost-et-un-channel-irc-cest-possible/ - https://mattermost.com/blog/connect-irc-to-mattermost/
* https://blog.brightscout.com/top-10-mattermost-integrations/ - https://blog.valvin.fr/2016/09/17/mattermost-et-un-channel-irc-cest-possible/
* http://bencey.co.nz/2018/09/17/bridge/ - https://blog.brightscout.com/top-10-mattermost-integrations/
* https://www.algoo.fr/blog/2018/01/19/recouvrez-votre-liberte-en-quittant-slack-pour-un-mattermost-auto-heberge/ - http://bencey.co.nz/2018/09/17/bridge/
* https://kopano.com/blog/matterbridge-bridging-mattermost-chat/ - https://www.algoo.fr/blog/2018/01/19/recouvrez-votre-liberte-en-quittant-slack-pour-un-mattermost-auto-heberge/
* https://www.stitcher.com/s/?eid=52382713 - https://kopano.com/blog/matterbridge-bridging-mattermost-chat/
* https://daniele.tech/2019/02/how-to-use-matterbridge-to-connect-2-different-slack-workspaces/ - https://www.stitcher.com/s/?eid=52382713
- https://daniele.tech/2019/02/how-to-use-matterbridge-to-connect-2-different-slack-workspaces/
## Thanks ## Thanks
@@ -287,34 +312,37 @@ See [FAQ](https://github.com/42wim/matterbridge/wiki/FAQ)
</p> </p>
Matterbridge wouldn't exist without these libraries: Matterbridge wouldn't exist without these libraries:
* discord - https://github.com/bwmarrin/discordgo
* echo - https://github.com/labstack/echo - discord - https://github.com/bwmarrin/discordgo
* gitter - https://github.com/sromku/go-gitter - echo - https://github.com/labstack/echo
* gops - https://github.com/google/gops - gitter - https://github.com/sromku/go-gitter
* gozulipbot - https://github.com/ifo/gozulipbot - gops - https://github.com/google/gops
* irc - https://github.com/lrstanley/girc - gozulipbot - https://github.com/ifo/gozulipbot
* mattermost - https://github.com/mattermost/mattermost-server - irc - https://github.com/lrstanley/girc
* matrix - https://github.com/matrix-org/gomatrix - mattermost - https://github.com/mattermost/mattermost-server
* sshchat - https://github.com/shazow/ssh-chat - matrix - https://github.com/matrix-org/gomatrix
* slack - https://github.com/nlopes/slack - sshchat - https://github.com/shazow/ssh-chat
* steam - https://github.com/Philipp15b/go-steam - slack - https://github.com/nlopes/slack
* telegram - https://github.com/go-telegram-bot-api/telegram-bot-api - steam - https://github.com/Philipp15b/go-steam
* xmpp - https://github.com/mattn/go-xmpp - telegram - https://github.com/go-telegram-bot-api/telegram-bot-api
* whatsapp - https://github.com/Rhymen/go-whatsapp/ - xmpp - https://github.com/mattn/go-xmpp
* zulip - https://github.com/ifo/gozulipbot - whatsapp - https://github.com/Rhymen/go-whatsapp/
* tengo - https://github.com/d5/tengo - zulip - https://github.com/ifo/gozulipbot
- tengo - https://github.com/d5/tengo
- keybase - https://github.com/keybase/go-keybase-chat-bot
<!-- Links --> <!-- Links -->
[mb-gitter]: https://gitter.im/42wim/matterbridge [mb-gitter]: https://gitter.im/42wim/matterbridge
[mb-irc]: https://webchat.freenode.net/?channels=matterbridgechat [mb-irc]: https://webchat.freenode.net/?channels=matterbridgechat
[mb-discord]: https://discord.gg/AkKPtrQ [mb-discord]: https://discord.gg/AkKPtrQ
[mb-matrix]: https://riot.im/app/#/room/#matterbridge:matrix.org [mb-matrix]: https://riot.im/app/#/room/#matterbridge:matrix.org
[mb-slack]: https://join.slack.com/matterbridgechat/shared_invite/MjEwODMxNjU1NDMwLTE0OTk2MTU3NTMtMzZkZmRiNDZhOA [mb-slack]: https://join.slack.com/matterbridgechat/shared_invite/MjEwODMxNjU1NDMwLTE0OTk2MTU3NTMtMzZkZmRiNDZhOA
[mb-mattermost]: https://framateam.org/signup_user_complete/?id=tfqm33ggop8x3qgu4boeieta6e [mb-mattermost]: https://framateam.org/signup_user_complete/?id=tfqm33ggop8x3qgu4boeieta6e
[mb-rocketchat]: https://open.rocket.chat/channel/matterbridge [mb-rocketchat]: https://open.rocket.chat/channel/matterbridge
[mb-xmpp]: https://inverse.chat/ [mb-xmpp]: https://inverse.chat/
[mb-twitch]: https://www.twitch.tv/matterbridge [mb-twitch]: https://www.twitch.tv/matterbridge
[mb-whatsapp]: https://www.whatsapp.com/ [mb-whatsapp]: https://www.whatsapp.com/
[mb-zulip]: https://matterbridge.zulipchat.com/register/ [mb-keybase]: https://keybase.io
[mb-telegram]: https://t.me/Matterbridge [mb-zulip]: https://matterbridge.zulipchat.com/register/
[mb-telegram]: https://t.me/Matterbridge