Anti Virus Scanner

Setting up Clam AV

To scan files uploaded to the system (via the web application, via Roam, via the API, or any other mechanism) for viruses, clients need to set up their virus checking service, and then provide the following configuration details.

In a first step, it is necessary to create a separate file clamav.properties, in the same directory as the config.properties file.

In addition, the following generic AV settings must be made in the config.properties file:

• AntiVirusFactoryClass: determines the Anti-Virus provider which is used. For ClamAV, this setting is:
  AntiVirusFactoryClass=com.bmssolutions.framework.antivirus.ClamAvAntiVirusClientFactory
• AntiVirusAllowFileUploadWhenScannerDown: you can use these two options:
  • false: when the Scanner is down, users will NOT be able to upload any documents.
  • true: users CAN upload documents - however these documents won't be scanned.

  This setting defaults to "false".

• AntiVirusEmailAddressee: address used when the system cannot communicate with the virus scanner.
• AntiVirusEmailFrom: optional
  By default, the system will take the entry from the field EmailDefaultFromAddress (see above).
• AntiVirusEmailReplyTo: optional

Here is an example - please note the mainConfig. prefix:

mainConfig.AntiVirusEmailAddressee=av-server-down@company.com
mainConfig.AntiVirusAllowFileUploadWhenScannerDown=false
mainConfig.AntiVirusFactoryClass=com.bmssolutions.framework.antivirus.ClamAvAntiVirusClientFactory