Antivirus configuration parameters
Antivirus is one of the processes that can use a lot of hardware resources (memory and CPUs). An aggressive antivirus policy can decrease the performance of the application and affect end users' experience with the user interface.
Antivirus analyzer can work in two modes (depending on the value of background.antivirus.check parameter):
- Live mode.
- Batch mode.
Antivirus checker in live mode can dramatically decrease end-user satisfaction with the user interface. Take into consideration that to analyze some documents the antivirus can take up to 3 seconds or more, which will be added to the upload time.
Field / Property | Type | Description |
---|---|---|
system.antivir |
String |
Set the antivirus path. /usr/bin/clamscan |
background.antivirus.check |
Boolean |
Enable or disable the background antivirus checker. By default it is set to false. There's a crontab task ( Administration > Crontab ) named Antivirus Checker Worker that takes control of the background antivirus checker. For more information Built-in crontab tasks. When background check is disabled, the antivirus is processed while uploading any document. That can add extra time to complete the upload (in some cases more than 3 seconds may be needed for the antivirus to check a document). For example, when you perform a large import of files, the total time to complete the operation can be multiplied by three or more with this option disabled. Our suggestion is to keep it enabled. |
background.antivirus.check.threads |
Integer |
Number of concurrent threads that will be used for the antivirus. This number should be less than or equal to the number of hardware cores. |
background.antivirus.check.batch |
Integer |
Indicates the number of documents to be processed in each indexing cycle. When parameter "background.antivirus.check is enabled, it is good practice for it to be a multiple of the "background.antivirus.check.threads" value. |