freshclam.conf(5)

1freshclam.conf(5)               Clam AntiVirus               freshclam.conf(5)
2
3
4

NAME

6       freshclam.conf  - Configuration file for Clam AntiVirus database update
7       tool
8

DESCRIPTION

10       The file freshclam.conf configures the Clam AntiVirus Database Updater,
11       freshclam(1).
12

FILE FORMAT

14       The  file  consists  of  comments and options with arguments. Each line
15       which starts with a hash (#) symbol is ignored by the  parser.  Options
16       and  arguments  are case sensitive and of the form Option Argument. The
17       arguments are of the following types:
18
19       BOOL   Boolean value (yes/no or true/false or 1/0).
20
21       STRING String without blank characters.
22
23       SIZE   Size in bytes. You can use 'M' or 'm'  modifiers  for  megabytes
24              and 'K' or 'k' for kilobytes.
25
26       NUMBER Unsigned integer.
27

DIRECTIVES

29       When  an  option is not used (hashed or doesn't exist in the configura‐
30       tion file) freshclam takes a default action.
31
32       Example
33              If this option is set freshclam will not run.
34
35       DatabaseOwner STRING
36              When started by root, drop privileges to a specified user.
37              Default:
38
39       AllowSupplementaryGroups BOOL
40              Initialize supplementary group access (freshclam must be started
41              by root).
42              Default: disabled
43
44       DatabaseDirectory STRING
45              Path to a directory containing database files.
46              Default: /var/lib/clamav
47
48       Checks NUMBER
49              Number of database checks per day.
50              Default: 12
51
52       UpdateLogFile STRING
53              Enable logging to a specified file. Highly recommended.
54              Default: disabled.
55
56       LogSyslog BOOL
57              Enable  logging  to  Syslog.  May  be  used  in combination with
58              UpdateLogFile.
59              Default: disabled.
60
61       LogFacility STRING
62              Specify the type of syslog messages - please refer to 'man  sys‐
63              log' for facility names.
64              Default: LOG_LOCAL6
65
66       PidFile STRING
67              This  option  allows  you  to save the process identifier of the
68              daemon to a file specified in the argument.
69              Default: disabled
70
71       LogVerbose BOOL
72              Enable verbose logging.
73              Default: disabled
74
75       DNSDatabaseInfo STRING
76              This directive enables  database  and  software  version  checks
77              through DNS TXT records.
78              Default: enabled, pointing to current.cvd.clamav.net
79
80       DatabaseMirror STRING
81              Server name where database updates are downloaded from. In order
82              to download the database from the closest mirror you should con‐
83              figure  freshclam  to  use  db.xy.clamav.net where xy represents
84              your country code. If  this  option  is  given  multiple  times,
85              freshclam(1) tries them in the order given. It's strongly recom‐
86              mended that you use db.xy.clamav.net as  the  first  mirror  and
87              database.clamav.net as the second.
88              Default: database.clamav.net
89
90       MaxAttempts NUMBER
91              How many attempts (per mirror) to make before giving up.
92              Default: 3 (per mirror)
93
94       ScriptedUpdates BOOL
95              With  this  option you can control scripted updates. It's highly
96              recommended to keep it enabled.
97              Default: enabled
98
99       HTTPProxyServer STR, HTTPProxyPort NUMBER
100              Use given proxy server and TCP port for database downloads.
101
102       HTTPProxyUsername STR,HTTPProxyPassword STRING
103              Proxy usage is authenticated through given  username  and  pass‐
104              word.
105              Default: no proxy authentication
106
107       HTTPUserAgent STRING
108              If  your servers are behind a firewall/proxy which applies User-
109              Agent filtering, you can use this option to force the use  of  a
110              different User-Agent header.
111              Default: clamav/version_number
112
113       LocalIPAddress IP
114              Use  IP  as client address for downloading databases. Useful for
115              multi homed systems.
116              Default: Use OS´es default outgoing IP address.
117
118       NotifyClamd STRING
119              Notify a running clamd(8) to reload its database after  a  down‐
120              load  has  occurred.  The  path for clamd.conf file must be pro‐
121              vided.
122              Default: The default is to not notify clamd. See clamd.conf(5)´s
123              option  SelfCheck  for  how clamd(8) handles database updates in
124              this case.
125
126       OnUpdateExecute STRING
127              Execute this command after the database  has  been  successfully
128              updated.
129              Default: disabled
130
131       OnOutdatedExecute STRING
132              Execute this command when freshclam reports outdated version. In
133              the command string %v will be replaced by the new  version  num‐
134              ber.
135              Default: disabled
136
137       OnErrorExecute STRING
138              Execute this command after a database update has failed.
139              Default: disabled
140
141       ConnectTimeout NUMBER
142              Timeout in seconds when connecting to database server.
143              Default: 10
144
145       ReceiveTimeout NUMBER
146              Timeout in seconds when reading from database server.
147              Default: 30
148

FILES

150       /etc/freshclam.conf
151

AUTHOR

153       Thomas Lamy <thomas.lamy@netwake.de>, Tomasz Kojm <tkojm@clamav.net>
154

NAME

DESCRIPTION

FILE FORMAT

DIRECTIVES

FILES

AUTHOR

SEE ALSO