MetaDefender Core NAS (File Storage Server)

The File Storage Server component supports its own configuration file in JSON format.

{ "connection_key": string, "log": { "streams": [ { "log_type": string, "log_level": string, "log_path": string } ] }, "server": { "config": { "host": string, "port": integer, "key_path": string, "certificate_path": string } }, "storage": { "database_path": string, "paths": [ { "path": string, "max_size_gb": integer } ] } }

Key path	Required	Value type	Accepted values	Description
connection_key	yes	string	A string from 4 to 64 character long containing digits from 0 to 9 and characters from a/A to z/Z	An arbitrary string that allows clients to connect to file storage server
log.streams[@].log_type	yes	string	file syslog	Type of log device
log.streams[@].log_level	yes	string	dump debug info warning error	Level of log message
log.streams[@].log_path	yes	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 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).	Location where logs are written
log.streams[@].log_format	no	string	`default`	Format of written log
server.config.host	yes	string		IP address (V4/V6) or host where the file storage server service resides on
server.config.port	yes	number		Port of server where the file storage server service resides on
server.config.key_path	yes	string	`/etc/opswat/<filename>`	Path to the file containing private key in X509 format. In case of Linux container-based setup, this should be an absolute mapped path.
server.config.certificate_path	yes	string	`/etc/opswat/<filename>`	Path to the file containing certificate in X509 format. In case of Linux container-based setup, this should be an absolute mapped path.
storage.database_path	no	string		Path to the directory where NAS stores its database file. install-dir/data is used if the key is ignored
storage.paths[@].path	yes	string		Path to the directory where NAS stores submitted files
storage.paths[@].max_size_gb	yes	string		Maximum storage volume in Gigabytes

Example of ometascan_nas.conf

When setting up on a host machine
When setting up in a container

{ "connection_key": "5f8214e3bba948f5a921d70d5aa2966f", "log": { "streams": [ { "log_type": "file", "log_level": "info", "log_path": "C:/opswat/log/nas.log" } ] }, "server": { "config" : { "host": "*", "port": 8888, "key_path": "C:/opswat/private.key", "certificate_path": "C:/opswat/public.cert" } }, "storage": { "paths": [ { "path": "C:/opswat/nas_storage", "max_size_gb": 20 } ] } }

{ "log": { "streams": [ { "log_type": "file", "log_level": "info", "log_path": "/opt/ometascan-nas/nas_data/var/log/ometascan-nas/nas.log" } ] }, "server": { "config" : { "host": "*", "port": 8888, "key_path": "/etc/opswat/private.key", "certificate_path": "/etc/opswat/public.cert" } }, "storage": { "paths": [ { "path": "/opt/ometascan-nas/nas_data/ometascan", "max_size_gb": 20 } ] } }

Sample private (.key) and public key (.cert) in X509 format:

Last updated on

Was this page helpful?