diff --git a/README.md b/README.md index cd5ecb8..639ba8a 100644 --- a/README.md +++ b/README.md @@ -61,6 +61,13 @@ following configuration file with SSH: ```/opt/yunohost/mautrix_telegram/config.yaml``` and then restarting the mautrix_telegram 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). + ## Documentation * Official "Mautrix-Telegram" documentation: https://docs.mau.fi/bridges/python/telegram/index.html diff --git a/README_fr.md b/README_fr.md index a43d9aa..c6388a0 100644 --- a/README_fr.md +++ b/README_fr.md @@ -57,6 +57,20 @@ See also [upstream wiki Authentication page](https://docs.mau.fi/bridges/python/ ### Relaybot: Bridge a group for several Matrix and several Telegram users to chat together * see https://docs.mau.fi/bridges/python/telegram/relay-bot.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_telegram_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). + ## Documentation * Official "Mautrix-Telegram" documentation: https://docs.mau.fi/bridges/python/telegram/index.html diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md index a90916a..004b659 100644 --- a/doc/DISCLAIMER.md +++ b/doc/DISCLAIMER.md @@ -38,6 +38,13 @@ following configuration file with SSH: ```/opt/yunohost/mautrix_telegram/config.yaml``` and then restarting the mautrix_telegram 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). + ## Documentation * Official "Mautrix-Telegram" documentation: https://docs.mau.fi/bridges/python/telegram/index.html diff --git a/doc/DISCLAIMER_fr.md b/doc/DISCLAIMER_fr.md index 715e1d0..e55f34f 100644 --- a/doc/DISCLAIMER_fr.md +++ b/doc/DISCLAIMER_fr.md @@ -31,6 +31,20 @@ See also [upstream wiki Authentication page](https://docs.mau.fi/bridges/python/ ### Relaybot: Bridge a group for several Matrix and several Telegram users to chat together * see https://docs.mau.fi/bridges/python/telegram/relay-bot.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_telegram_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). + ## Documentation * Official "Mautrix-Telegram" documentation: https://docs.mau.fi/bridges/python/telegram/index.html