1.. _install-virus:
2
3=============
4Virus Scanner
5=============
6
7About virus scan support
8========================
9
10Cyrus can use an external virus scanner to check for infected mail. Currently,
11only `ClamAV`_ is supported.
12
13Infected mail can be reported on, or removed.
14
15It is possible to use Cyrus's virus scanner support **without** a virus scanner,
16by passing in an IMAP SEARCH string. Messages matching that string are treated
17as infected.
18
19For more information, see :cyrusman:`cyr_virusscan(8)`.
20
21.. _ClamAV: https://www.clamav.net
22
23Virus Scanner Configuration
24===========================
25
26General configuration
27---------------------
28
29Once the virus scanner has been installed, Cyrus must be recompiled: the
30configure step will detect the presence of a supported virus library and
31use it.
32
33:cyrusman:`cyr_virusscan(8)` can be run manually, or configured to run
34periodically by cron(8) via crontab(5) or your preferred method
35(i.e. /etc/cron.hourly), or by :cyrusman:`master(8)` in the EVENTS{} section in
36:cyrusman:`cyrus.conf(5)`.
37
38ClamAV
39------
40
41Cyrus does not need any special configuration to work with `ClamAV`_:
42once ClamAV is installed, compiling Cyrus will automatically detect and use
43the ClamAV libraries.
44