Docker image published on OPSWAT Docker Hub

database password

Support some specific characters: */-+?<>:{}[]()*&^%$#@~`;.,

Not support " (double quotation) and ' (quotation).

The ignition file settings, only JSON format is accepted.

For example: IGNITION_JSON='{"user/name": "admin", "user/password": "admin", "user/email": "admin@local"}'

For database password, this support some specific characters: */-+?<>:{}[]()*&^%$#@~`;.,

Not support " (double quotation) and ' (quotation).

MetaDefender Core configuration file settings, only JSON format is accepted.

For example: CORE_CONF_JSON='{"global/restport": "8009", "logger/loglevel": "info"}'

a full path to folder (in container) storing all writable data (engine data, logs, runtime data, etc.).

Default is /opt/ometascan/core_data

Make sure to mount a volume to this folder to run with the policy.

A full path to folder containing certificate file and private key file.

There files must have the same filename meanwhile its extensions must be .crt and .key

After being added, the filename without extension will be the name of the certificate in MetaDefender Core

A passphrase for encrypted private key when adding new certificate via CERT_PATH environment variable.

Passphrase must be less than or equal 1023 characters

Passphrase does not support single quote character '

Configure advanced SSL settings such as cipher suites, session timeout, and caching. Accepted values (case-insensitive):

ssl_verify_depth 10; ssl_session_cache none; *In case of using docker-compose, they should not input single quote ' and double quote "

Used for customizing the PostgreSQL database name of MetaDefender Core.

By default, in shared DB mode, it is metadefender_core Name must begin with a letter (a-z) or underscore (_). Subsequent characters in a name can be letters, digits (0-9), or underscores. Maximum length is 63.

true: Enable proxy feature.

false: Disable proxy feature.

true

• Enable health check feature.
• Set 3 health check criterias if customized.

false

• Disable health check feature.
• Ignore customized health check criteria.

not defined

• Enable health check feature with
• Queue threshold: 100
• Minimum number of AVs: 0
• List of requires engines: empty.

Health check criteria.

Threshold for scan queue. Unit is %. Default: 100 (%).

When allocated slots percentage exceeds the threshold, MetaDefender Core will set itself unhealthy.

Health check criteria.

Minimum number of AV engines. Default: 0. When number of active AV engines is less than or equal to the predefined value, MetaDefender Core will set itself unhealthy.

Health check criteria.

A list of mandatory engines. Default: all the engines of a license. When any predefined engines are not active, MetaDefender Core will set itself unhealthy.

true

• Enable database upgrade process. This migrates Workflow Rules and other settings.
• Require MDCORE_UPGRADE_FROM_DB_NAMEvariable.
• Require super-user permission for DB_USER.
• Only support shared-database mode DB_MODE=4 and remote PostgreSQL DB_TYPE=remote .

false / not defined

• Database upgrade process will not run.

Required when UPGRADE_DB = true

If this variable does not exist, upgrade process will exit with code 1.

Required when UPGRADE_DB = true

true

• Database upgrade process migrates processing history, quarantine history, module update and configuration history.

false / not defined

• Database upgrade process will not migrate these kinds of data.

Default: empty string

Add the comment for the license when activating.

The OLMS server endpoint. If users want to use OLMS, this variable is required.

MetaDefender Core will treat OLMS higher priority than the normal way in license activation.

Default: 8040

OLMS port for REST API.

Default: 3316

OLMS port for socket interface.

Default: production

Can be production or hotbackup

Default: false

If the user want to use proxy for the OLMS activation

Default: empty string

Proxy server address

This field is required if OLMS_USER_PROXY is set to true

Default: empty string

Proxy port

This field is required if OLMS_USER_PROXY is set to true

Default: empty string

Proxy type. Accepted values:

• socks4
• socks5
• http

This field is required if OLMS_USER_PROXY is set to true

Default: empty string

Proxy username

Default: empty string

Proxy password