You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: address review feedback on recovery key documentation
Implement suggestions from @artonge and @schiessle to reduce verbosity and avoid
encouraging unnecessary migration to per-user key mode:
Changes:
- Remove vague 'performance and compatibility' claims from master key section
- Simplify recovery key descriptions to avoid encouraging adoption
- Delete duplicate caution box before recovery keys section
- Remove instructions on switching to per-user key mode
- Reframe per-user keys as compatibility option for legacy/older setups
- Add warning about recovery process being slow and resource-intensive
- Clarify that master key mode is the default and recommended approach
Key changes respond to review feedback:
- Avoid 'generating a need' for recovery keys when they're not needed in default mode
- Position per-user keys as historical compatibility option, not new choice
- Reduce overall verbosity while keeping core clarification of issue #1340
Addresses review comments on PR #14791
Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
Copy file name to clipboardExpand all lines: admin_manual/configuration_files/encryption_configuration.rst
+18-27Lines changed: 18 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -123,17 +123,15 @@ Key Management Modes
123
123
124
124
- All files are encrypted with a central server-controlled key.
125
125
- Admins can decrypt any user’s files.
126
-
- Offers better performance and compatibility with more login/authentication modes.
127
-
- **Recovery keys are not available in master key mode.** If a user forgets their password, admins can reset it and files remain accessible (protected by the master key, not the user password).
128
-
- Recommended for most deployments due to improved performance and compatibility.
126
+
- **Recovery keys are not available in master key mode.** Files remain accessible if a user forgets their password, as they are encrypted by the master key, not the user password.
127
+
- Recommended for most deployments.
129
128
130
129
**User Keys:**
131
130
132
131
- Each user’s files are encrypted with a password-protected key.
133
132
- Admins cannot (readily) decrypt files without the user's password, unless a recovery key is defined.
134
-
- **Recovery keys are available in user key mode** as an optional safeguard: if a user forgets their password, admins can use the recovery key to reset access.
135
133
- If a user forgets their password and no recovery key exists, their files are lost.
136
-
- This mode requires more resources and does not work with all authentication methods (e.g., app passwords, single sign-on).
134
+
- This mode does not work with all authentication methods (e.g., app passwords, single sign-on) and is only recommended for compatibility with older setups.
137
135
138
136
**How to choose:**
139
137
@@ -313,19 +311,18 @@ User Keys: Sharing & Recovery
313
311
314
312
**Enabling file recovery keys:**
315
313
316
-
.. caution::
317
-
Recovery keys are **only available in per-user key mode**, not in the default master key mode.
318
-
If you do not see recovery key options in your Admin Encryption settings, your instance is using
319
-
master key mode (the default and recommended mode). To use recovery keys, you must first switch
320
-
to per-user key mode by running ``occ encryption:disable-master-key`` on a fresh installation
321
-
(before any files are encrypted).
314
+
Recovery keys are only available in per-user key mode (not the default master key mode).
322
315
323
316
- If you lose your Nextcloud password, you lose access to your encrypted files.
324
317
- If a user loses their password, their files are unrecoverable unless a recovery key is enabled (per-user key mode only).
325
318
- To enable recovery (in per-user key mode), go to Encryption in Admin page and set a recovery key password.
326
319
- Users must enable password recovery in their Personal settings for the Recovery Key to work.
327
320
- For users who have enabled password recovery, admins can reset passwords and recover files using the Recovery Key.
328
321
322
+
.. warning::
323
+
The recovery process can be slow and resource-intensive, especially for instances with large amounts of encrypted data.
324
+
Test recovery procedures before relying on them in production.
325
+
329
326
.. figure:: images/encryption10.png
330
327
.. figure:: images/encryption7.png
331
328
.. figure:: images/encryption8.png
@@ -343,24 +340,18 @@ Troubleshooting
343
340
Why don't I see the recovery key option in the Encryption settings?
0 commit comments