Configuration Parameters

The component uses configuration parameters specified in the [Update] section of the unified configuration file of Dr.Web Mail Security Suite.

The section contains the following parameters:

Parameter

Description

LogLevel

{logging level}

Logging level of the component.

If a parameter value is not specified, the DefaultLogLevel parameter value from the [Root] section is used.

Default value: Notice

Log

{log type}

Logging method of the component.

Default value: Auto

ExePath

{path to file}

Component executable path.

Default value:

for GNU/Linux: /opt/drweb.com/bin/drweb-update

for FreeBSD: /usr/local/libexec/drweb.com/bin/drweb-update

RunAsUser

{UID | user name}

The parameter determines on behalf of which user the component runs. Either the numerical UID of the user or the user name (login) can be specified. If the user name consists of numbers (i.e. similar to a numerical UID), it must be specified with the “name:” prefix, for example: RunAsUser = name:123456.

If the user name is not specified, the component shuts down with an error upon startup.

Default value: drweb

UpdateInterval

{time interval}

The frequency to check for updates on Dr.Web update servers. This is a time period between a previous successful attempt to connect to the update servers (initiated automatically or manually) and the next attempt to perform an update.

Default value: 30m

RetryInterval

{time interval}

Frequency of repeated attempts to perform an update using the update servers if the previous attempt failed.

Allowed values: from 1 minute (1m) to 30 minutes (30m).

Default value: 3m

MaxRetries

{integer}

Number of repeated attempts to perform an update using Dr.Web update servers (the frequency is specified in the RetryInterval parameter) if the previous attempt failed.

If the value is set to 0, repeated attempts are not made (the next update will be performed after the time period specified in the UpdateInterval parameter).

Default value: 3

Proxy

{connection string}

Parameters for connecting to a proxy server that is used by the Dr.Web Updater component when it is connecting to Dr.Web update servers (for example, if connecting directly to external servers is prohibited by network security policies).

If a parameter value is not specified, the proxy server is not used.

Allowed values:

<connection string>—proxy server connection string. The string has the following format (URL):

