mirror of https://github.com/Cisco-Talos/clamav
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
93 lines
3.1 KiB
93 lines
3.1 KiB
# ClamAV
|
|
|
|
ClamAV® is an open source antivirus engine for detecting trojans, viruses,
|
|
malware & other malicious threats.
|
|
|
|
## Documentation & FAQ
|
|
|
|
Official documentation can be found online at
|
|
[ClamAV.net](https://www.clamav.net/documents).
|
|
Our source code release tarballs also includes a copy of the documentation for
|
|
[offline](docs/html/UserManual.html) reading.
|
|
|
|
## ClamAV Signatures
|
|
|
|
Anyone can learn to read and write ClamAV signatures. Take a look
|
|
at the
|
|
[signature writing documentation](https://www.clamav.net/documents/creating-signatures-for-clamav)
|
|
and
|
|
[phishing signature writing documentation](https://www.clamav.net/documents/phishsigs)
|
|
to get started!
|
|
|
|
## Installation Instructions
|
|
|
|
### UNIX
|
|
|
|
#### Build from Source on Linux/Unix/Mac
|
|
|
|
For basic compile and install instructions on Linux/Unix platforms, check out
|
|
the [install instructions](INSTALL.md).
|
|
|
|
For detailed instructions specific to building ClamAV please investigate
|
|
our the
|
|
[Linux/Unix/Mac Install instructions in the User Manual](https://www.clamav.net/documents/installing-clamav-on-unix-linux-macos-from-source).
|
|
|
|
For instructions on how to build ClamAV using our new *experimental* CMake
|
|
build tooling, see [INSTALL.cmake.md](INSTALL.cmake.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](https://www.clamav.net/documents/installing-clamav-on-windows).
|
|
|
|
For instructions on how to build ClamAV using our new *experimental* CMake
|
|
build tooling, see [INSTALL.cmake.md](INSTALL.cmake.md)
|
|
|
|
### Upgrading from a previous version
|
|
|
|
Some tips on [how to upgrade](https://www.clamav.net/documents/upgrading-clamav)
|
|
from a previous version of ClamAV.
|
|
|
|
## ClamAV News
|
|
|
|
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.
|
|
|
|
## Join the ClamAV Community
|
|
|
|
The best way to get in touch with the ClamAV community is to join our
|
|
[our mailing lists](https://www.clamav.net/documents/mailing-lists-faq), and
|
|
tune to #clamav on [IRC](irc.freenode.net).
|
|
|
|
## Want to make a contribution?
|
|
|
|
The ClamAV development team welcomes
|
|
[code contributions](https://github.com/Cisco-Talos/clamav-devel),
|
|
improvements to [our documentation](https://github.com/Cisco-Talos/clamav-faq), and also
|
|
[bug reports](https://bugzilla.clamav.net/). Thanks for joining us!
|
|
|
|
## Credits
|
|
|
|
[The ClamAV Team](https://www.clamav.net/about.html#credits)
|
|
|