Skip to content

Commit 2a7b58a

Browse files
committed
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>
1 parent b479333 commit 2a7b58a

1 file changed

Lines changed: 18 additions & 27 deletions

File tree

admin_manual/configuration_files/encryption_configuration.rst

Lines changed: 18 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -123,17 +123,15 @@ Key Management Modes
123123

124124
- All files are encrypted with a central server-controlled key.
125125
- 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.
129128

130129
**User Keys:**
131130

132131
- Each user’s files are encrypted with a password-protected key.
133132
- 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.
135133
- 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.
137135

138136
**How to choose:**
139137

@@ -313,19 +311,18 @@ User Keys: Sharing & Recovery
313311

314312
**Enabling file recovery keys:**
315313

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).
322315

323316
- If you lose your Nextcloud password, you lose access to your encrypted files.
324317
- If a user loses their password, their files are unrecoverable unless a recovery key is enabled (per-user key mode only).
325318
- To enable recovery (in per-user key mode), go to Encryption in Admin page and set a recovery key password.
326319
- Users must enable password recovery in their Personal settings for the Recovery Key to work.
327320
- For users who have enabled password recovery, admins can reset passwords and recover files using the Recovery Key.
328321

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+
329326
.. figure:: images/encryption10.png
330327
.. figure:: images/encryption7.png
331328
.. figure:: images/encryption8.png
@@ -343,24 +340,18 @@ Troubleshooting
343340
Why don't I see the recovery key option in the Encryption settings?
344341
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
345342

346-
Recovery keys are **only available in per-user key mode**. Since Nextcloud 13, the default
347-
encryption mode uses **master keys** (system-wide encryption), which offer better performance
348-
and compatibility. Master key mode does not expose recovery key options in the Admin settings
349-
because recovery keys are not needed—admins can reset user passwords and files remain accessible.
350-
351-
If you need recovery key functionality, you must switch to per-user key mode before encrypting
352-
any files::
353-
354-
occ encryption:disable-master-key
355-
356-
This command only works on fresh installations without existing encrypted data.
343+
Recovery keys are only available in per-user key mode. Since Nextcloud 13, the default
344+
encryption mode uses master keys (system-wide encryption). Master key mode does not expose
345+
recovery key options in the Admin settings because recovery keys are not needed—admins can
346+
reset user passwords and files remain accessible.
357347

358-
For most use cases, **master key mode is recommended**. Recovery keys add complexity and are only
359-
needed in edge cases where per-user key encryption is required. See :ref:`Key Management Modes
360-
<encryption_configuration_key_management_modes>` for guidance on choosing the right mode.
348+
If you are using master key mode (the default and recommended mode), you do not need recovery
349+
keys. Recovery keys are only relevant for per-user key setups, which are maintained for
350+
compatibility with older deployments.
361351

362-
See also `GitHub Issue #8283 <https://github.com/nextcloud/server/issues/8283>`_ for technical
363-
context on this design decision.
352+
See :ref:`Key Management Modes <encryption_configuration_key_management_modes>` for guidance
353+
on the differences between master key and per-user key modes, and `GitHub Issue #8283
354+
<https://github.com/nextcloud/server/issues/8283>`_ for technical context on this design decision.
364355

365356
Invalid private key for encryption app
366357
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)