Skip to content

Commit

Permalink
enh: add some more documentation for antivirus usage
Browse files Browse the repository at this point in the history
Signed-off-by: Max <[email protected]>
  • Loading branch information
max-nextcloud committed Jul 4, 2023
1 parent 61ef451 commit fc61b23
Showing 1 changed file with 46 additions and 1 deletion.
47 changes: 46 additions & 1 deletion admin_manual/configuration_server/antivirus_configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -169,10 +169,55 @@ 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
~~~~~~~~

::

occ files_antvirus:status [-v]


Manually trigger the background scan
~~~~~~~~

::

occ files_antivirus:background-scan [-v] [-m MAX]

Manually scan a single file
~~~~~~~~

::

occ files_antvirus:scan <path>

Mark a file as scanned or unscanned.
~~~~~~~~

::

occ files_antivirus:mark <path> <scanned|unscanned>
Files marked as scanned will not be scanned for the next four weeks.

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"

0 comments on commit fc61b23

Please sign in to comment.