Skip to content

Commit

Permalink
Document new setting to require secure backup
Browse files Browse the repository at this point in the history
This adds notes on configuring the new `.well-known` setting to require Element
users to set up secure backup before continuing into the app.

Part of #14954
  • Loading branch information
jryans committed Aug 19, 2020
1 parent 8b0eafe commit fa265e4
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/e2ee.md
Expand Up @@ -7,6 +7,7 @@ For private room creation, Element will default to encryption on but give you th

Set the following on your homeserver's
`/.well-known/matrix/client` config:

```json
{
"im.vector.e2ee": {
Expand All @@ -15,6 +16,25 @@ Set the following on your homeserver's
}
```

# Secure backup

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.

## Requiring secure backup

To require Secure Backup to be configured before Element can be used, set the
following on your homeserver's `/.well-known/matrix/client` config:

```json
{
"im.vector.e2ee": {
"secureBackupRequired": true
}
}
```

# Compatibility

The settings above were first proposed under a `im.vector.riot.e2ee` key, which
Expand Down

0 comments on commit fa265e4

Please sign in to comment.