| 1 | > [!NOTE] |
| 2 | > This is a community-maintained fork [42wim/matterbridge](https://github.com/42wim/matterbridge), because |
| 3 | > there is not a lot of activity upstream and lots of bugfixes were not merged. |
| 4 | > |
| 5 | > **Get involved now and [become a maintainer for your favorite network/protocol](https://github.com/matterbridge-org/community/issues/1)!** |
| 6 | |
| 7 | <div align="center"> |
| 8 | |
| 9 | # matterbridge |
| 10 | |
| 11 | <br /> |
| 12 | **A simple chat bridge**<br /> |
| 13 | Letting people be where they want to be with the magic of [interoperability](https://en.wikipedia.org/wiki/Interoperability).<br /> |
| 14 | |
| 15 | --- |
| 16 | |
| 17 | [](https://github.com/42wim/matterbridge/releases/latest) |
| 18 | |
| 19 | --- |
| 20 | |
| 21 | </div> |
| 22 | |
| 23 | matterbridge is a solution to connect users on different platforms/protocols, allowing them to chat in the best conditions possible. Despite the name, Matter<em>most</em> isn't required to run matter<em>bridge</em>. |
| 24 | |
| 25 | > [!WARNING] |
| 26 | > This fork has edited the history of the project to remove ~100MB of vendoring. |
| 27 | > This will faciliate review of new PRs, see [community/#5](https://github.com/matterbridge-org/community/issues/5) |
| 28 | > for the reasons why we did this and how to make sure we didn't introduce backdoors in this process. |
| 29 | |
| 30 | ## Features |
| 31 | |
| 32 | Many features are available, but not all of them are supported on all protocols: |
| 33 | |
| 34 | - [x] Bridge many rooms from supported protocols |
| 35 | - [x] Message threads/topics, and replies |
| 36 | - [x] Attachments, file uploads, and inline images |
| 37 | - [x] Transparent bridging with spoofed usernames and avatars |
| 38 | - [x] Private groups |
| 39 | |
| 40 | **The complete and up-to-date list of supported protocols is in [docs/protocols/](docs/protocols/).** Additionally, we have an [API for 3rd party integration](https://github.com/42wim/matterbridge/wiki/Features#api) if you'd like to add a custom bridge without implementing it in this codebase. |
| 41 | |
| 42 |  |
| 43 | |
| 44 | ## Getting started with matterbridge |
| 45 | |
| 46 | Get matterbridge up-and-running in a few minutes in 3 simple steps: |
| 47 | |
| 48 | - [Setting up matterbridge](docs/setup.md) (see [docs/compiling.md](docs/compiling.md) for compiling from source) |
| 49 | - [Configuring matterbridge](docs/config.md) |
| 50 | - [Running matterbridge](docs/running.md) (CLI or as a systemd service) |
| 51 | |
| 52 | ## Documentation |
| 53 | |
| 54 | See [docs/](docs/) folder in this repository. |
| 55 | |
| 56 | ## Contributing |
| 57 | |
| 58 | You are welcome to submit pull requests, report bugs and request new features. matterbridge is a volunteer-run project and you are expected to behave with respect for the maintainers and other users. In particular, harassment and hate speech are not welcome. |
| 59 | |
| 60 | For more development guidelines, see [docs/development/](docs/development/). |
| 61 | |
| 62 | This project is licensed under the [GNU AGPLv3 license](LICENSE) since after commit `20988f6446c6ad3ea416044712e634d3ed85ee53`. It was relicensed following discussion in [commmunity/#10](https://github.com/matterbridge-org/community/issues/10). Apart from the obvious advantages of copyleft to promote innovation and cooperation, in very practical terms, we had to use either `GPL` or `AGPL` to include the `whatsappmulti` bridge in official builds and deprecate the broken legacy `whatsapp` bridge. When contributing to matterbridge development, you agree that your contributions will be published under that license. |
| 63 | |
| 64 | Commits up-to `20988f6446c6ad3ea416044712e634d3ed85ee53` remain available under the looser [Apache License 2.0](LICENSE.old). |
| 65 | |
| 66 | ### Chat with us |
| 67 | |
| 68 | Questions or want to test on your favorite platform? Join us on: |
| 69 | |
| 70 | - federated networks: [Jabber/XMPP][mb-xmpp], [Matrix][mb-matrix] |
| 71 | - non-free centralized networks: [Discord][mb-discord], [Keybase][mb-keybase], [Slack][mb-slack], [Telegram][mb-telegram], [Twitch][mb-twitch] |
| 72 | - self-hostable centralized networks: [IRC][mb-irc], [Mattermost][mb-mattermost], [Rocket.Chat][mb-rocketchat], [Zulip][mb-zulip] |
| 73 | |
| 74 | ## Related projects |
| 75 | |
| 76 | - [jwflory/ansible-role-matterbridge](https://galaxy.ansible.com/jwflory/matterbridge) (Ansible role to simplify deploying Matterbridge) |
| 77 | - [matterbridge autoconfig](https://github.com/patcon/matterbridge-autoconfig) |
| 78 | - [matterbridge config viewer](https://github.com/patcon/matterbridge-heroku-viewer) |
| 79 | - [matterbridge-heroku](https://github.com/cadecairos/matterbridge-heroku) |
| 80 | - [mattermost-plugin](https://github.com/matterbridge/mattermost-plugin) - Run matterbridge as a plugin in mattermost |
| 81 | - [isla](https://github.com/alphachung/isla) (Bot for Discord-Telegram groups used alongside matterbridge) |
| 82 | |
| 83 | ## Thanks |
| 84 | |
| 85 | Matterbridge wouldn't exist without amazing libraries, without [@42wim](https://github.com/42wim) who started the project, and without the 100+ contributors who participated in this adventure. See [docs/credits.md](docs/credits.md) for more complete credits. |
| 86 | |
| 87 | <!-- Links --> |
| 88 | |
| 89 | [mb-discord]: https://discord.gg/AkKPtrQ |
| 90 | [mb-gitter]: https://gitter.im/42wim/matterbridge |
| 91 | [mb-irc]: https://web.libera.chat/#matterbridge |
| 92 | [mb-keybase]: https://keybase.io/team/matterbridge |
| 93 | [mb-matrix]: https://riot.im/app/#/room/#matterbridge:matrix.org |
| 94 | [mb-mattermost]: https://framateam.org/signup_user_complete/?id=tfqm33ggop8x3qgu4boeieta6e |
| 95 | [mb-msteams]: https://teams.microsoft.com/join/hj92x75gd3y7 |
| 96 | [mb-rocketchat]: https://open.rocket.chat/channel/matterbridge |
| 97 | [mb-slack]: https://join.slack.com/t/matterbridgechat/shared_invite/zt-2ourq2h2-7YvyYBq2WFGC~~zEzA68_Q |
| 98 | [mb-telegram]: https://t.me/Matterbridge |
| 99 | [mb-twitch]: https://www.twitch.tv/matterbridge |
| 100 | [mb-whatsapp]: https://www.whatsapp.com/ |
| 101 | [mb-xmpp]: xmpp:matterbridge@conference.jabber.de?join |
| 102 | [mb-zulip]: https://matterbridge.zulipchat.com/register/ |
| 103 | |
| 104 | |
