3.2.1. Startup Core Configuration
Linux
The configuration file for the server is located in /etc/ometascan/ometascan.conf
After modifying the server configuration file you must restart the Metadefender Core service in order for the changes to take effect. You should use the distribution-standard way to restart the service.
[global] section
parameter |
default value |
required |
description |
restaddress |
0.0.0.0 |
required |
One of the IP addresses of the computer that runs the product to serve REST API and web user interface (0.0.0.0 means all interface) |
restport |
8008 |
required |
Designated port number for the web and REST interface |
address |
|
optional |
Address of the computer to accept external scan node connections |
port |
|
optional |
Designated port number to accept external scan node connections |
report_engine issue |
true |
optional |
Enable reporting of engine issue count. (possible values: "true" or "false") |
quarantinepath |
[Core data directory]/quarantine |
optional |
Directory for quarantine database and quarantined items |
sanitizepath |
[Core data directory]/sanitized |
optional |
Directory for sanitized database and sanitized items |
dbmode |
1 |
optional |
Support database mode, possible values:
After changed, a Core service restart is required to take effect. Only available starting MetaDefender Core 4.19.2 |
[logger] section
key |
default value |
required |
description |
logfile |
/var/log/ometascan/ometascan.log |
optional |
Full path of a logfile to write log messages to |
loglevel |
info |
optional |
Level of logging. Supported values are: debug, info, warning, error |
syslog |
|
optional |
Switch on logging to a local ('local') or remote ('protocol://<hostname>:<port>') syslog server (Multiple server can be specified separated with comma) |
syslog_level |
|
optional |
Level of logging. Supported values are: debug, info, warning, error |
local_timezone |
false |
optional |
Set local timezone for events sending to local syslog server |
override |
|
optional |
Override specific log ids to display them on another level e.g.: "1723:error,663:info" |
cef |
false |
optional |
If true, the log format is Common Event Format. |
nginx_logfile |
/var/log/ometascan/nginx-ometascan.log |
optional |
File name and path to store the NGINX logs. If this value is changed, the /etc/logrotate.d/ometascan should be changed accordingly. |
You should set both of syslog and syslog_level or none of them and you should set both of logfile and loglevel or none of them.
For override a list of log message ids needed with optionally a level. If there is no level set for an id, it will be displayed on every occasion. e.g.: "1723,663:info" means id 1723 dump message will be displayed every time and id 663 warning message is reduced to info level.
[internal] section
key |
default value |
required |
description |
db_connection |
10 |
optional |
Define maximum number of concurrent connections allows MetaDefender Core to open to work with PostgreSQL database server. Only available starting MetaDefender Core 4.19.1 |
data_directory |
/var/lib/ometascan |
optional |
Full path for MD Core’s data (database, updates etc.) E.g. /var/lib/ometascan/test |
db_optimization |
0 |
optional |
This setting is only applicable MetaDefender Core version 4.17.3 or above. Database optimization has been introduced since Core 4.17.0 to help run database queries faster on MetaDefender Core. The downside could be, while this task is running (for a few seconds), further data queries need to hold up and possibly causing timeout on client side. If this parameter is enabled (set to 1), then MetaDefender Core performs a database optimization task. Supported values:
|
scheduled_db_optimization_time |
<hh>:<mm> (24 hour format) |
optional |
This setting is only applicable MetaDefender Core version 4.17.3 or above. This setting is only applicable when and only when db_optimization setting is set to 1 (enabled). When being set, then MetaDefender Core performs a database optimization at the time configured. E.g.: Configure MetaDefender Core to perform the optimization at 10:35 PM every day:
|
Windows
The configuration for the server is located in Windows Registry
After modifying the server configuration file you must restart the MetaDefender Core service in order for the changes to take effect.
Default logging target is Windows event log with default level of info (see below).
HKEY_LOCAL_MACHINE\SOFTWARE\OPSWAT\Metascan\global
parameter |
default value |
type |
required |
description |
restaddress |
0.0.0.0 |
string value |
required |
One of the IP addresses of the computer that runs the product to serve REST API and web user interface (0.0.0.0 means all interface) |
restport |
8008 |
string value |
required |
Designated port number for the web and REST interface |
address |
|
string value |
optional |
Address of the computer to accept external scan node connections |
port |
|
string value |
optional |
Designated port number to accept external scan node connections |
report_engine issue |
true |
string value |
optional |
Enable reporting of engine issue count. (possible values: "true" or "false"). |
quarantinepath |
[installdir]\data\quarantine |
string value |
optional |
Directory for quarantine database and quarantined items |
sanitizepath |
[installdir]\data\sanitized |
string value |
optional |
Directory for sanitized database and sanitized items |
dbmode |
1 |
string value |
optional |
Support database mode, possible values:
After changed, a Core service restart is required to take effect. Only available starting MetaDefender Core 4.19.2 |
HKEY_LOCAL_MACHINE\SOFTWARE\OPSWAT\Metascan\logger
key |
default value |
type |
required |
description |
logfile |
|
string value |
optional |
Location of a logfile to write log messages to. |
loglevel |
|
string value |
optional |
Level of logging. Supported values are: debug, info, warning, error. Must set value on this key when logfile key is also set accordingly. |
log_rotation |
0 |
string value |
optional |
This setting is only applicable MetaDefender Core version 4.17.3 or above, Windows OS only (on Linux, we use already-supported OS log rotation). Should only set this key when logfile key is also set accordingly. Supported values:
|
wineventlog_level |
info |
string value |
optional |
Level of logging. Supported values are: debug, info, warning, error. |
syslog |
|
string value |
optional |
Value can only by in form of 'udp://<hostname>:<port>' (Multiple server can be specified separated with comma) |
syslog_level |
|
string value |
optional |
Level of logging. Supported values are: debug, info, warning, error. Must set value on this key when syslog key is also set accordingly. |
local_timezone |
false |
string value |
optional |
Set local timezone for events sending to local syslog server. |
override |
|
string value |
optional |
Override specific log ids to display them on another level e.g.: "1723:error,663:info". |
cef |
false |
string value |
optional |
If true, the log format is Common Event Format. |
nginx_logfile |
[installdir]\nginx\nginx.log |
string value |
optional |
File name and path to store the NGINX logs. |
nginx_log_rotation |
0 |
string value |
optional |
This setting is only applicable MetaDefender Core version 4.17.3 or above, Windows OS only (on Linux, we use already-supported OS log rotation). Should only set this key when nginx_logfile key is also set accordingly. Supported values:
|
Please note, if a data entry to be used does not exist, it should be created first.
HKEY_LOCAL_MACHINE\SOFTWARE\OPSWAT\Metascan\internal
key |
default value |
type |
required |
description |
db_connection |
10 |
string value |
optional |
Define maximum number of concurrent connections allows MetaDefender Core to open to work with PostgreSQL database server. Only available since MetaDefender Core 4.19.1 |
data_directory |
<MD Core installation folder>\data |
string value |
optional |
Full path for MD Core’s data (database, updates etc.) E.g. D:\custom_path |
db_optimization |
0 |
string value |
optional |
This setting is only applicable MetaDefender Core version 4.17.3 or above. Database optimization has been introduced since Core 4.17.0 to help run database queries faster on MetaDefender Core. The downside could be, while this task is running (for a few seconds), further data queries need to hold up and possibly causing timeout on client side . If this parameter is enabled (set to 1), then MetaDefender Core performs a database optimization task. Supported values:
|
scheduled_db_optimization_time |
<hh>:<mm> (24 hour format) |
string value |
optional |
This setting is only applicable MetaDefender Core version 4.17.3 or above. This setting is only applicable when and only when db_optimization setting is set to 1. When being set, then MD Core performs a database optimization at the time configured. E.g.: Configure MetaDefender Core to perform the optimization at 10:35 PM every day:
|