fix(admin): antivirus occ commands

Including feedback from PR review of nextcloud#10711. Signed-off-by: Max <[email protected]> Signed-off-by: Adriano Cataluddi <[email protected]>
acataluddi · Apr 28, 2024 · 400fbfb · 400fbfb
1 parent 968c090
commit 400fbfb
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 10 deletions.
diff --git a/admin_manual/configuration_server/antivirus_configuration.rst b/admin_manual/configuration_server/antivirus_configuration.rst
@@ -185,33 +185,33 @@ The background scanner does not require any manual intervention.
 However at times you might want to inspect it or perform tasks on it.
 
 Get info about files in the scan queue
-~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 ::
 
-    occ files_antvirus:status [-v]
+    sudo -u www php occ files_antivirus:status [-v]
 
 
 Manually trigger the background scan
-~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 ::
 
-    occ files_antivirus:background-scan [-v] [-m MAX]
+    sudo -u www php occ files_antivirus:background-scan [-v] [-m MAX]
 
 Manually scan a single file
-~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 ::
 
-    occ files_antvirus:scan <path>
+    sudo -u www php occ files_antivirus:scan <path>
 
-Mark a file as scanned or unscanned.
-~~~~~~~~
+Mark a file as scanned or unscanned
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 ::
 
-    occ files_antivirus:mark <path> <scanned|unscanned>
+    sudo -u www php occ files_antivirus:mark <path> <scanned|unscanned>
   
 Files marked as scanned will not be scanned for the next four weeks.
 
@@ -230,4 +230,4 @@ Disabling background scan task
 
 You can disable background scan with occ to only scan files during upload::
 
-    occ config:app:set files_antivirus av_background_scan --value="off"
+    sudo -u www php occ config:app:set files_antivirus av_background_scan --value="off"
diff --git a/admin_manual/configuration_server/occ_command.rst b/admin_manual/configuration_server/occ_command.rst
@@ -42,6 +42,7 @@ occ command Directory
 * :ref:`two_factor_auth_label`
 * :ref:`disable_user_label`
 * :ref:`system_tags_commands_label`
+* :ref:`antivirus_commands_label`
 * `Debugging`_
 
 .. _http_user_label:
@@ -1717,6 +1718,27 @@ invisible  No       No
 | ¹ User can see the tag
 | ² User can assign the tag to a file
 
+.. _antivirus_commands_label:
+
+Antivirus
+---------
+
+Get info about files in the scan queue::
+
+  sudo -u www php occ files_antivirus:status [-v]
+
+Manually trigger the background scan::
+
+  sudo -u www php occ files_antivirus:background-scan [-v] [-m MAX]
+
+Manually scan a single file::
+
+  sudo -u www php occ files_antivirus:scan <path>
+
+Mark a file as scanned or unscanned::
+
+  sudo -u www php occ files_antivirus:mark <path> <scanned|unscanned>
+
 .. _occ_debugging:
 
 Debugging