3.1.2 Metadefender ICAP Server configuration file

Linux

The configuration file for the server is located in /etc/mdicapsrv/mdicapsrv.conf.

After modifying the server configuration file you must restart the Metadefender ICAP Server service in order for the changes to take effect. You should use the distribution-standard way to restart the mdicapsrv service.

[global] section

parameter

default value

required

description

icapaddress

0.0.0.0

required

One of the IP addresses of the computer that runs the product to serve ICAP interface (0.0.0.0 means all interface)

icapport

1344

required

Designated port number for the ICAP interface

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

8048

required

Designated port number for the web and REST interface

tempdirectory

/var/tmp/mdicapsrv/temp

optional

Root directory for temporary files creation.

A /temp subdirectory is automatically created within a customized directory. For example:

  • If /tmp is configured as tempdirectory then

  • /tmp/temp will be used for creating temporary files

[logger] section

key

default value

required

description

logfile

/var/log/mdicapsrv/mdicapsrv.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

syslog_level

 

optional

Level of logging. Supported values are: debug, info, warning, error

capture_traffic

 

optional

Capture raw TCP traffic in case of bad requests. See 3.5.4 Logging traffic of bad requests.

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.

Windows

The configuration for the server is located in Windows Registry.

After modifying the server configuration file you must restart the Metadefender ICAP Server 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\ICAP Server\global

parameter

default value

type

required

description

icapaddress

0.0.0.0

string value

required

One of the IP addresses of the computer that runs the product to serve ICAP interface (0.0.0.0 means all interface)

icapport

1344

string value

required

Designated port number for the ICAP interface

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

8048

string value

required

Designated port number for the web and REST interface

tempdirectory

C:\Program Files\OPSWAT\Metadefender ICAP Server\data\temp

string value

optional

Root directory for temporary files creation.

A \temp subdirectory is automatically created within a customized directory. For example:

  • If C:\Temp is configured as tempdirectory then

  • C:\Temp\temp will be used for creating temporary files

HKEY_LOCAL_MACHINE\SOFTWARE\OPSWAT\ICAP Server\logger

parameter

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

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>'

syslog_level

 

string value

optional

Level of logging. Supported values are: debug, info, warning, error

override

 

string value

optional

Override specific log ids to display them on another level e.g.: "1723:error,663:info"

capture_traffic

 

DWORD

optional

Capture raw TCP traffic in case of bad requests. See 3.5.4 Logging traffic of bad requests.

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.