components/sysutils/clamav/files/README-etc.txt

   1 = README file for OI-Userland delivery of ClamAV
   2
   3 == Overview
   4
   5 ClamAV is a multi-tiered system to scan static contents (emails, files,
   6 web-proxy download pages, etc.) for viruses and other fingerprinted
   7 malware. It is not a run-time antivirus that can catch exploits already
   8 running in your RAM; however there are protocol clients that can integrate
   9 with your local (ZFS) or networked (Samba) filesystem provider to prevent
  10 malware files from getting written in the first place.
  11
  12 In a few words: ClamAV includes a scanning engine that uses up-to-date
  13 virus definition databases (that you should download regularly) and is
  14 accessible both with a local command-line tool `clamscan` for singular
  15 invokations, and for streamlined usage - with a server process `clamd`
  16 that absorbs the impact of loading and tracking the definitions database.
  17 There are multiple clients that can connect to the `clamd` server, such
  18 as the `clamdscan` for command-line usage; `clamav-milter` for email
  19 scanning with Sendmail, Postfix and Sun Messaging Server among others;
  20 or the `C-ICAP` project for many other clients including Squid, ZFS
  21 and Samba, a SpamAssassin plugin, etc.
  22
  23 It is expected that ultimate deployments might not want to run all of
  24 the components in the same operating environment. In particular, the
  25 maintenance of a local copy of the virus definitions database adds a
  26 considerable storage and internet-traffic overhead which would be not
  27 needed on systems that do not run `clamd` or other implementations of
  28 the scanning engine directly.
  29
  30 This expectation is partially met by packaging that allows the sysadmin
  31 to "cherry pick" those components needed in a particular zone, and
  32 partially by not delivering any configuration (nor quickly obsoleted
  33 databases) out of the box.
  34
  35 == Configuring your deployment of ClamAV
  36
  37 Sample configuration files are delivered into `/usr/share/clamav/`.
  38 These include "vanilla" examples from the distribution, as well as
  39 `*.sol` files tuned for a typical deployment of this package on OI.
  40
  41 There is also a script `clamav-enable.sh` that can inspect which of
  42 the components you have installed, so it would copy sample configs
  43 into `/etc/clamav/` (of course, if there are no such files already
  44 set up there) and starts the services. For a `clamd` deployment it
  45 would also start `freshclam.sh` (wrapper for `freshclam` delivered
  46 by this package) to download the initial virus definition databases
  47 before starting the server for the first time.
  48
  49 Hope this helps,
  50 Jim Klimov