16d15504 |
# ClamAV
ClamAV® is an open source antivirus engine for detecting trojans, viruses,
malware & other malicious threats.
## Documentation & FAQ
|
9a54f5cc |
The ClamAV documentation can be found in the [ClamAV User Manual](docs/UserManual.md) with |
16d15504 |
additional information online in |
964a1e73 |
[our FAQ](https://www.clamav.net/documents). |
16d15504 |
## ClamAV Signatures
|
9a54f5cc |
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! |
16d15504 |
## Installation Instructions
|
9a54f5cc |
### UNIX |
16d15504 |
|
9a54f5cc |
#### Build from Source on Linux/Unix/Mac |
16d15504 |
|
9a54f5cc |
For basic compile and install instructions on Linux/Unix platforms, check out
the [install instructions](INSTALL.md). |
16d15504 |
|
9a54f5cc |
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 |
964a1e73 |
[our website](https://www.clamav.net/documents/installing-clamav). |
16d15504 |
|
9a54f5cc |
### 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).
|
16d15504 |
### Upgrading from a previous version
|
964a1e73 |
Some tips on [how to upgrade](https://www.clamav.net/documents/upgrading-clamav) |
16d15504 |
from a previous version of ClamAV.
## ClamAV News
|
9a54f5cc |
For information about the features in this and prior releases, read [the news](NEWS.md). |
16d15504 |
Catch up on the latest about ClamAV by reading our
[blog](http://blog.clamav.net) and follow us on Twitter @clamav.
## Join the ClamAV Community
The best way to get in touch with the ClamAV community is to join our |
964a1e73 |
[our mailing lists](https://www.clamav.net/documents/mailing-lists-faq), and |
16d15504 |
tune to #clamav on [IRC](irc.freenode.net).
|
41d36650 |
## Want to make a contribution? |
16d15504 |
The ClamAV development team welcomes
[code contributions](https://github.com/Cisco-Talos/clamav-devel),
improvements to [our FAQ](https://github.com/Cisco-Talos/clamav-faq), and also |
964a1e73 |
[bug reports](https://bugzilla.clamav.net/). Thanks for joining us! |
6289eda8 |
## Credits
|
964a1e73 |
[The ClamAV Team](https://www.clamav.net/about.html#credits) |