feat(admin): document preview:cleanup occ command

Ref nextcloud/server#48537 Signed-off-by: Thomas Citharel <tcit@tcit.fr>
nextcloud · Jan 7, 2025 · d93e2cf · d93e2cf
1 parent 82b00ab
commit d93e2cf
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/admin_manual/configuration_files/previews_configuration.rst b/admin_manual/configuration_files/previews_configuration.rst
@@ -33,6 +33,9 @@ values.
 
 But deemed necessary, following changes have to be made in ``config/config.php`` file. As a best practice, take a backup of this config file before making a lot of changes.
 
+After changing one or more of the following parameters, you might want to run the ``preview:cleanup`` occ command to get rid of the previews with obsolete settings.
+See :ref:`occ_cleanup_previews` to learn more.
+
 Disabling previews:
 ^^^^^^^^^^^^^^^^^^^
 

diff --git a/admin_manual/occ_command.rst b/admin_manual/occ_command.rst
@@ -872,6 +872,18 @@ with the files on the actual storage.::
   Arguments:
     folder                 The appdata subfolder to scan [default: ""]
 
+.. _occ_cleanup_previews:
+
+Cleanup previews
+^^^^^^^^^^^^^^^^
+
+``preview:cleanup`` removes all of the server's preview files. This is useful
+when changing the previews configuration (sizes, quality or file), and especially
+on systems using Object Storage as Primary Storage where the ``appdata_xxx/preview``
+folder can't simply be deleted.
+
+See :doc:`configuration_files/previews_configuration`.
+
 
 Cleanup
 ^^^^^^^