MetaDefender Distributed Cluster File Storage

Ignition file

Info

The ignition file is required only for a fresh installation.

To install MetaDefender Distributed Cluster File Storage server, ignition file in YML format is required at the following location:

  • Windows: C:\opswat\mddc_file_storage.yml

  • Linux: /etc/opswat/mddc_file_storage.yml

The ignition file includes keys:

Key path

Value type

Accepted values

Required

Description

secure.connection_key

string

A string from 4 to 64 character long containing digits from 0 to 9 and characters from a/A to z/Z

required

An arbitrary string that enables clients to connect to the server.

Use this value as input when adding a MDDC File Storage in the UI of the MDDC Control Center.

secure.private_key

string


required

Content of private key in X509 format.

secure.certificate

string


required

Content of certificate in X509 format.

storage.path

string


required

Path to an existing directory where the MDDC File Storage server stores its files. The server requires full permissions to access the path in Linux.

rest.host

string


optional

IP address (V4/V6) or host where the server resides on. Default value is '*'

Notes: value '*'allows the service to accept connections from all network interfaces.

To bind the service to a specific interface, specify its IP address or domain name. For example, to listen on all IPv4 interfaces, set the host to 0.0.0.0

rest.port

number


optional

The port where the server resides on. Default value is 8890

log.streams[@].log_type

string

  • file

  • syslog

optional

Type of log device.

log.streams[@].log_level

string

  • dump

  • debug

  • info

  • warning

  • error

optional

Level of log message.

log.streams[@].log_path

string

If log.streams[@].log_type is "file" then log.streams[@].log_path is the path to a file on file system where logs are written.

If log.streams[@].log_type is "syslog" then

  • log.streams[@].log_path can be [tcp/udp]://host:port where host:port is the host and port to a remote syslog server that supports TCP or UDP protocol.

  • log.streams[@].log_path can be "local" to write log to local syslog server (Linux only).

optional

Location where logs are written.

Configuration file

After successfully installing, MetaDefender Distributed Cluster File Storage generates a configuration file with changeable settings at the following location:

  • Windows: C:\Program Files\OPSWAT\MetaDefender Distributed Cluster File Storage\mddc_file_storage.yml

  • Linux: /etc/mddc-file-storage/mddc_file_storage.yml

Info

The service must be restarted to take the new configurations into effect.

Sample

Info

OpenSSL or a similar tool (e.g., ssh-keygen) can create a pair of public and private keys in X.509 format.

Warning

The value of storage.path should be updated with the path of an existing folder according to your selected operating system.

storage:
path: 'C:/opswat/mddc/file_storage' # or '/var/lib/mddc-file-storage/' for Linux
secure:
connection_key: "1234abcd" # [0-9a-zA-Z]{4,64}
private_key: |
-----BEGIN PRIVATE KEY-----
MIIJQwIBADANBgkqhkiG9w0BAQEFAASCCS0wggkpAgEAAoICAQCjYtuWaICCY0tJ
PubxpIgIL+WWmz/fmK8IQr11Wtee6/IUyUlo5I602mq1qcLhT/kmpoR8Di3DAmHK
nSWdPWtn1BtXLErLlUiHgZDrZWInmEBjKM1DZf+CvNGZ+EzPgBv5nTekLWcfI5ZZ
toGuIP1Dl/IkNDw8zFz4cpiMe/BFGemyxdHhLrKHSm8Eo+nT734tItnHKT/m6DSU
0xlZ13d6ehLRm7/+Nx47M3XMTRH5qKP/7TTE2s0U6+M0tsGI2zpRi+m6jzhNyMBT
J1u58qAe3ZW5/+YAiuZYAB6n5bhUp4oFuB5wYbcBywVR8ujInpF8buWQUjy5N8pS
Np7szdYsnLJpvAd0sibrNPjC0FQCNrpNjgJmIK3+mKk4kXX7ZTwefoAzTK4l2pHN
uC53QVc/EF++GBLAxmvCDq9ZpMIYi7OmzkkAKKC9Ue6Ef217LFQCFIBKIzv9cgi9
fwPMLhrKleoVRNsecBsCP569WgJXhUnwf2lon4fEZr3+vRuc9shfqnV0nPN1IMSn
zXCast7I2fiuRXdIz96KjlGQpP4XfNVA+RGL7aMnWOFIaVrKWLzAtgzoGMTvP/Au