freshclam.conf(5) Clam AntiVirus freshclam.conf(5)NAMEfreshclam.conf - Configuration file for Clam AntiVirus database update
The file freshclam.conf configures the Clam AntiVirus Database Updater,
The file consists of comments and options with arguments. Each line
which starts with a hash (#) symbol is ignored by the parser. Options
and arguments are case sensitive and of the form Option Argument. The
arguments are of the following types:
BOOL Boolean value (yes/no or true/false or 1/0).
STRING String without blank characters.
SIZE Size in bytes. You can use 'M' or 'm' modifiers for megabytes
and 'K' or 'k' for kilobytes.
NUMBER Unsigned integer.
When an option is not used (hashed or doesn't exist in the configura‐
tion file) freshclam takes a default action.
If this option is set freshclam will not run.
When started by root, drop privileges to a specified user.
Initialize supplementary group access (freshclam must be started
Path to a directory containing database files.
Number of database checks per day.
Enable logging to a specified file. Highly recommended.
Enable logging to Syslog. May be used in combination with
Specify the type of syslog messages - please refer to 'man sys‐
log' for facility names.
This option allows you to save the process identifier of the
daemon to a file specified in the argument.
Enable verbose logging.
This directive enables database and software version checks
through DNS TXT records.
Default: enabled, pointing to current.cvd.clamav.net
Server name where database updates are downloaded from. In order
to download the database from the closest mirror you should con‐
figure freshclam to use db.xy.clamav.net where xy represents
your country code. If this option is given multiple times,
freshclam(1) tries them in the order given. It's strongly recom‐
mended that you use db.xy.clamav.net as the first mirror and
database.clamav.net as the second.
How many attempts (per mirror) to make before giving up.
Default: 3 (per mirror)
With this option you can control scripted updates. It's highly
recommended to keep it enabled.
By default freshclam will keep the local databases (.cld) uncom‐
pressed to make their handling faster. With this option you can
enable the compression; the change will take effect with the
next database update.
HTTPProxyServer STR, HTTPProxyPort NUMBER
Use given proxy server and TCP port for database downloads.
HTTPProxyUsername STR,HTTPProxyPassword STRING
Proxy usage is authenticated through given username and pass‐
Default: no proxy authentication
If your servers are behind a firewall/proxy which applies User-
Agent filtering, you can use this option to force the use of a
different User-Agent header.
Use IP as client address for downloading databases. Useful for
multi homed systems.
Default: Use OS´es default outgoing IP address.
Notify a running clamd(8) to reload its database after a down‐
load has occurred. The path for clamd.conf file must be pro‐
Default: The default is to not notify clamd. See clamd.conf(5)´s
option SelfCheck for how clamd(8) handles database updates in
Execute this command after the database has been successfully
Execute this command when freshclam reports outdated version. In
the command string %v will be replaced by the new version num‐
Execute this command after a database update has failed.
Timeout in seconds when connecting to database server.
Timeout in seconds when reading from database server.
When enabled freshclam will submit statistics to the ClamAV
Project about the latest virus detections in your environment.
The ClamAV maintainers will then use this data to determine what
types of malware are the most detected in the field and in what
geographic area they are. This feature requires LogTime and Log‐
File to be enabled in clamd.conf. The path for clamd.conf file
must be provided.
Country of origin of malware/detection statistics (for statisti‐
cal purposes only). The statistics collector at ClamAV.net will
look up your IP address to determine the geographical origin of
the malware reported by your installation. If this installation
is mainly used to scan data which comes from a different loca‐
tion, please enable this option and enter a two-letter code (see
http://www.iana.org/domains/root/db/) of the country of origin.
This option enables support for our "Personal Statistics" ser‐
vice. When this option is enabled, the information on malware
detected by your clamd installation is made available to you
through our website. To get your HostID, log on
http://www.stats.clamav.net and add a new host to your host
list. Once you have the HostID, uncomment this option and paste
the HostID here. As soon as your freshclam starts submitting
information to our stats collecting service, you will be able to
view the statistics of this clamd installation by logging into
http://www.stats.clamav.net with the same credentials you used
to generate the HostID. For more information refer to:
http://www.clamav.net/support/faq/faq-cctts/. This feature
requires SubmitDetectionStats to be enabled.
This option enables support for Google Safe Browsing. When acti‐
vated for the first time, freshclam will download a new database
file (safebrowsing.cvd) which will be automatically loaded by
clamd and clamscan during the next reload, provided that the
heuristic phishing detection is turned on. This database
includes information about websites that may be phishing sites
or possible sources of malware. When using this option, it's
mandatory to run freshclam at least every 30 minutes. Freshclam
uses the ClamAV's mirror infrastructure to distribute the data‐
base and its updates but all the contents are provided under
port/bin/answer.py?answer=70015 and http://safebrowsing.cla‐
mav.net for more information.
This option enables downloading of bytecode.cvd, which includes
additional detection mechanisms and improvements to the ClamAV
Thomas Lamy <email@example.com>, Tomasz Kojm <firstname.lastname@example.org>
SEE ALSOfreshclam(1), clamd.conf(5), clamd(8), clamav-milter(8), clamscan(1)ClamAV 0.96 February 12, 2007 freshclam.conf(5)