Plugin: Virus Scanning

Purpose

This plugin is used to scan files against viruses before uploading into Funnelback using the DXP virus scanning API.

This plugin is enabled at the system level within the DXP and will virus scan anything that is uploaded to Funnelback.

Usage

Enable the plugin

Configuration settings

The configuration settings section is where you do most of the configuration for your plugin. The settings enable you to control how the plugin behaves.

The configuration key names below are only used if you are configuring this plugin manually. The configuration keys are set in the null configuration to configure the plugin. When setting the keys manually you need to type in (or copy and paste) the key name and value.

Virus scanner API URL

Configuration key

plugin.virus-scanning.config.url

Data type

string

Required

This setting is optional

URL to the Virus Scanning API. This must be set to the URL that matches the region matching the DXP instance.

API key for virus scanning API

Configuration key

plugin.admin-api-on-write-file.password

Data type

string

Default

(Empty string)

Required

This setting is optional

Enabling the plugin

This plugin cannot be managed from the Plugins section of the administration dashboard along with the other plugins as this is a system plugin.

Enable the virus-scanning plugin on your system from the system configuration screen by selecting the > configuration item from the top menu bar, or by editing the system global.cfg and add the following system/global configuration keys to enable the plugin.

plugin.admin-api-on-write-file=virus-scanning
plugin.admin-api-on-write-file.version=1.1.0

Examples

N/A

Change log

[1.1.0]

Changed

  • Updated to the latest version plugin framework (Funnelback shared v16.20) to enable integration with the new plugin management dashboard.