From 4c5c2ead23b7ad063e859cfa46e5f61551921822 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Wed, 2 Aug 2023 11:10:25 +0000 Subject: [PATCH] Auto-update README --- README.md | 105 --------------------------------------------------- README_fr.md | 89 ------------------------------------------- 2 files changed, 194 deletions(-) diff --git a/README.md b/README.md index dcff677..4139d18 100644 --- a/README.md +++ b/README.md @@ -26,111 +26,6 @@ Therefore, [Synapse for YunoHost](https://github.com/YunoHost-Apps/synapse_ynh) **Shipped version:** 0.9.0~ynh1 -## Disclaimers / important information - -## List of known public services - -* Ask on one of the following rooms: #mautrix_yunohost:matrix.fdn.fr or #whatsapp:maunium.net - -## Bridging usage -** Note that several WhatsApp and Matrix users can be bridged, each WhatsApp account has its own bot administration room. If they are in a same WhatsApp group, only one matrix room will be created. ** - -### Bridge a WhatsApp user and a Matrix user -* First your matrix user or server has to be authorized in the bridge configuration (see below) -* Then, invite the bot (default @whatsappbot:yoursynapse.domain) -* The room with the Mautrix-WhatsApp bot is called "administration room". -* Type ``login`` -* Capture the QR code with the camera in the whatsapp of your VM or smartphone (WhatsApp Web) -* Send ``help`` to the bot in the created room to know how to control the bot. -See also [upstream wiki Authentication page](https://docs.mau.fi/bridges/go/whatsapp/authentication.html) - -### Bridge an existing room | Bridge Whatsapp to Signal over Matrix -By default, the bridge creates a portal room for each WA group that the WA user actively uses. -Your can also create a portal for an existing Matrix room. **Note that this can be a room created by another bridge, e.g. a Signal portal room** -1. Invite the bridge bot to the room (with an authorized user) -2. type `!wa create` -3. Your logged in WA user creates a new corresponding group. -4. Get the WA invite link `!wa invite-link` and share it with friends. Or invite Whatsapp puppets to room. -5. Optional: Activate relaybot, see next section. - -### Relaybot: Bridge a group for several Matrix and several WhatsApp users to chat together -**When upgrading from /dev/null | awk '/-----BEGIN CERTIFICATE-----/, /-----END CERTIFICATE-----/' >> /usr/local/share/ca-certificates/synapse.vm.crt -update-ca-certificates -``` - -### Miscellaneous information - - * Matrix room (matrix bridges in YunoHost): #mautrix_yunohost:matrix.fdn.fr - * Matrix room (upstream app): #whatsapp:maunium.net -In case you need to upload your logs somewhere, be aware that they contain your contacts' and your phone numbers. Strip them out with -``| sed -r 's/[0-9]{10,}/📞/g' `` - * "Mautrix-WhatsApp" bridge is based on the [Rhymen/go-whatsapp](https://github.com/Rhymen/go-whatsapp) implementation of the [sigalor/whatsapp-web-reveng](https://github.com/sigalor/whatsapp-web-reveng) project. - -## Development code quality - -The `.github/workflows/updater.sh` script needs to be synced with changes in `conf/config.yaml` therefore a `pre-commit` -hook is used to display a reminder to update `.github/workflows/updater.sh` (if needed) when `conf/config.yaml` has been modified. - -Please enable Git hooks using following command to ensure code quality and stability. -``` bash -git config --local core.hooksPath .githooks -``` ## Documentation and resources * Official app website: diff --git a/README_fr.md b/README_fr.md index b3e6656..fb5b4e2 100644 --- a/README_fr.md +++ b/README_fr.md @@ -26,95 +26,6 @@ C'est pourquoi [Synapse for YunoHost](https://github.com/YunoHost-Apps/synapse_y **Version incluse :** 0.9.0~ynh1 -## Avertissements / informations importantes - -## Liste de passerelles publiques - -* Demandez sur un des salons suivants: #mautrix_yunohost:matrix.fdn.fr or #whatsapp:maunium.net - -## Usages de la passerelle -** Notez que plusieurs comptes WhatsApp et Matrix peuvent ĂȘtre relayĂ©s, chaque compte WhatsApp connectĂ© a son propre Salon d'Administration. Si plusieurs utilisateur.ice.s du Robot sont dans un mĂȘme groupe WhatsApp, seul un Salon Matrix sera crĂ©Ă© par la passerelle. ** - -### Relayer TOUTES les conversations entre UN compte WhatsApp et UN compte Matrix -* PrĂ©requis : votre compte Matrix ou le serveur sur lequel il est hĂ©bergĂ© doit ĂȘtre autorisĂ© dans la configuration de la passerelle (voir ci-dessous) -* Invitez le Robot (par dĂ©faut @whatsappbot:synapse.votredomaine) Ă  une nouvelle conversation. -* Ce nouveau salon d'administration du Robot Mautrix-WhatsApp est appelĂ© "Administration Room". -* Tapez ``login`` -* Scannez le QR-code avec la camĂ©ra Whatsapp de votre Machine Virtuelle ou ordiphone (option WhatsApp Web dans l'appli) -* Envoyez ``help`` au Robot dans le "Administration Room" pour une liste des commandes d'administration de la passerelle. -Voir aussi [upstream wiki Authentication page](https://docs.mau.fi/bridges/go/whatsapp/authentication.html) - -#### Robot-Relai "Relaybot": Relayer les conversations de TOUS les comptes Matrix et TOUS les comptes WhatsApp prĂ©sents dans UN groupe/salon - -* PrĂ©requis : CrĂ©er un nouveau salon vide "Relaybot Administration Room" et rechercher son identifiant. -* Activer l'option Robot-Relai "Relaybot" dans la configuration de la passerelle (default=disabled, voir ci-dessous) et ajouter l'identifiant du salon d'administration du Relaybot "Relaybot Administration Room". -* RedĂ©marrer le service mautrix_whatsapp -* Vous pouvez maintenant relayer un groupe WhatsApp en y invitant le numĂ©ro de tĂ©lĂ©phone du compte WhatsApp connectĂ© au RobotRelai. CĂŽtĂ© WhatsApp, tous les messages venant de Matrix seront vus comme envoyĂ©s depuis le compte WhatsApp connectĂ©, avec un prĂ©fix indiquant le compte Matrix correspondant. CĂŽtĂ© Matrix, la passerelle va crĂ©er des comptes Matrix pour chaque compte WhatsApp prĂ©sent dans le groupe relayĂ©. Les messages sont indiquĂ©s comme provenant soit du numĂ©ro de tĂ©lĂ©phone, soit du pseudo WhatsApp. -Voir aussi [la page wiki principale sur le Robot-Relai](https://docs.mau.fi/bridges/go/whatsapp/relaybot.html) - -### Configuration de la passerelle - -La passerelle est [configurĂ©e avec les paramĂštres standards adaptĂ©s pour votre YunoHost et l'instance Matrix-Synapse sĂ©lectionnĂ©e](https://github.com/YunoHost-Apps/mautrix_whatsapp_ynh/blob/master/conf/config.yaml). Vous pouvez par exemple ajouter des administrateur.ice.s et utilisateur.ice.s du Robot autorisĂ©s en modifiant le fichier de configuration par liaison SSH: -``` sudo nano /opt/yunohost/mautrix_whatsapp/config.yaml``` -puis en redĂ©marrant le service: -``` sudo yunohost service restart mautrix_whatsapp``` - -#### End-to-bridge encryption -Le robot peut Ă©ventuellement chiffrer les messages entre les utilisateurs de Matrix et la passarelle pour cacher les messages du serveur domestique. L'utilisation de Postgres est fortement recommandĂ©e lors de l'utilisation du chiffrement end-to-bridge. - -Si vous voulez l'activer, cherchez l'option ```bridge → encryption``` dans le fichier de configuration. Si vous dĂ©finissez uniquement l'option ``allow: true``, le robot n'activera pas le chiffrement de lui-mĂȘme, mais travaillera dans les portails chiffrĂ©s. Si vous dĂ©finissez ```default: true```, la passerelle activera automatiquement le chiffrement dans les nouveaux portails. -Il y a Ă©galement la possibilitĂ© de dĂ©finir ```require: true``` pour imposer le chiffrement sur tous les messages que vous envoyez (cela interdira tous les messages non chiffrĂ©s). - -### Support multi-comptes - -* Les utilisateur.ice.s du Robot ne sont pas liĂ©s aux comptes Yunohost. N'importe quel compte Matrix ou serveur Synapse autorisĂ©s dans la configuration de la passerelle peut inviter/utiliser le Robot. -* Le robot WhatsApp est un utilisateur Matrix-Synapse local, mais accessible via la fĂ©dĂ©ration (Synapse public ou privĂ©). -* Plusieurs comptes WhatsApp et Matrix peuvent ĂȘtre liĂ©s avec une seule passerelle, chaque compte a son propre salon d'administration. -* Si plusieurs utilisateur.ice.s du Robot sont dans un mĂȘme groupe WhatsApp, seul un Salon Matrix sera crĂ©Ă© par la passerelle. Autrement dit, la passerelle construit un seul miroir du rĂ©seau de discussion existant sur WhatsApp (utilisateurs et salons). -* Voir https://github.com/YunoHost-Apps/synapse_ynh#multi-users-support - -### Support multi-instance - -* L'installation multi-instance devrait fonctionner. Plusieurs instances de passerelles pourraient ĂȘtre installĂ©es pour une instance de Matrix-Synapse. Cela permet Ă  un compte matrix de se relier Ă  plusieurs comptes WhatsApp. -* Plusieurs instances de passerelles pourraient ĂȘtre installĂ©es pour que chaque instance de Matrix-Synapse puisse en bĂ©nĂ©ficier. Mais une passerelle peut ĂȘtre utilisĂ©e par les comptes de plusieurs instances Matrix-Synapse. - -### Architectures supportĂ©es - -ARM, ARM64, AMD64 - -### Limitations - -* Les appels Audio/Video ne sont pas relayĂ©s. Seule une notification apparait. -* Si WhatsApp perd la connexion, par ex. l'ordiphone est mis en mode avion ou les notifications poussĂ©es sont dĂ©sactivĂ©es, le robot doit parfois ĂȘtre redĂ©marrĂ© Ă  la main en envoyant un message ``wa !reconnnect`` dans le salon d'administration. - -### Informations additionnelles - -* Il est recommandĂ© d'installer WhatsApp sur une machine Android virtuelle tournant sur un serveur, cf. le [page Android-VM-Setup du wiki](https://docs.mau.fi/bridges/go/whatsapp/android-vm-setup.html) - -Pour tester la communication entre le Service d'Application et Matrix-Synapse sur une Machine Virtuelle (ex. avec un nom de domaine: synapse.vm), vous devez installer un certificat: -``` -echo | openssl s_client -showcerts -servername synapse.vm -connect synapse.vm:443 2>/dev/null | awk '/-----BEGIN CERTIFICATE-----/, /-----END CERTIFICATE-----/' >> /usr/local/share/ca-certificates/synapse.vm.crt -update-ca-certificates -``` - -### Informations diverses - -* Salon Matrix sur les Passerelles dans Yunohost): #mautrix_yunohost:matrix.fdn.fr -* Salon Matrix (application principale): #whatsapp:maunium.net -Si vous devez tĂ©lĂ©verser vos fichiers log quelque-part, soyez avertis qu'ils contiennent des informations sur vos contacts et vos numĂ©ros de tĂ©lĂ©phone. Effacez-les avec -``| sed -r 's/[0-9]{10,}/📞/g' `` -* La passerelle "Mautrix-WhatsApp" repose sur l'implĂ©mentation [Rhymen/go-whatsapp](https://github.com/Rhymen/go-whatsapp) du projet [sigalor/whatsapp-web-reveng](https://github.com/sigalor/whatsapp-web-reveng). - -## Development code quality - -Le script `.github/workflows/updater.sh` doit ĂȘtre synchronisĂ© avec les changements dans `conf/config.yaml`, -donc un hook `pre-commit` est utilisĂ© pour afficher un rappel pour mettre Ă  jour -`.github/workflows/updater.sh` (si nĂ©cessaire) lorsque `conf/config.yaml` a Ă©tĂ© modifiĂ©. - -Veuillez activer les hooks Git en utilisant la commande suivante pour assurer la qualitĂ© et la stabilitĂ© du code. -``` bash -git config --local core.hooksPath .githooks -``` ## Documentations et ressources * Site officiel de l’app :