H5. Dr.Web Proxy Server

To configure the Proxy Server parameters, run with corresponding switches the drwcsd-proxy executable file, which resides in the bin subdirectory of the Proxy Server installation directory.

The Start Instruction Format

drwcsd-proxy [<switches>] [<commands> [<command_arguments>]]

Allowed Switches

Crossplatform Switches

--сonsole=yes|no—run the Proxy Server in the interactive mode. At this, the Proxy Server operation log is written to the console.

Default: no.

--etc-root=<path>—path to the configuration files directory (drwcsd-proxy.conf, drwcsd.proxy.auth and etc.).

Default: $var/etc

--home=<path>—path to the Proxy Server installation directory.

Default: $exe-dir/

--log-root=<path>—path to the directory with the Proxy Server operation log files.

Default: $var/log

--pool-size=<N>—pool size for clients connections.

Default: core number of the computer with the Proxy Server installed (not less than 2).

--rotate=<N><f>,<M><u>—Proxy Server log rotation mode, where:

Parameter

Description

<N>

Total number of log files (including current and archive).

<f>

Log files storing format, possible values:

z (gzip)—compress files, used by default,

p (plain)—do not compress files.

<M>

Log file size or rotation time, depending on the <u> value;

<u>

Unit measure, possible values:

to set rotation by log file size:

k—Kb,

m—Mb,

g—Gb.

to set rotation by time:

H—hours,

D—days,

W—weeks.

info

If rotation by time is set, synchronisation performs independently on command launch time: the H value means synchronisation with the beginning of an hour, D—with beginning of a day, W—with beginning of a week (00:00 on Monday) according to the multiplicity specified in the <u> parameter.

Initial reference point—January 01, year 01 AD, UTC+0.

Default is 10,10m, which means storing of 10 files of 10 megabytes each, use compression.

--trace=yes|no—enable detailed logging of Proxy Server calls. Available only if the Proxy Server supports calls stack tracing (if an exception occurs, stack is written to the log).

Default: no.

--tmp-root=<path>—path to the temporary files directory. Is used at Proxy Server automatic update.

Default: $var/tmp.

--var-root=<path>—path to the Proxy Server working directory to store cache and database.

Default:

Windows OS: %ALLUSERSPROFILE%\Doctor Web\drwcs

Linux OS: /var/opt/drwcs

FreeBSD OS: /var/drwcs

--verbosity=<details_level>—log details level. Default is TRACE. Allowed values are: ALL, DEBUG3, DEBUG2, DEBUG1, DEBUG, TRACE3, TRACE2, TRACE1, TRACE, INFO, NOTICE, WARNING, ERROR, CRIT. The ALL and DEBUG3 values are synonyms.

If necessary, it is possible to set specific levels of detail for several message sources at once in the following format:

-verbosity=<message_source1>:<level1>,<message_source2>:<level2>, <message_source3>:<level3> and so on. In this case, <level> is inherited on general principle, i.e. it looks for the closest parental source with specified level of detail. The -verbosity=all:all switch is equal to the -verbosity=all switch (see also Appendix K. Log Files Format).

info

All switches for setting Proxy Server parameters can be set simultaneously.

Switches for UNIX system-based OS

--user—set the user identifier. The switch is relevant for both, normal and daemon modes.

--group—set the group identifier. The switch is relevant for both, normal and daemon modes.

--pid=<path>—path to the directory with the process identifier.

Default:/var/opt/drwcs/run/drwcsd-proxy.pid

Allowed Commands and their Arguments

info

If the command is not specified, the run command is used.

import <path> [<revision>] [<products>]—import files from Dr.Web Server repository to the Proxy Server cache.

<path>path to the directory with Dr.Web Server repository. The Server repository must be preliminary downloaded to the computer with the Proxy Server installed.

<revision>—maximum number of revisions to import. If the value is not set, all revision will be imported.

<products>the list of products divided by the space that are intended to import. By default, the list is empty, i.e. import all repository products except Dr.Web Server. If the list is set, only the products from the list will be imported.

help—show help message on switches for Proxy Server configuration.

run—start the Proxy Server in normal mode.

For Windows OS only

install—install the service.

start—start the installed service.

stop—stop the started service.

uninstall—uninstall the service.

Commands available under UNIX system-based OS only:

daemon—run the Proxy Server as a daemon (see also Switches for UNIX system-based OS).

Proxy server control script and variables available under UNIX system-based OS

To make the administration of the Proxy Server under UNIX system-based OS easier, administrator is provided with variables which reside in the drwcsd-proxy.sh script file stored in the following folder:

Linux: /etc/init.d/dwcp_proxy

FreeBSD: /usr/local/etc/rc.d/dwcp_proxy

The script accepts the following commands:

import <path> [<revision>] [<products>]—import files from Dr.Web Server repository to the Proxy Server cache (same as the command of Proxy Server—see above).

interactive—run the Proxy Server in the interactive mode. At this, the Proxy Server operation log is written to the console.

start—run the Proxy Server as a daemon.

status — check if the daemon is launched.

stop—stop the started daemon.

Correspondence between variables and command switches for the drwcsd-proxy is described in the Table H-3.

Table Н-3.

Switch

Variable

Default parameters

--home=<path>

$DRWCS_PROXY_HOME

$exe-dir/

--var-root=<path>

$DRWCS_PROXY_VAR

Linux OS: /var/opt/drwcs

FreeBSD OS: /var/drwcs

--etc-root=<path>

$DRWCS_PROXY_ETC

$var/etc

--tmp-root=<path>

$DRWCS_PROXY_TMP

$var/tmp

--log-root=<path>

$DRWCS_PROXY_LOG

$var/log

-

$DRWCS_PROXY_LIB

$DRWCS_PROXY_HOME/lib

-

$DRWCS_PROXY_BIN

$DRWCS_PROXY_HOME/bin

--verbosity=<details_level>

$DRWCS_PROXY_VERBOSITY

INFO

--rotate=<N><f>,<M><u>

$DRWCS_PROXY_ROTATE

10,10m

--pid

$DRWCS_PROXY_PID

/var/opt/drwcs/run/drwcsd-proxy.pid

-

$NO_DRWCS_PROXY_USER

If any value is assigned, the $DRWCS_PROXY_USER is ignoted.

-user

$DRWCS_PROXY_USER

-

-

$NO_DRWCS_PROXY_GROUP

If any value is assigned, the $DRWCS_PROXY_GROUP is ignoted.

--group

$DRWCS_PROXY_GROUP

-

-

$DRWCS_PROXY_FILES

131170 but not less than the current limit.