@@ -61,3 +61,5 @@ libclamav/c++/llvm/tools/llvmc/plugins/Base/Base.td

 *.obj

 *.opendb

 .vscode

+install/*

+build/*

@@ -5,27 +5,51 @@ ClamAV® is an open source antivirus engine for detecting trojans, viruses,

 ## Documentation & FAQ

-The ClamAV documentation can be found in locally in `docs/UserManual.md` with

+The ClamAV documentation can be found in the [ClamAV User Manual](docs/UserManual.md) with

  additional information online in

 [our FAQ](https://www.clamav.net/documents).

 ## ClamAV Signatures

-Anyone can learn to read and write ClamAV signatures.  Take a look

- at `docs/signatures.pdf` and `docs/phishsigs_howto.pdf` to get started!

+Anyone can learn to read and write ClamAV signatures. Take a look

+ at the [signature writing documentation](docs/UserManual/Signatures.md) and [phishing signature writing documentation](docs/UserManual/PhishSigs.md) to get started!

 ## Installation Instructions

-### Build from Source

+### UNIX

-For basic compile and install instructions, check out `INSTALL.md`.  For more

- detail please investigate the docs in `docs/UserManual.md`.

+#### Build from Source on Linux/Unix/Mac

-### Install from a binary package

+For basic compile and install instructions on Linux/Unix platforms, check out

+the [install instructions](INSTALL.md).

-For binary package distribution insallation instructions, head over to

+For detailed instructions specific to building ClamAV please investigate

+our the [Linux/Unix/Mac Install instructions in the User Manual](docs/UserManual/Installation-Unix.md).

+

+#### Install from a binary package

+

+For binary package distribution installation instructions, head over to

 [our website](https://www.clamav.net/documents/installing-clamav).

+### Windows

+

+#### Build from Source on Windows

+

+The instructions for building ClamAV from source on Windows is located in the

+[Win32 README](win32/README.md).

+

+#### Using an Install Package

+

+We provide an installer to install ClamAV on Windows to "C:\\Program Files".

+This install method will require you to have Adminstrator priveleges.

+

+We also provide a "Portable Install Package" (i.e. a zip of the required files)

+for users that may wish to run ClamAV without installing it to a system-owned

+directory.

+

+For details on how to use either option, head over to the

+[Windows Install instructions in the User Manual](docs/UserManual/Installation-Windows.md).

+

 ### Upgrading from a previous version

 Some tips on [how to upgrade](https://www.clamav.net/documents/upgrading-clamav)

@@ -33,7 +57,7 @@ Some tips on [how to upgrade](https://www.clamav.net/documents/upgrading-clamav)

 ## ClamAV News

-For information about the features in this and prior releases, see `NEWS.md`.

+For information about the features in this and prior releases, read [the news](NEWS.md).

 Catch up on the latest about ClamAV by reading our

  [blog](http://blog.clamav.net) and follow us on Twitter @clamav.

@@ -7,7 +7,9 @@

 Table Of Contents

 1. [Introduction to ClamAV](UserManual/Introduction.md)

-2. [Installing ClamAV](UserManual/Installation.md)

+2. Installing ClamAV

+    * [Unix/Linux/macOS](UserManual/Installation-Unix.md)

+    * [Windows](UserManual/Installation-Windows.md)

 3. [Configuring ClamAV](UserManual/Configuration.md)

 4. [Using ClamAV](UserManual/Usage.md)

 5. [Build \[lib\]ClamAV Into Your Programs](UserManual/libclamav.md)

new file mode 100644

@@ -0,0 +1,261 @@

+# Installing ClamAV on Unix / Linux / macOS from Source

+

+## The TL;DR Step-by-Step Instructions

+

+- [Debian & Ubuntu](Installation-Unix/Steps-Debian-Ubuntu.md)

+- [Redhat & CentOS](Installation-Unix/Steps-REdhat-CentOS.md)

+- [macOS](Installation-Unix/Steps-macOS.md)

+

+## Requirements

+

+The following is an overview of the tools, libraries, and steps needed to build ClamAV.

+

+Required tools:

+

+- `gcc` or `clang`

+- GNU Make (`gmake` on UNIX systems)

+

+Recommended tools:

+

+- `check` unit testing framework

+

+***Required*** libraries (including development sources (i.e. `...-dev` or `...-devel`)):

+

+- zlib

+- openssl version 0.9.8 or higher

+

+**Recommended** libraries (including development sources (i.e. `...-dev` or `...-devel`)):

+

+- pcre2

+- bzip2

+- libxml2

+

+Optional libraries (including development sources (i.e. `...-dev` or `...-devel`)):

+

+- curl library:     _required for clamsubmit_

+- json-c library:   _required for clamsubmit_

+- ncurses library:  _required for clamdtop_

+

+ClamAV may execute Bytecode signatures using:

+

+- ClamAV's built-in bytecode interpreter

+- LLVM for Just-In-Time (JIT) compilation*

+  - System-installed LLVM library (3.2-3.6)

+  - ClamAV's built-in version of LLVM 2.8

+

+    *The performance difference between using LLVM and using the interpeter is negligible. If you prefer to use LLVM / JIT for bytecode signature execution, be advised that we presently only support up to LLVM version 3.6.

+

+The following are thus optional, but *required* to use LLVM in place of the bytecode interpeter:

+

+- LLVM 3.2 - 3.6

+- A supported CPU for LLVM JIT, either of: X86, X86-64, PowerPC, PowerPC64

+

+The following are optional, but needed for the LLVM JIT unit tests:

+

+- GNU Make (version 3.79, recommended 3.81 or newer)

+- Python (version 2.5.4)

+

+## Installing ClamAV

+

+### Private installation on local shell account

+

+To install ClamAV locally on an unprivileged shell account you need not create any additional users or groups. Assuming your home directory is `/home/gary` you should build it as follows:

+

+```bash

+./configure --prefix=/home/gary/clamav --disable-clamav

+make; make install

+```

+

+The `--disable-clamav` switch disables the check for existence of the `clamav` user and group but `clamscan` would still require an unprivileged account to work in a superuser mode.

+

+### Global installation in system-owned directories

+

+#### Adding new system user and group

+

+If installing to the system, it is recommended to set up at least one special user account to run `freshclam` and `clamd`. You may choose to set up two separate accounts, one for each. You only need to create these accounts the first time you install ClamAV.

+

+These are instructions specific to some popular operating systems:

+

+- [Debian, Ubuntu, etc](Installation-Unix/Steps-Debian-Ubuntu.md#Users-and-on-user-privileges)

+- [Redhat, CentOS, etc](Installation-Unix/Steps-Redhat-CentOS.md#Users-and-on-user-privileges)

+- [macOS](Installation-Unix/Steps-macOS.md#Users-and-on-user-privileges)

+

+If your operating system isn't specified above, and your OS does not have the `groupadd` and `useradd` utilities, consult a system manual. **Don’t forget to lock access to the account!**

+

+#### Compiling ClamAV for global installation

+

+Once you have created the clamav user and group, please extract the archive:

+

+```bash

+tar xzf clamav-<ver>.tar.gz

+cd clamav-<ver>

+```

+

+Assuming you want to install the configuration files in `/etc`, configure and build the software as follows:

+

+```bash

+./configure --sysconfdir=/etc

+make

+su -c "make install"

+```

+

+In the last step, the software is installed into the `/usr/local` directory and the config files into `/etc`. **WARNING: Never enable the SUID or SGID bits for Clam AntiVirus binaries.**

+

+### First-time set-up

+

+First, create a database directory. This would be located under the install path `share/clamav`. For example:

+

+- `/usr/local/share/clamav`

+- `~/clamav/share/clamav`

+

+You will need to create `freshclam.conf` and `clamd.conf` files in the config directory. In the above example, we chose `/etc`, so run the following.

+

+```bash

+sudo cp /etc/freshclam.conf.sample /etc/freshclam.conf

+sudo cp /etc/clamd.conf.sample /etc/clamd.conf

+```

+

+At a minimum, you will need to edit each file and remove or comment-out the `Example` line. In addition, for `clamd.conf` you will need to enable either `LocalSocket` or `TCPSocket`.

+

+For additional recommendations, please read:

+

+- [Debian, Ubuntu, etc](Installation-Unix/Steps-Debian-Ubuntu.md#First-time-set-up)

+- [Redhat, CentOS, etc](Installation-Unix/Steps-Redhat-CentOS.md#First-time-set-up)

+- [macOS](Installation-Unix/Steps-macOS.md#First-time-set-up)

+

+### Test your installation

+

+To test your local installation execute:

+

+```bash

+~/clamav/bin/freshclam

+~/clamav/bin/clamscan ~

+```

+

+To test your system installation execute:

+

+```bash

+sudo freshclam

+sudo clamscan ~

+```

+

+## Compilation with clamav-milter enabled

+

+The `libmilter` package and its development files are required. To enable clamav-milter, configure ClamAV with

+

+```bash

+./configure --enable-milter

+```

+

+## Using a system-installed LLVM library

+

+To configure ClamAV to use a system-installed LLVM library:

+

+```bash

+./configure --with-system-llvm=/myllvm/bin/llvm-config

+make

+sudo make install

+```

+

+The argument to `--with-system-llvm` indicates the path name of the LLVM configuration utility (llvm-config). Alternatively, you may use `--enable-llvm` and `./configure` will search for LLVM in /usr/local/ and then /usr.

+

+Recommended versions of LLVM are 3.2 - 3.6. Some installations have reported problems using earlier LLVM versions. Versions of LLVM beyond 3.6 are not currently supported in ClamAV.

+

+## Running unit tests

+

+ClamAV includes unit tests that allow you to test that the compiled binaries work correctly on your platform.

+

+The first step is to use your OS’s package manager to install the `check` package. If your OS doesn’t have that package, you can download it from <http://check.sourceforge.net/>, build it and install it.

+

+To help clamav’s configure script locate `check`, it is recommended that you install `pkg-config`, preferably using your OS’s package manager, or from <http://pkg-config.freedesktop.org>.

+

+The recommended way to run unit-tests is the following, which ensures you will get an error if unit tests cannot be built:

+

+```bash

+./configure --enable-check

+make

+make check

+```

+

+When `make check` is finished, you should get a message similar to this:

+

+```bash

+==================

+All 8 tests passed

+==================

+```

+

+If a unit test fails, you get a message similar to the following. Note that in older versions of make check may report failures due to the absence of optional packages. Please make sure you have the latest versions of the components noted in section /refsec:components. See the next section on how to report a bug when a unit test fails.

+

+```bash

+========================================

+1 of 8 tests failed

+Please report to https://bugzilla.clamav.net/

+========================================

+```

+

+If unit tests are disabled (and you didn’t use -–enable-check), you will get this message:

+

+```bash

+*** Unit tests disabled in this build

+*** Use ./configure --enable-check to enable them

+

+SKIP: check_clamav

+PASS: check_clamd.sh

+PASS: check_freshclam.sh

+PASS: check_sigtool.sh

+PASS: check_clamscan.sh

+======================

+All 4 tests passed

+(1 tests were not run)

+======================

+```

+

+Running `./configure --enable-check` should tell you why.

+

+## Reporting a unit test failure bug

+

+If `make check` reports failed tests, we encourage you to report a bug on [bugzilla](https://bugzilla.clamav.net).

+

+When writing a bug report regarding failed unit tests, please provide the following:

+

+- The exact output from `make check`

+- Output of `uname -mrsp`

+- your `config.log`

+- The following files from the `unit_tests/` directory:

+  - `test.log`

+  - `clamscan.log`

+  - `clamdscan.log`

+

+- `/tmp/clamd-test.log` if it exists

+- where and how you installed the check package

+- Output of `pkg-config check --cflags --libs`

+- Optionally if `valgrind` is available on your platform, the output of the following:

+    ```bash

+    make check

+    CK_FORK=no ./libtool --mode=execute valgrind unit_tests/check_clamav

+    ```

+

+## Obtain Latest ClamAV anti-virus signature databases

+

+Before you can run `clamd`, `clamdscan`, or `clamscan`, you must have ClamAV Virus Database (.cvd) file(s) installed in the appropriate location on your system. The default location for these database files are `/usr/local/share/clamav`.

+

+Here is a listing of currently available ClamAV Virus Database Files:

+

+- bytecode.cvd (signatures to detect bytecode in files)

+- main.cvd (main ClamAV virus database file)

+- daily.cvd (daily update file for ClamAV virus databases)

+- safebrowsing.cvd (virus signatures for safe browsing)

+

+These files should be downloaded using the `freshclam` utility on a periodic basis. While using HTTPS to directly download the CVDs is possible, using `freshclam` is the preferred method of keeping the ClamAV virus database files up to date. `freshclam` can download database difference files (`.cdiff`) to get the latest signature definitions without downloading whole CVD files. This saves a considerable amount of bandwidth.

+

+For more information on how to configure `freshclam` to do automatic/scheduled updates, see the [freshclam configuration section](Configuration.md#Setting-up-auto\-updating) of our Configuration guide.

+

+Please see the [freshclam usage section](Usage.md#freshclam) for additional details on freshclam).

+

+## Binary packages

+

+As an alternative to building and installing from source, most Linux package managers provide pre-compiled ClamAV packages.

+

+For more information about installing ClamAV via a Package Manager, please visit

+the ["other versions" section on the ClamAV.net Downloads page](https://www.clamav.net/download.html#otherversions).

new file mode 100644

@@ -0,0 +1,309 @@

+# Installation on Debian and Ubuntu Linux Distributions

+

+Below are the steps for installing ClamAV from source on Debian and Ubuntu Linux.

+

+## Install prerequisitesaa

+

+1. Install ClamAV dependencies

+    1. Install the developer tools

+        ```bash

+        sudo apt-get install build-essential

+        ```

+    2. Install library dependencies

+        ```bash

+        sudo apt-get install openssl libssl-dev zlib1g-dev libpng-dev libxml2-dev libjson-c-dev libbz2-dev libpcre3-dev

+        ```

+

+2. Install the unit testing dependencies

+    ```bash

+    sudo apt-get valgrind check

+    ```

+

+_Note_: LLVM is also an optional dependency. LLVM will not provide any additional features, but is an alternative method for executing bytecode signatures versus using the built-in bytecode interpreter. Limited performance testing between LLVM and the bytecode interpreter did not yield conclusive evidence that one is "better" than the other. For the sake of simplicity, it is not recommended to install LLVM.

+

+## Download the latest stable release

+

+1. Open a browser and navigate to [the ClamAV downloads page](http://www.clamav.net/downloads)

+2. Click `clamav-<version>.tar.gz` link to download the latest stable release.

+

+## Extract the source archive

+

+```bash

+cd ~/Downloads

+tar xzf clamav-<ver>.tar.gz

+cd clamav-<ver>.tar.gz

+```

+

+## Configure the build

+

+ClamAV's configure script should detect each of the above dependencies automatically.

+

+### Typical `./configure` usage

+

+```bash

+./configure --enable-check

+```

+

+Once `./configure` completes, it will print a summary. Verify that the packages you installed are in fact being detected.

+

+Example configure summary output:

+

+```bash

+configure: Summary of detected features follows

+              OS          : linux-gnu

+              pthreads    : yes (-lpthread)

+configure: Summary of miscellaneous features

+              check       : -lcheck_pic -pthread -lrt -lm -lsubunit

+              fanotify    : yes

+              fdpassing   : 1

+              IPv6        : yes

+configure: Summary of optional tools

+              clamdtop    : -lncurses (auto)

+              milter      : yes (disabled)

+              clamsubmit  : yes (libjson-c-dev found at /usr), libcurl-devel found at /usr)

+configure: Summary of engine performance features

+              release mode: yes

+              llvm        : no (disabled)

+              mempool     : yes

+configure: Summary of engine detection features

+              bzip2       : ok

+              zlib        : /usr

+              unrar       : yes

+              preclass    : yes (libjson-c-dev found at /usr)

+              pcre        : /usr

+              libmspack   : yes (Internal)

+              libxml2     : yes, from /usr

+              yara        : yes

+              fts         : yes (libc)

+

+```

+

+### Additional popular `./configure` options

+

+* `--with-systemdsystemunitdir` - Do not install `systemd` socket files. This option disables systemd support, but will allow you to `make install` to a user-owned directory without requiring `sudo`/root privileges:

+    ```bash

+    ./configure --with-systemdsystemunitdir=no

+    ```

+* `--sysconfdir` - Install the configuration files to `/etc` instead of `/usr/local/etc`:

+    ```bash

+    ./configure -–sysconfdir=/etc

+    ```

+* `--prefix` - Install ClamAV to a directory other than `/usr/local/`:

+    * Example 1: Install to a local `./install` directory.

+        ```bash

+        ./configure --prefix=`pwd`/install

+        ```

+    * Example 2: Install ClamAV locally on an unprivileged shell account.

+        ```bash

+        ./configure --prefix=$HOME/clamav --disable-clamav --with-systemdsystemunitdir=no

+        ```

+* `--disable-clamav` - _Don't_ drop super-user priveleges to run `freshclam` or `clamd` as the `clamav`* user.

+    ```bash

+    ./configure --disable-clamav

+    ```

+    *_Tip_: Using this `--disable-clamav` means that `freshclam` and `clamd` will run with _root privleges_ if invoked using `sudo`. Running `clamd` or `clamscan` as root is **not recommended**. Instead of using this option, you can configure `freshclam` or `clamd` to drop to any other user by:

+    * setting the `DatabaseOwner` option in `freshclam.conf` and

+    * setting the `User` option in `clamd.conf`.

+

+Please see the `./configure --help` for additional options.

+

+### Compile ClamAV

+

+Compile ClamAV with:

+```bash

+make -j2

+```

+

+### Run ClamAV Unit Tests (Optional)

+

+For peace of mind, it can be helpful to run a small suite of unit and system tests.

+

+Run:

+```bash

+make check

+```

+

+All tests should pass.* Output will look something like this:

+

+```bash.

+    ...

+PASS: check_clamav

+PASS: check_freshclam.sh

+PASS: check_sigtool.sh

+PASS: check_unit_vg.sh

+PASS: check1_clamscan.sh

+PASS: check2_clamd.sh

+PASS: check3_clamd.sh

+PASS: check4_clamd.sh

+PASS: check5_clamd_vg.sh

+PASS: check6_clamd_vg.sh

+SKIP: check7_clamd_hg.sh

+PASS: check8_clamd_hg.sh

+PASS: check9_clamscan_vg.sh

+    ...

+============================================================================

+Testsuite summary for ClamAV 0.100.2

+============================================================================

+# TOTAL: 13

+# PASS:  12

+# SKIP:  1

+# XFAIL: 0

+# FAIL:  0

+# XPASS: 0

+# ERROR: 0

+```

+

+_Notes_:

+

+* The `*.vg.sh` tests will be skipped unless you run `make check VG=1`.

+* The `check7_clamd.hg.sh` (helgrind) is presently disabled and will be skipped.

+  * For details, see: [the Git commit](https://github.com/Cisco-Talos/clamav-devel/commit/2a5d51809a56be9a777ded02969a7427a3c26713)

+

+If you have a failure or an error in the unit tests, it could be that you are missing one or more of the prerequisites.

+

+If you are investigating a failure, please do the following:

+

+`cd unit_tests`

+

+Use `less` to read the log for the failed test.

+Example:

+

+```bash

+less check4_clamd.sh.log`

+```

+

+To submit a bug report regarding unit text failures, please follow these [bug reporting steps](../Installation-Unix.md#Reporting-a-unit-test-failure-bug).

+

+### Install ClamAV

+

+Install ClamAV with:

+```bash

+make install

+```

+

+_Tip_: If installing to the default or other system-owned directory, you may need to use `sudo`.

+

+### First time set-up

+

+_Note_: The following instructions assume you used the default install paths (i.e. `/usr/local`). If you modified the install locations using `--prefix` or `--sysconfdir` options, replace `/usr/local` with your chosen install path.

+

+#### `freshclam` config

+

+Before you can use `freshclam` to download updates, you need to create a `freshclam` config. A sample config is provided for you.

+

+1. Copy the sample config. You may need to use `sudo`:

+    ```bash

+    cp /usr/local/etc/freshclam.conf.sample /usr/local/etc/freshclam.conf

+    ```

+2. Modify the config file using your favourite text editor. Again, you may need to use `sudo`.

+    * At a minimum, remove the `Example` line so `freshclam` can use the config.

+

+    Take the time to look through the options. You can enable the sample options by deleting the `#` comment characters.

+

+    Some popular options to enable include:

+

+    * `LogTime`

+    * `LogRotate`

+    * `NotifyClamd`

+    * `DatabaseOwner`

+

+3. Create the database directory. *Tip: _You may need to use `sudo`._

+    ```bash

+    mkdir /usr/local/share/clamav

+    ```

+

+#### `clamd` config (optional)

+

+You can run `clamscan` without setting the config options for `clamd`. However, the `clamd` scanning daemon allows you to use `clamdscan` to perform faster a-la-carte scans, allows you to run multi-threaded scans, and allows you to use `clamav-milter` if you want to use ClamAV as a mail filter if you host an email server.

+

+Additionally, if you are a running modern versions of Linux where the FANOTIFY kernel feature is enabled, `clamd` has a feature run with On-Access Scanning*. *When properly configured*, On-Access Scanning can scan files as they are accessed and optionally block access to the file in the event that a signature alerted.

+

+  _Note_: At this time, for On-Access Scanning to work, `clamd` must run with `sudo`/root privileges. For more details, please see our documentation on On-Access Scanning.

+

+1. Copy the sample config. You may need to use `sudo`:

+    ```bash

+    cp /usr/local/etc/clamd.conf.sample /usr/local/etc/clamd.conf

+    ```

+2. Modify the config file using your favourite text editor. Again, you may need to use `sudo`.

+    * At a minimum, remove the `Example` line so `freshclam` can use the config.

+    * You also _need_ to select a Socket option for `clamd` so `clamdscan` and other utilities can communicate with `clamd`. You must enable _one_ of the following.

+        * `LocalSocket`

+        * `TCPSocket`

+

+    Take the time to look through the options. You can enable the sample options by deleting the `#` comment characters.

+

+    Some popular options to enable include:

+

+    * `LogTime`

+    * `LogClean`

+    * `LogRotate`

+    * `User`

+    * `ScanOnAccess`

+        * `OnAccessIncludePath`

+        * `OnAccessExcludePath`

+        * `OnAccessPrevention`

+

+#### Configure SELinux for ClamAV

+

+Certain distributions (notably RedHat variants) when operating with SELinux enabled use the non-standard `antivirus_can_scan_system` SELinux option instead of `clamd_can_scan_system`.

+

+At this time, libclamav only sets the `clamd_can_scan_system` option, so you may need to manually enable `antivirus_can_scan_system`. If you don't perform this step, freshclam will log something like this when it tests the newly downloaded signature databases:

+

+```

+During database load : LibClamAV Warning: RWX mapping denied: Can't allocate RWX Memory: Permission denied

+```

+

+To allow ClamAV to operate under SELinux, run the following:

+```bash

+setsebool -P antivirus_can_scan_system 1

+```

+

+#### Download / Update the signature database

+

+Before you can run a scan, you'll need to download the signature databases. Once again, you may need to run with `sudo`/root privileges.

+

+If you installed to a location in your system PATH:

+```bash

+freshclam

+```

+

+If you installed to another location:

+```bash

+/<path>/<to>/<clamav>/<bin>/freshclam

+```

+

+  _Important_: It is common on Ubuntu after a fresh install to see the following error the first time you use ClamAV:

+  ```bash

+  $ freshclam

+  freshclam: error while loading shared libraries: libclamav.so.7: cannot open shared object   file: No such file or directory

+  ```

+

+  You can fix this error by using ldconfig to rebuild the library search path.

+  ```bash

+  sudo ldconfig

+  ```

+

+#### Users and on user privileges

+

+If you are running `freshclam` and `clamd` as root or with `sudo`, and you did not explicitely configure with `--disable-clamav`, you will want to ensure that the `DatabaseOwner` user specified in `freshclam.conf` owns the database directory so it can download signature udpates.

+

+The user that `clamd`, `clamdscan`, and `clamscan` run as may be the same user, but if it isn't -- it merely needs _read_ access to the database directory.

+

+If you choose to use the default `clamav` user to run `freshclam` and `clamd`, you'll need to create the clamav group and the clamav user account the first time you install ClamAV.

+

+```bash

+groupadd clamav

+useradd -g clamav -s /bin/false -c "Clam Antivirus" clamav

+```

+

+Finally, you will want to set user ownership of the database directory.

+For example:

+```bash

+sudo chown -R clamav:clamav /usr/local/share/clamav

+```

+

+### Usage

+

+You should be all set up to run scans.

+

+Take a look at our [usage documentation](../Usage.md) to learn about how to use ClamAV each of the utilities.

new file mode 100644

@@ -0,0 +1,309 @@

+# Installation on Debian and Ubuntu Linux Distributions

+

+Below are the steps for installing ClamAV from source on Debian and Ubuntu Linux.

+

+## Install prerequisitesaa

+

+1. Install ClamAV dependencies

+    1. Install the developer tools

+        ```bash

+        sudo apt-get install build-essential

+        ```

+    2. Install library dependencies

+        ```bash

+        sudo apt-get install openssl libssl-dev zlib-devel libpng-devel libxml2-devel json-c-devel bzip2-devel pcre2-devel

+        ```

+

+2. Install the unit testing dependencies

+    ```bash

+    sudo apt-get valgrind check

+    ```

+

+_Note_: LLVM is also an optional dependency. LLVM will not provide any additional features, but is an alternative method for executing bytecode signatures versus using the built-in bytecode interpreter. Limited performance testing between LLVM and the bytecode interpreter did not yield conclusive evidence that one is "better" than the other. For the sake of simplicity, it is not recommended to install LLVM.

+

+## Download the latest stable release

+

+1. Open a browser and navigate to [the ClamAV downloads page](http://www.clamav.net/downloads)

+2. Click `clamav-<version>.tar.gz` link to download the latest stable release.

+

+## Extract the source archive

+

+```bash

+cd ~/Downloads

+tar xzf clamav-<ver>.tar.gz

+cd clamav-<ver>.tar.gz

+```

+

+## Configure the build

+

+ClamAV's configure script should detect each of the above dependencies automatically.

+

+### Typical `./configure` usage

+

+```bash

+./configure --enable-check

+```

+

+Once `./configure` completes, it will print a summary. Verify that the packages you installed are in fact being detected.

+

+Example configure summary output:

+

+```bash

+configure: Summary of detected features follows

+              OS          : linux-gnu

+              pthreads    : yes (-lpthread)

+configure: Summary of miscellaneous features

+              check       : -lcheck_pic -pthread -lrt -lm -lsubunit

+              fanotify    : yes

+              fdpassing   : 1

+              IPv6        : yes

+configure: Summary of optional tools

+              clamdtop    : -lncurses (auto)

+              milter      : yes (disabled)

+              clamsubmit  : yes (libjson-c-dev found at /usr), libcurl-devel found at /usr)

+configure: Summary of engine performance features

+              release mode: yes

+              llvm        : no (disabled)

+              mempool     : yes

+configure: Summary of engine detection features

+              bzip2       : ok

+              zlib        : /usr

+              unrar       : yes

+              preclass    : yes (libjson-c-dev found at /usr)

+              pcre        : /usr

+              libmspack   : yes (Internal)

+              libxml2     : yes, from /usr

+              yara        : yes

+              fts         : yes (libc)

+

+```

+

+### Additional popular `./configure` options

+

+* `--with-systemdsystemunitdir` - Do not install `systemd` socket files. This option disables systemd support, but will allow you to `make install` to a user-owned directory without requiring `sudo`/root privileges:

+    ```bash

+    ./configure --with-systemdsystemunitdir=no

+    ```

+* `--sysconfdir` - Install the configuration files to `/etc` instead of `/usr/local/etc`:

+    ```bash

+    ./configure -–sysconfdir=/etc

+    ```

+* `--prefix` - Install ClamAV to a directory other than `/usr/local/`:

+    * Example 1: Install to a local `./install` directory.

+        ```bash

+        ./configure --prefix=`pwd`/install

+        ```

+    * Example 2: Install ClamAV locally on an unprivileged shell account.

+        ```bash

+        ./configure --prefix=$HOME/clamav --disable-clamav --with-systemdsystemunitdir=no

+        ```

+* `--disable-clamav` - _Don't_ drop super-user priveleges to run `freshclam` or `clamd` as the `clamav`* user.

+    ```bash

+    ./configure --disable-clamav

+    ```

+    *_Tip_: Using this `--disable-clamav` means that `freshclam` and `clamd` will run with _root privleges_ if invoked using `sudo`. Running `clamd` or `clamscan` as root is **not recommended**. Instead of using this option, you can configure `freshclam` or `clamd` to drop to any other user by:

+    * setting the `DatabaseOwner` option in `freshclam.conf` and

+    * setting the `User` option in `clamd.conf`.

+

+Please see the `./configure --help` for additional options.

+

+### Compile ClamAV

+

+Compile ClamAV with:

+```bash

+make -j2

+```

+

+### Run ClamAV Unit Tests (Optional)

+

+For peace of mind, it can be helpful to run a small suite of unit and system tests.

+

+Run:

+```bash

+make check

+```

+

+All tests should pass.* Output will look something like this:

+

+```bash.

+    ...

+PASS: check_clamav

+PASS: check_freshclam.sh

+PASS: check_sigtool.sh

+PASS: check_unit_vg.sh

+PASS: check1_clamscan.sh

+PASS: check2_clamd.sh

+PASS: check3_clamd.sh

+PASS: check4_clamd.sh

+PASS: check5_clamd_vg.sh

+PASS: check6_clamd_vg.sh

+SKIP: check7_clamd_hg.sh

+PASS: check8_clamd_hg.sh

+PASS: check9_clamscan_vg.sh

+    ...

+============================================================================

+Testsuite summary for ClamAV 0.100.2

+============================================================================

+# TOTAL: 13

+# PASS:  12

+# SKIP:  1

+# XFAIL: 0

+# FAIL:  0

+# XPASS: 0

+# ERROR: 0

+```

+

+_Notes_:

+

+* The `*.vg.sh` tests will be skipped unless you run `make check VG=1`.

+* The `check7_clamd.hg.sh` (helgrind) is presently disabled and will be skipped.

+  * For details, see: [the Git commit](https://github.com/Cisco-Talos/clamav-devel/commit/2a5d51809a56be9a777ded02969a7427a3c26713)

+

+If you have a failure or an error in the unit tests, it could be that you are missing one or more of the prerequisites.

+

+If you are investigating a failure, please do the following:

+

+`cd unit_tests`

+

+Use `less` to read the log for the failed test.

+Example:

+

+```bash

+less check4_clamd.sh.log`

+```

+

+To submit a bug report regarding unit text failures, please follow these [bug reporting steps](../Installation-Unix.md#Reporting-a-unit-test-failure-bug).

+

+### Install ClamAV

+

+Install ClamAV with:

+```bash

+make install

+```

+

+_Tip_: If installing to the default or other system-owned directory, you may need to use `sudo`.

+

+### First time set-up

+

+_Note_: The following instructions assume you used the default install paths (i.e. `/usr/local`). If you modified the install locations using `--prefix` or `--sysconfdir` options, replace `/usr/local` with your chosen install path.

+

+#### `freshclam` config

+

+Before you can use `freshclam` to download updates, you need to create a `freshclam` config. A sample config is provided for you.

+

+1. Copy the sample config. You may need to use `sudo`:

+    ```bash

+    cp /usr/local/etc/freshclam.conf.sample /usr/local/etc/freshclam.conf

+    ```

+2. Modify the config file using your favourite text editor. Again, you may need to use `sudo`.

+    * At a minimum, remove the `Example` line so `freshclam` can use the config.

+

+    Take the time to look through the options. You can enable the sample options by deleting the `#` comment characters.

+

+    Some popular options to enable include:

+

+    * `LogTime`

+    * `LogRotate`

+    * `NotifyClamd`

+    * `DatabaseOwner`

+

+3. Create the database directory. *Tip: _You may need to use `sudo`._

+    ```bash