Skip to content

Commit 14d279a

Browse files
authored
Merge pull request #14485 from nextcloud/feat/admin-manual/orphaned-key
docs(admin): document encryption:clean-orphaned-keys occ command
2 parents 9694cbf + 38b647f commit 14d279a

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

admin_manual/occ_files.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ Encryption
1111

1212
encryption
1313
encryption:change-key-storage-root Change key storage root
14+
encryption:clean-orphaned-keys Scan the keys storage for orphaned
15+
keys and remove them
1416
encryption:decrypt-all Disable server-side encryption and
1517
decrypt all files
1618
encryption:disable Disable encryption
@@ -84,6 +86,16 @@ will be migrated to drop their legacy filekey on the first modification. If you
8486
old files from Nextcloud<25 still using base64 encoding this will migrate them to the
8587
binary format and save about 33% disk space.
8688

89+
``encryption:clean-orphaned-keys`` scans the key storage for keys that no longer
90+
have a corresponding file and removes them. When run, it iterates over all user
91+
key stores, reports any orphaned keys found, and then interactively asks whether
92+
to delete all of them at once or specific ones individually::
93+
94+
sudo -E -u www-data php occ encryption:clean-orphaned-keys [<user>]
95+
96+
The optional ``user`` argument limits the scan to a single user. If omitted, all
97+
users are scanned.
98+
8799
See :doc:`../configuration_files/encryption_configuration` to learn more.
88100

89101
.. _federation_sync_label:

0 commit comments

Comments
 (0)