Deployment automation support

eula

Optional (mandatory when having [user] section)

true

false (default)

Whether to accept the End User License Agreement. This key must be set at the top of ignition file.

This key must be set to "true" to accept the EULA. Any other value will cause the initialization to fail.

When having [user] section defined, then this key must be set.

[global]

Optional

Global configuration

dbmode

Optional

Define database mode:

• 1: Standalone Core (default)

• 3: Non-persistent mode (Core will not write any scan result into database, client must use webhook scanning fashion to retrieve scan result)

• 4: Shared database model (all Core instances will share the same database)

instance_name

Optional

Define instance name. If no define, instance name will be automatically generated. Unicode and number At least 3 characters. No whitespace

storage_path

Optional

Path to storages (DLP, quarantined, sanitized files) It could be a local path on the same machine, or a shared folder located in a remote connected machine. Make sure that folder is open access (read and write) to MetaDefender Core. For example:

• C:\folder

• \192.168.1.1\folder

[user]

Optional

Initial administrator user account properties. The Administrator role is granted to the account.

name

Optional

string

User name for the initial administrator user account.

password

Optional

string

Password for the initial administrator user account. WARNING! Clear text password The password in this configuration file must be stored in its clear-text format and as so it may be visible for unauthorized parties.

email

Optional

string

E-mail address for the initial administrator user account.

apikey

Optional

string

API key for the initial administrator user account.

[config]

Optional

import

Optional

string

Path to a file in json/zip format that contains a previously exported configuration to be imported. Zip-format file contains a full configuration including user management settings, so it will overwrite [user] section.

import_password

Optional

string

Password to decrypt .zip configuration package.

[security]

Optional

session_cookie_samesite

Optional

Strict

Lax (default)

None

Declare if session cookie should be restricted to a first-party or same-site context.

[internal]

Optional

skip_startup_pages

Optional

true

false (default)

Skip all welcome and other startup pages (e.g. upgrade result) when installing / upgrading MetaDefender, and going straight to the product index default page.

skip_upgrade_scan_data

Optional

true

false (default)

Skip upgrading processing result data (Processing History), files sanitized by Deep CDR, files processed by Proactive DLP, quarantined files.

[dbserver]

Optional

type

Mandatory when having [dbserver] section

local

remote

Where the PostgreSQL database server should physically locate.

"remote" means PostgreSQL server and MetaDefender Core are not in the same machine.

host

Mandatory when having [dbserver] section

string

IP address / domain name of the server where PostgreSQL server locates.

"localhost" can be used when applicable.

port

Mandatory when having [dbserver] section

number

Port of PostgreSQL server is listening for connections from clients (i.e. MetaDefender Core).

user

Mandatory when having [dbserver] section

string

PostgreSQL server's user.

SUPERUSER privilege is required for MetaDefender Core to setup its database and extensions for the first time.

Only non-Unicode characters supported.

password

Mandatory when having [dbserver] section

string

PostgreSQL server's user credentials.

Only non-Unicode characters supported.

private_username

Optional

string

PostgreSQL server's internal user created for MetaDefender Core own operational purpose.

If not specified, then MetaDefender Core will auto generate this user.

See details at Customize Internal PostgreSQL User

private_password

Optional

string

PostgreSQL server's internal user created for MetaDefender Core own operational purpose.

If not specified, then MetaDefender Core will auto generate this user.

See details at Customize Internal PostgreSQL User

[ocm]

Optional

ocm_url

Optional

string

URL to My OPSWAT server.

reg_code

Optional

string

A registration code to enroll to My OPSWAT server.

[max_body_size]

Optional

body_size

Optional

number

Defines the maximum body size that the server accepts for client uploads, independent of any specific workflow rule.

The body_size can be set to 0 for unlimited size (default value) or must be at least 1,048,576 bytes (1 MB).

[https]

Optional

cert_name

Optional

string

Name of the cert defined by users. Does not accept a "None" value or any special characters "[]:|;=+*?<>@/"

cert_path

Optional

string

Absolute path of cert file

key_path

Optional

string

Absolute path of key file

passphrase

Optional

string

Passphrase of the cert file (if any) - if cert does not have passphrase, this field can be omitted

tls_version

Optional

TLS version, it could be 1.2 or 1.3 or both of them "1.2,1.3"