diff --git a/README.md b/README.md index 27f9715..b59f872 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ Therefore, [Synapse for YunoHost](https://github.com/YunoHost-Apps/synapse_ynh) ** Attention: always backup and restore the Yunohost matrix_synapse et mautrix_whatsapp apps together!** -**Shipped version:** 0.7.1~ynh1 +**Shipped version:** 0.8.0~ynh1 ## Disclaimers / important information ## List of known public services @@ -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 2de1596..e4e77c2 100644 --- a/README_fr.md +++ b/README_fr.md @@ -24,7 +24,7 @@ C'est pourquoi [Synapse for YunoHost](https://github.com/YunoHost-Apps/synapse_y ** Attention : sauvegardez et restaurez toujours les deux applications Yunohost matrix_synapse et mautrix_whatsapp en même temps!** -**Version incluse :** 0.7.1~ynh1 +**Version incluse :** 0.8.0~ynh1 ## Avertissements / informations importantes ## Liste de passerelles publiques @@ -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. diff --git a/conf/amd64.src b/conf/amd64.src index 55c4ed4..17056fd 100644 --- a/conf/amd64.src +++ b/conf/amd64.src @@ -1,5 +1,5 @@ -SOURCE_URL=https://github.com/mautrix/whatsapp/releases/download/v0.7.1/mautrix-whatsapp-amd64 -SOURCE_SUM=0679bc54f825b202d9498f6e079386d3473369dde2e3c656b1a5a067249105f2 +SOURCE_URL=https://github.com/mautrix/whatsapp/releases/download/v0.8.0/mautrix-whatsapp-amd64 +SOURCE_SUM=b7fcef1d665c08fb3fd0c24f65ab179aeef24d1558ef539374887f635bcd7c0e SOURCE_SUM_PRG=sha256sum SOURCE_IN_SUBDIR=false SOURCE_FILENAME=mautrix-whatsapp diff --git a/conf/arm64.src b/conf/arm64.src index b299312..3916508 100644 --- a/conf/arm64.src +++ b/conf/arm64.src @@ -1,5 +1,5 @@ -SOURCE_URL=https://github.com/mautrix/whatsapp/releases/download/v0.7.1/mautrix-whatsapp-arm64 -SOURCE_SUM=a537598b6e63d71620afe8b7d8f05744524fb5c5bf1a54d4b5a404e3033556ad +SOURCE_URL=https://github.com/mautrix/whatsapp/releases/download/v0.8.0/mautrix-whatsapp-arm64 +SOURCE_SUM=389f126bb25ad0d8173a761f59a731a351eb02f1d95478cc5e3e2af1ff97b1c3 SOURCE_SUM_PRG=sha256sum SOURCE_IN_SUBDIR=false SOURCE_FILENAME=mautrix-whatsapp diff --git a/conf/armhf.src b/conf/armhf.src index 9386828..5296888 100644 --- a/conf/armhf.src +++ b/conf/armhf.src @@ -1,5 +1,5 @@ -SOURCE_URL=https://github.com/mautrix/whatsapp/releases/download/v0.7.1/mautrix-whatsapp-arm -SOURCE_SUM=25424f6b57563127387c1fd11337ce1a08e8c18d493808f99caa043bd85e538d +SOURCE_URL=https://github.com/mautrix/whatsapp/releases/download/v0.8.0/mautrix-whatsapp-arm +SOURCE_SUM=5ebe0488106ed1377a76380639a41eca473eafb3b8f24396005a2999a350de46 SOURCE_SUM_PRG=sha256sum SOURCE_IN_SUBDIR=false SOURCE_FILENAME=mautrix-whatsapp diff --git a/conf/config.yaml b/conf/config.yaml index e4d18d7..43ad784 100644 --- a/conf/config.yaml +++ b/conf/config.yaml @@ -2,7 +2,7 @@ homeserver: # The address that this appservice can use to connect to the homeserver. address: https://__DOMAIN__ - # The domain of the homeserver (for MXIDs, etc). + # The domain of the homeserver (also known as server_name, used for MXIDs, etc). domain: __SERVER_NAME__ # What software is the homeserver running? @@ -29,11 +29,12 @@ appservice: # Database config. database: - # The database type. "sqlite3" and "postgres" are supported. + # The database type. "sqlite3-fk-wal" and "postgres" are supported. #type: sqlite3 type: postgres # The database URI. - # SQLite: File name is enough. https://github.com/mattn/go-sqlite3#connection-string + # SQLite: A raw file path is supported, but `file:?_txlock=immediate` is recommended. + # https://github.com/mattn/go-sqlite3#connection-string # Postgres: Connection string. For example, postgres://user:password@host/database?sslmode=disable # To connect via Unix socket, use something like postgres:///dbname?host=/var/run/postgresql uri: postgres://__APP__:__DB_PWD__@localhost:5432/__DB_NAME__ @@ -63,6 +64,11 @@ appservice: # You should disable bridge -> sync_with_custom_puppets when this is enabled. ephemeral_events: __EPHEMERAL_EVENTS__ + # Should incoming events be handled asynchronously? + # This may be necessary for large public instances with lots of messages going through. + # However, messages will not be guaranteed to be bridged in the same order they were sent in. + async_transactions: false + # Authentication tokens for AS <-> HS communication. Autogenerated; do not modify. as_token: "This value is generated when generating the registration" hs_token: "This value is generated when generating the registration" @@ -296,6 +302,8 @@ bridge: # Send captions in the same message as images. This will send data compatible with both MSC2530 and MSC3552. # This is currently not supported in most clients. caption_in_message: false + # Should polls be sent using MSC3381 event types? + extev_polls: false # Should Matrix edits be bridged to WhatsApp edits? # Official WhatsApp clients don't render edits yet, but once they do, the bridge should work with them right away. send_whatsapp_edits: false 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. diff --git a/manifest.json b/manifest.json index df4a8f4..be6513d 100644 --- a/manifest.json +++ b/manifest.json @@ -6,7 +6,7 @@ "en": "Matrix / Synapse puppeting bridge for WhatsApp", "fr": "Passerelle Matrix / Synapse pour WhatsApp" }, - "version": "0.7.1~ynh1", + "version": "0.8.0~ynh1", "url": "https://github.com/mautrix/whatsapp", "upstream": { "license": "AGPL-3.0-or-later",