mirror of https://github.com/YunoHost-Apps/mautrix_whatsapp_ynh.git synced 2024-09-03 19:46:01 +02:00

Matrix Whatsapp pupetting bridge for YunoHost

closember mautrix-whatsapp yunohost-apps

Find a file

Yunohost-Bot fec78a8670 [autopatch] TEST BEFORE MERGE ynh_setup_source --full_replace=1		2024-03-11 16:06:25 +01:00
.githooks	Improve autoupdater to sync config.yaml	2023-03-01 20:13:23 +00:00
.github	Fix updater.sh new releases and typo	2023-09-30 00:18:01 +01:00
conf	Upgrade to v0.10.5	2023-12-17 06:13:54 +00:00
doc	Maintain consistency	2023-12-12 16:55:52 +00:00
scripts	[autopatch] TEST BEFORE MERGE ynh_setup_source --full_replace=1	2024-03-11 16:06:25 +01:00
.gitignore	Initial commit	2020-04-15 00:22:51 +02:00
config_panel.toml	Packaging v2 WIP	2023-06-04 21:30:13 +01:00
LICENSE	AGPL 3	2020-04-15 09:31:21 +02:00
manifest.toml	Fix autoupdate	2024-02-24 19:45:53 +01:00
README.md	Auto-update README	2024-02-15 17:53:37 +00:00
README_es.md	Add Spanish docs	2023-12-12 16:51:14 +00:00
README_fr.md	Auto-update README	2024-02-15 17:53:37 +00:00
tests.toml	Create new docs and fix linter issues	2023-08-02 12:09:55 +01:00

README.md

Matrix-WhatsApp bridge for YunoHost

Lire ce readme en français.

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.5~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