khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-03 02:09:45 +07:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #10711 from nextcloud/enh/virus-scanner-docs

Browse Source 
enh: add some more documentation for antivirus usage
This commit is contained in:
max-nextcloud
2024-01-07 22:46:32 +01:00
committed by GitHub
parent 16567f1072 9de4a83e8f
commit f208af5429
2 changed files with 69 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
admin_manual/configuration_server/antivirus_configuration.rst
View File

@@ -169,6 +169,51 @@ Executable
When you are satisfied with how ClamAV is operating, you might want to go
back and change all of your logging to less verbose levels.
Confirm everything is working
-----------------------------
Every antivirus provider implements a test virus string, that way tests are quite easy. You find the files here:
https://www.eicar.org/download-anti-malware-testfile/
Uploading the file will trigger an error:
"Virus Win.Test.EICAR_HDB-1 is detected in the file. Upload cannot be completed."
Manage the background scanner
-----------------------------
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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
::
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>
Files marked as scanned will not be scanned for the next four weeks.
Configuring ICAP on Nextcloud
-----------------------------
@@ -183,6 +228,6 @@ Additional documentation is work in progress.
Disabling background scan task
------------------------------
You can disable background scan with occ to only scan files during upload.
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"

22
admin_manual/configuration_server/occ_command.rst
View File

@@ -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