From fa1367335afabd7a24f7dd6b1878b3dde6d044cf Mon Sep 17 00:00:00 2001 From: Dante Date: Sun, 27 Nov 2022 11:47:03 +0000 Subject: [PATCH 1/3] Add docs for e2be --- README.md | 6 ++++++ README_fr.md | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/README.md b/README.md index 27f9715..b65ca65 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,12 @@ following configuration file with SSH: ```/opt/yunohost/mautrix_whatsapp/config.yaml``` and then restarting the mautrix_whatsapp service. +#### End-to-bridge encryption +The bridge can optionally encrypt messages between Matrix users and the bridge to hide messages from the homeserver. Using Postgres is strongly recommended when using end-to-bridge encryption. + +If you want to enable it, look for the option ```bridge → encryption``` in the config file. If you only set ```allow: true```, the bridge won't enable encryption on its own, but will work in encrypted rooms. If you set ```default: true```, the bridge will automatically enable encryption in new portals. +There is also the possibility to set ```require: true``` to enforce encryption on any of the messages that you send (this will drop any unencrypted messages). + ## YunoHost specific features #### Multi-user support diff --git a/README_fr.md b/README_fr.md index fd25968..ec22e34 100644 --- a/README_fr.md +++ b/README_fr.md @@ -58,6 +58,12 @@ La passerelle est [configurée avec les paramètres standards adaptés pour votr 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. From 3243827dda363ea0ffa1ab7a20d5dceb0986aa8a Mon Sep 17 00:00:00 2001 From: Dante Date: Sun, 27 Nov 2022 11:51:06 +0000 Subject: [PATCH 2/3] Add docs for e2be on doc files --- README.md | 6 ------ README_fr.md | 6 ------ doc/DISCLAIMER.md | 6 ++++++ doc/DISCLAIMER_fr.md | 6 ++++++ 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index b65ca65..27f9715 100644 --- a/README.md +++ b/README.md @@ -71,12 +71,6 @@ following configuration file with SSH: ```/opt/yunohost/mautrix_whatsapp/config.yaml``` and then restarting the mautrix_whatsapp service. -#### End-to-bridge encryption -The bridge can optionally encrypt messages between Matrix users and the bridge to hide messages from the homeserver. Using Postgres is strongly recommended when using end-to-bridge encryption. - -If you want to enable it, look for the option ```bridge → encryption``` in the config file. If you only set ```allow: true```, the bridge won't enable encryption on its own, but will work in encrypted rooms. If you set ```default: true```, the bridge will automatically enable encryption in new portals. -There is also the possibility to set ```require: true``` to enforce encryption on any of the messages that you send (this will drop any unencrypted messages). - ## YunoHost specific features #### Multi-user support diff --git a/README_fr.md b/README_fr.md index ec22e34..fd25968 100644 --- a/README_fr.md +++ b/README_fr.md @@ -58,12 +58,6 @@ La passerelle est [configurée avec les paramètres standards adaptés pour votr 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. diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md index c64e70e..735b94b 100644 --- a/doc/DISCLAIMER.md +++ b/doc/DISCLAIMER.md @@ -42,6 +42,12 @@ following configuration file with SSH: ```/opt/yunohost/mautrix_whatsapp/config.yaml``` and then restarting the mautrix_whatsapp service. +#### End-to-bridge encryption +The bridge can optionally encrypt messages between Matrix users and the bridge to hide messages from the homeserver. Using Postgres is strongly recommended when using end-to-bridge encryption. + +If you want to enable it, look for the option ```bridge → encryption``` in the config file. If you only set ```allow: true```, the bridge won't enable encryption on its own, but will work in encrypted rooms. If you set ```default: true```, the bridge will automatically enable encryption in new portals. +There is also the possibility to set ```require: true``` to enforce encryption on any of the messages that you send (this will drop any unencrypted messages). + ## YunoHost specific features #### Multi-user support diff --git a/doc/DISCLAIMER_fr.md b/doc/DISCLAIMER_fr.md index a6abd6f..cd9208c 100644 --- a/doc/DISCLAIMER_fr.md +++ b/doc/DISCLAIMER_fr.md @@ -29,6 +29,12 @@ La passerelle est [configurée avec les paramètres standards adaptés pour votr 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. From 87d67ab296e7bf9400be41adc971ef5d927100c9 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Sun, 27 Nov 2022 11:51:39 +0000 Subject: [PATCH 3/3] Auto-update README --- README.md | 6 ++++++ README_fr.md | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/README.md b/README.md index 27f9715..b65ca65 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,12 @@ following configuration file with SSH: ```/opt/yunohost/mautrix_whatsapp/config.yaml``` and then restarting the mautrix_whatsapp service. +#### End-to-bridge encryption +The bridge can optionally encrypt messages between Matrix users and the bridge to hide messages from the homeserver. Using Postgres is strongly recommended when using end-to-bridge encryption. + +If you want to enable it, look for the option ```bridge → encryption``` in the config file. If you only set ```allow: true```, the bridge won't enable encryption on its own, but will work in encrypted rooms. If you set ```default: true```, the bridge will automatically enable encryption in new portals. +There is also the possibility to set ```require: true``` to enforce encryption on any of the messages that you send (this will drop any unencrypted messages). + ## YunoHost specific features #### Multi-user support diff --git a/README_fr.md b/README_fr.md index fd25968..ec22e34 100644 --- a/README_fr.md +++ b/README_fr.md @@ -58,6 +58,12 @@ La passerelle est [configurée avec les paramètres standards adaptés pour votr 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.