Configuration Parameters

The component uses configuration parameters which can be found in the [Update] section of the integrated configuration file of Dr.Web for UNIX Mail Servers.

The section contains the following parameters:

Parameter

Description

LogLevel

{logging level}

Logging level of the component.

If the 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}

Executable path to the component.

Default value: <opt_dir>/bin/drweb-update.

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 under which user name the component should be run. The user name can be specified either as the user’s number UID or as the user’s login. If the user name consists of numbers (i.e. similar to number UID), it is specified with the “name:” prefix, for example: RunAsUser = name:123456.

When a user name is not specified, the component operation terminates with an error after the 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.

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

Default value: 3m

MaxRetries

{integer}

Number of repeated attempts to perform an update using the update servers (at the rate specified in RetryInterval) 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 UpdateInterval).

Default value: 3

Proxy

{connection string}

Stores the parameters for connecting to a proxy server that is used by the updater component (Dr.Web Updater) when it is connecting to Dr.Web updates servers (for example, if direct connections to external servers are prohibited by your network security policies).

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

Allowed values:

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

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

where:

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

<user> is the username to connect to the proxy server;

<password> is the password to connect to the proxy server;

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

<port> is the port to be used.

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

If the username or password contains the following characters: '@', '%' or ':‘, these characters must be changed to the following HEX codes: "%40", "%25" and "%3A", respectively.

Examples:

1.In the configuration file:

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

Proxy = proxyhost.company.org:123

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

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

Connection to the proxy server hosted at 10.26.127.0, using port 3336, username “user@company.com”, password “passw%123:”:

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 set)

ExcludedFiles

{file name}

Defines the name of the file that will not be updated by the Dr.Web Updater component.

You can specify a list as the parameter value. The values in the list must be separated with commas (each value in the 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 to the list the following files: 123.vdb and 456.dws.

1.Adding of values to the configuration file.

Two values in one string:

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

Two strings (one value per a string):

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

2.Adding values via 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 updater component during the updating process.

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 TCP timeout.

Minimum value: 5s.

Default value: 60s

BaseDrlDir

{path to directory}

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

Default value: <var_dir>/drl/bases.

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

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

BaseCustomDrlDir

{path to directory}

Defines a path to directory that contains files used for connection to a special “customized” update zone, which are used by the for updating virus databases and the scan engine.

If in the directory defined in parameter, is a non-empty signed server list file (.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 scan engine.

Default value: <var_dir>/custom-drl/bases.

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

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

BaseUpdateEnabled

{Boolean}

Indicator that shows whether or not updating of virus databases and the scan engine is allowed.

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}

Defines a path to directory that contains files used for connection to servers, which are used for updating Dr.Web for UNIX Mail Servers versions.

Default value: <var_dir>/drl/version.

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

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

VersionUpdateEnabled

{Boolean}

Indicator that shows whether or not updating of Dr.Web for UNIX Mail Servers component version is allowed.

Allowed values:

Yes—updating is allowed and will be performed;

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

Default value: Yes

DwsCustomDrlPath

{path to file}

Path to the signed file that contains the list of the servers of a special update zone, which are used for updating database of web resource categories.

If the parameter is not empty, and the specified file exists, only servers are used for the update. The main file of the list (see above) is ignored. If the file identified by the parameter is empty, the update attempt will fail.

Default value: <var_dir>/drl/dws/custom.drl.

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

For FreeBSD: /var/drweb.com/drl/dws/custom.drl

DwsDrlDir

{path to directory}

Defines a path the directory which contains the files to connect to servers of a standard update zone, which are used for updating database of web resource categories.

Default value: <var_dir>/drl/dws.

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

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

DwsCustomDrlDir

{path to directory}

Defines a path the directory which contains the files to connect to servers of a special “customized” update zone, which are used for updating database of web resource categories.

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

Default value: <var_dir>/custom-drl/dws.

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

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

DwsUpdateEnabled

{Boolean}

Indicator that shows whether or not updating of database of web resource categories is allowed.

Allowed values:

Yes—updating is allowed and will be performed;

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

Default value: Yes

AntispamDrlDir

{path to directory}

Defines a path the directory which contains the files to connect to servers of a standard update zone, which are used for updating the anti-spam library.

Default value: <var_dir>/drl/antispam.

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

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

AntispamCustomDrlDir

{path to directory}

Defines a path the directory which contains the files to connect to servers of a special “customized” update zone, which are used for updating the anti-spam library.

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

Default value: <var_dir>/custom-drl/antispam.

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

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

AntispamUpdateEnabled

{Boolean}

Indicator that shows whether or not updating of the anti-spam library is allowed.

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 the directory, where the previous versions of updated files are saved for possible rollback. Upon every update only updated files are backed up.

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 zero, the previous versions of the files are not saved.

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 launched upon the next update by schedule or an explicit drweb-ctl update [--local-cloud] command. When the update is completed, it is waiting for the specified time interval, and if there are no new requests (including interaction with the cloud if UseLocalCloud = Yes), than it shuts down until the next update attempt.

Acceptable values: from 10 seconds (10s) to 30 days (30d) inclusive.
If the None value is set, the component will functionate eternally; the SIGTERM signal will not be sent if the components goes idle.

Default value: 30s

UseLocalCloud

{Boolean}

Interact with a local cloud of Dr.Web for UNIX products via the Dr.Web MeshD component for the update synchronization (send updates to the cloud, get updates from the cloud) in addition to the Dr.Web update servers.

Allowed values:

No—update using Dr.Web update servers only. Update synchronization with the cloud is disabled, but can be performed explicitly, by the drweb-ctl update --local-cloud command;

Yes—update synchronization on the host with a local cloud (getting updates from the cloud if available, sending updates to the cloud, if the updates on the host are newer).

Default value: Yes