Compare commits

...

7 Commits

Author SHA1 Message Date
mxandreas
c7ae26bc6c Merge branch 'develop' into e2ee-recovery-docs-update 2025-09-05 07:02:19 +03:00
Richard van der Hoff
59cfac2dc1 prettier 2025-09-04 17:33:55 +01:00
mxandreas
cc42ffae38 Merge branch 'develop' into e2ee-recovery-docs-update 2025-09-04 09:13:28 +03:00
mxandreas
1951ed71ae Use removal, not deprecation for sake of clarity.
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2025-09-04 09:10:42 +03:00
mxandreas
ffeb16ea9d Use removal, not deprecation for sake of clarity.
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2025-09-04 09:09:52 +03:00
mxandreas
e42b4873de Wording enhancements.
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2025-09-04 09:09:25 +03:00
mxandreas
75b6f84e5c Deprecate secure_backup_required and secure_backup_setup_methods in docs. 2025-09-03 13:36:18 +03:00

View File

@@ -38,45 +38,20 @@ When `force_disable` is true:
Note: If the server is configured to forcibly enable encryption for some or all rooms,
this behaviour will be overridden.
# Secure backup
# Setting up recovery
By default, Element strongly encourages (but does not require) users to set up
Secure Backup so that cross-signing identity key and message keys can be
recovered in case of a disaster where you lose access to all active devices.
recovery so that you can access history on your new devices as well as retain access to your message history and cryptographic identity when you lose all of your devices.
## Requiring secure backup
## Removal of old settings
To require Secure Backup to be configured before Element can be used, set the
following on your homeserver's `/.well-known/matrix/client` config:
Support for the configuration options `secure_backup_required` and `secure_backup_setup_methods`
in the `/.well-known/matrix/client` config has been removed.
```json
{
"io.element.e2ee": {
"secure_backup_required": true
}
}
```
## Preferring setup methods
By default, Element offers users a choice of a random key or user-chosen
passphrase when setting up Secure Backup. If a homeserver admin would like to
only offer one of these, you can signal this via the
`/.well-known/matrix/client` config, for example:
```json
{
"io.element.e2ee": {
"secure_backup_setup_methods": ["passphrase"]
}
}
```
The field `secure_backup_setup_methods` is an array listing the methods the
client should display. Supported values currently include `key` and
`passphrase`. If the `secure_backup_setup_methods` field is not present or
exists but does not contain any supported methods, Element will fallback to the
default value of: `["key", "passphrase"]`.
Setting up recovery is now always recommended to all users by showing a one-off toast and a
permanent red dot on the _Encryption_ tab in the _Settings_ dialog. When creating a new
recovery key, the UI only supports auto-generated keys. Using an existing (custom) passphrase
still works, but is not exposed in the UI when setting up recovery.
# Compatibility