.githooks | ||
.github | ||
conf | ||
doc | ||
scripts | ||
.gitignore | ||
ALL_README.md | ||
config_panel.toml | ||
LICENSE | ||
manifest.toml | ||
README.md | ||
README_es.md | ||
README_eu.md | ||
README_fr.md | ||
README_gl.md | ||
README_id.md | ||
README_it.md | ||
README_zh_Hans.md | ||
tests.toml |
Matrix-WhatsApp bridge for YunoHost
Read this README in other languages.
This package allows you to install Matrix-WhatsApp bridge quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult the guide to learn how to install it.
Overview
A puppeting bridge between Matrix and WhatsApp packaged as a YunoHost service. Messages, media and notifications are bridged between a WhatsApp user and a matrix user. With the RelayBot login option, the matrix user can invite other matrix user in a bridged WhatsApp room, such that even people without a WhatsApp account can participate to WhatsApp group conversations. The "Mautrix-WhatsApp" bridge consists in a synapse app service and relies on postgresql (mysql also available). Therefore, Synapse for YunoHost should be installed beforehand.
** Attention: always backup and restore the Yunohost matrix_synapse et mautrix_whatsapp apps together!**
Shipped version: 0.10.9~ynh1
Documentation and resources
- Official app website: https://maunium.net/go/mautrix-whatsapp/
- Official admin documentation: https://docs.mau.fi/bridges/go/whatsapp/index.html
- Upstream app code repository: https://github.com/mautrix/whatsapp
- YunoHost Store: https://apps.yunohost.org/app/mautrix_whatsapp
- Report a bug: https://github.com/YunoHost-Apps/mautrix_whatsapp_ynh/issues
Developer info
Please send your pull request to the testing
branch.
To try the testing
branch, please proceed like that:
sudo yunohost app install https://github.com/YunoHost-Apps/mautrix_whatsapp_ynh/tree/testing --debug
or
sudo yunohost app upgrade mautrix_whatsapp -u https://github.com/YunoHost-Apps/mautrix_whatsapp_ynh/tree/testing --debug
More info regarding app packaging: https://yunohost.org/packaging_apps