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 the background.antivirus.check parameter):

• Live mode.
• Batch mode.

Caution

Antivirus checker in live mode can dramatically degrade end users’ experience of the user interface. Take into consideration that the antivirus can take up to 3 seconds or more to analyze some documents, which will be added to the upload time.

Field / Property	Type	Description
system.antivir	String	Sets the antivirus path. /usr/bin/clamscan
background.antivirus.check	Boolean	Enables or disables 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, see Built-in crontab tasks. When background checking is disabled, the antivirus runs during the upload of any document. This can add extra time to the upload process (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 increase threefold or more with this option disabled. We recommend enabling it.
background.antivirus.check.threads	Integer	The number of concurrent threads that will be used by 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 the parameter “background.antivirus.check” is enabled, it is good practice for it to be a multiple of the background.antivirus.check.threads value.