Skip to content

Commit fa265e4

Browse files
committed
Document new setting to require secure backup
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 element-hq#14954
1 parent 8b0eafe commit fa265e4

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

docs/e2ee.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ For private room creation, Element will default to encryption on but give you th
77

88
Set the following on your homeserver's
99
`/.well-known/matrix/client` config:
10+
1011
```json
1112
{
1213
"im.vector.e2ee": {
@@ -15,6 +16,25 @@ Set the following on your homeserver's
1516
}
1617
```
1718

19+
# Secure backup
20+
21+
By default, Element strongly encourages (but does not require) users to set up
22+
Secure Backup so that cross-signing identity key and message keys can be
23+
recovered in case of a disaster where you lose access to all active devices.
24+
25+
## Requiring secure backup
26+
27+
To require Secure Backup to be configured before Element can be used, set the
28+
following on your homeserver's `/.well-known/matrix/client` config:
29+
30+
```json
31+
{
32+
"im.vector.e2ee": {
33+
"secureBackupRequired": true
34+
}
35+
}
36+
```
37+
1838
# Compatibility
1939

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

0 commit comments

Comments
 (0)