[<protocol>://][<user>:<password>@]<host>:<port>

where:

<protocol> is a type of the protocol in use (in the current version, only http is available);

<user> is a user name for connecting to the proxy server;

<password> is a password for connecting to the proxy server;

<host> is the host address of the proxy (IP address or domain name, i.e. FQDN);

<port> is a port to be used.

The URL parts <protocol> and <user>:<password> may be absent. The proxy server address <host>:<port> is mandatory.

If the user name or the password contains characters @, % or :, these characters must be replaced with the corresponding HEX codes: %40, %25 and %3A respectively.

Examples:

1.In the configuration file:

Connection to a proxy server hosted at proxyhost.company.org using port 123:

Proxy = proxyhost.company.org:123

Connection to a proxy server hosted at 10.26.127.0 using port 3336 via HTTP protocol as the legaluser user with the passw password:

Proxy = http://legaluser:passw@10.26.127.0:3336

Connection to the proxy server hosted at 10.26.127.0 using port 3336 as the user@company.com user with the passw%123 password:

Proxy = user%40company.com:passw%25123%3A@10.26.127.0:3336

2.Setting the same values using the drweb-ctl cfset command:

# drweb-ctl cfset Update.Proxy proxyhost.company.org:123
# drweb-ctl cfset Update.Proxy http://legaluser:passw@10.26.127.0:3336
# drweb-ctl cfset Update.Proxy user%40company.com:passw%25123%3A@10.26.127.0:3336

Default value: (not specified)

ExcludedFiles

{file name}

Name of a file that will not be updated by the Dr.Web Updater component.

Accepts a list of values. The values in the list must be comma-separated (with each value put in quotation marks). The parameter can be specified more than once in the section (in this case, all its values are combined into one list).

Example: Add the 123.vdb file and the 456.dws directory to the list.

1.Adding values to the configuration file.

Two values per string:

[Update]
ExcludedFiles = "123.vdb", "456.dws"

Two strings (one value per string):

[Update]
ExcludedFiles = 123.vdb
ExcludedFiles = 456.dws

2.Adding values with the drweb-ctl cfset command:

# drweb-ctl cfset Update.ExcludedFiles -a 123.vdb
# drweb-ctl cfset Update.ExcludedFiles -a 456.dws

Default value: drweb32.lst

NetworkTimeout

{time interval}

A time-out period imposed on the network-related operations of the component while downloading updates from Dr.Web servers.

This parameter is used when a connection is temporarily lost: if the connection is established again before the time-out expires, the interrupted updating process will be continued.

Specifying the time-out value larger than 75s has no effect as the connection is closed by the TCP timeout.

Minimal value: 5s.

Default value: 60s

BaseDrlDir

{path to directory}

Path to a directory that contains files used for connection to servers of a standard update zone, which are used to update virus databases and the scan engine.

Default value:

for GNU/Linux: /var/opt/drweb.com/drl/bases

for FreeBSD: /var/drweb.com/drl/bases

BaseCustomDrlDir

{path to directory}

Path to a directory that contains files used for connection to a special (“customized”) update zone, which are used to update virus databases and the scan engine.

If the directory defined in this parameter contains a non-empty signed server list file (the .drl file), the update is performed only from these servers, and the main zone servers (see above) are not used to update the virus databases and the scanning engine.

Default value:

for GNU/Linux: /var/opt/drweb.com/custom-drl/bases

for FreeBSD: /var/drweb.com/custom-drl/bases

BaseUpdateEnabled

{boolean}

Allow or do not allow updating the virus databases and the scan engine.

Allowed values:

Yes—updating is allowed and will be performed;

No—updating is not allowed and will not be performed.

Default value: Yes

VersionDrlDir

{path to directory}

Path to a directory that contains files for connection to servers that are used for updating versions of Dr.Web Mail Security Suite components.

Default value:

for GNU/Linux: /var/opt/drweb.com/drl/version

for FreeBSD: /var/drweb.com/drl/version

VersionUpdateEnabled

{boolean}

Allow or do not allow updating versions of Dr.Web Mail Security Suite components.

Allowed values:

Yes—updating is allowed and will be performed;

No—updating is not allowed and will not be performed.

Default value: Yes

DwsDrlDir

{path to directory}

Path to a directory that contains the files for connecting to servers of a standard update zone, which are used for updating the database of web resource categories.

Default value:

for GNU/Linux: /var/opt/drweb.com/drl/dws

for FreeBSD: /var/drweb.com/drl/dws

DwsCustomDrlDir

{path to directory}

Path to a directory that contains the files for connecting to servers of a special (“customer”) update zone, which are used for updating the database of web resource categories.

If the directory defined in this parameter contains a non-empty signed server list file (the .drl file), updating is performed only from these servers, and the main zone servers (see above) are not used to update the database of web resource categories.

Default value:

for GNU/Linux: /var/opt/drweb.com/custom-drl/dws

for FreeBSD: /var/drweb.com/custom-drl/dws

DwsUpdateEnabled

{boolean}

Allow or do not allow updating of the database of web resource categories.

Allowed values:

Yes—updating is allowed and will be performed;

No—updating is not allowed and will not be performed.

Default value: Yes

AntispamDrlDir

{path to directory}

Path to a directory that contains the files for connecting to servers of a standard update zone, which are used for updating the anti-spam library.

Default value:

for GNU/Linux: /var/opt/drweb.com/drl/antispam

for FreeBSD: /var/drweb.com/drl/antispam

AntispamCustomDrlDir

{path to directory}

Path to a directory that contains the files for connecting to servers of a special (“customer”) update zone, which are used for updating the anti-spam library.

If the directory defined in this parameter contains a non-empty signed server list file (the .drl file), updating is performed only from these servers, and the main zone servers (see above) are not used to update the anti-spam library.

Default value:

for GNU/Linux: /var/opt/drweb.com/custom-drl/antispam

for FreeBSD: /var/drweb.com/custom-drl/antispam

AntispamUpdateEnabled

{boolean}

Allow or do not allow updating of the anti-spam library.

Allowed values:

Yes—updating is allowed and will be performed;

No—updating is not allowed and will not be performed.

Default value: No

BackupDir

{path to directory}

Path to a directory where old versions of updated files are saved for possible rollback. Only updated files are backed up upon every update.

Default value: /tmp/update-backup

MaxBackups

{integer}

The maximum number of the previous versions of updated files, which are saved. If this number is exceeded, the oldest copy is removed upon the next update.

If the parameter value is 0, the previous versions of backup files are not stored.

Default value: 0

IdleTimeLimit

{time interval}

Maximum idle time for the component. When the specified period of time expires, the component shuts down.

The component is started upon the next update on schedule. When the update is completed, it is waiting for the specified time interval, and, if there are no new requests, it shuts down until the next update attempt.

Allowed values: from 10 seconds (10s) to 30 days (30d).
If the None value is set, the component will operate indefinitely; the SIGTERM signal will not be sent if the component goes idle.

Default value: 10m

Start

{boolean}

Enable or disable the component at the startup of Dr.Web Mail Security Suite. This parameter has priority over the DwsUpdateEnabled parameter.

Allowed values:

Yes—enable the component at the startup of Dr.Web Mail Security Suite;

No—disable the component at the startup of Dr.Web Mail Security Suite.

Default value: Yes

UseHttps

{Always | ResListOnly | Never}

Use or do not use HTTPS while downloading updates.

Allowed values:

Always—always use HTTPS while downloading updates.

ResListOnly—use HTTPS only while downloading an .lst file containing a list of update files. At that, update files will be downloaded via HTTP.

Never—always use HTTP while downloading updates.

Default value: ResListOnly