# lychee

**Repository Path**: samiux/lychee

## Basic Information

- **Project Name**: lychee
- **Description**: ClamAV On-Access Scanning Installer Script
- **Primary Language**: Shell
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-12-29
- **Last Updated**: 2025-08-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Lychee 荔枝 - ClamAV On-Access Scanning Installer Script

ClamAV's On-Access scanning can detect the known malwares/virus in real time.  Any Ubuntu Linux system can install this script when FANOTIFY is configured in your Linux kernel.

According to the developers that ClamAV is mainly designed for files upload, files downloads and file transfers.

## Verify

```
cat /boot/config-$(uname -r) | grep FANOTIFY
```

The suitable display is :

```
CONFIG_FANOTIFY=y
CONFIG_FANOTIFY_ACCESS_PERMISSIONS=y
```

When you see the following message, your Linux system is not suitable for this script.

```
CONFIG_FANOTIFY_ACCESS_PERMISSIONS is not set
``` 

## Softwares

- ClamAV 1.4.1
- Ubuntu 24.04 LTS  

Remarks : ClamAV uses about 3GB RAM.

## Change Log

### Version 0.14 (Dated SEP 05, 2024) (Latest)  
- Updated to ClamAV 1.4.1  

### Version 0.13 (Dated AUG 17, 2024)   
- Updated to ClamAV 1.4.0  

### Version 0.12 (Dated APR 18, 2024)   
- Updated to ClamAV 1.3.1  

### Version 0.11 (Dated FEB 08, 2024)   
- Updated to ClamAV 1.3.0  

### Version 0.10 (Dated OCT 26, 2023)   
- Updated to ClamAV 1.2.1  

### Version 0.9 (Dated AUG 29, 2023)   
- Updated to ClamAV 1.2.0  

### Version 0.8 (Dated AUG 24, 2023)  
- Minor modified  

### Version 0.7 (Dated AUG 18, 2023)  
- Updated to ClamAV 1.1.1  

### Version 0.6 (Dated MAY 02, 2023)  
- Updated to ClamAV 1.1.0  

### Version 0.5 (Dated FEB 16, 2023)   
- Updated to ClamAV 1.0.1  

### Version 0.4 (Dated JAN 05, 2023)   
- Minor modified  

### Version 0.3 (Dated JAN 01, 2023)   
- Add configure file  

### Version 0.2 (Dated DEC 30, 2022)   
- Add uninstallers  

### Version 0.1 (Dated DEC 28, 2022)   
- First release for ClamAV 1.0.0  

Remarks : This script is developed by Samiux and it is released under GPLv3.  It is an Open Source Project.

## Install and/or Update

Download the script.
```
git clone https://github.com/samiux/lychee
```

Edit the related parts at the top parts of the script.
```
cd lychee

nano lychee.conf
```

Then run the script to install ClamAV On-Access scanning.
```
sudo chmod +x clamav-installer
sudo ./clamav-installer
```
Please allow about 1 to 2 minutes for ClamAV to load the signatures.   
You can run this script at any time on the same Linux system box without any harm.

When only update or just simply download the latest ClamAV debian package from [ClamAV Releases](https://github.com/Cisco-Talos/clamav/releases/) and install the package by issuing the following command, for example.

```
sudo dpkg -i clamav-1.4.1.linux.x86_64.deb
```

## Modification

If you require to make change to the clamd.conf (for example, include or exclude some directories), you can edit it.

```
sudo nano /usr/local/etc/clamd.conf
```

After the edit, you should restart the ClamAV On-Access function.

```
sudo systemctl restart clamav-clamonacc.service
```

To verify the startup.

```
sudo cat /var/log/clamav/clamonacc.log
```

## Uninstall

```
sudo chmod +x deb-clamav-uninstaller
sudo ./deb-clamav-uninstaller
``` 

### Remove lychee directory
```
sudo rm -R lychee
```

## Test file
- [Eicar Test File](https://www.eicar.org/download-anti-malware-testfile/)  
- [AMTSO Security Features Check Tools -- Desktop](https://www.amtso.org/security-features-check/)  

## Known issues
- ~~[BUG : /home and it's sub-directories cannot be used in OnAccessIncludePath](https://github.com/Cisco-Talos/clamav/issues/799)~~  
- ClamAV uses at least 3GB RAM.
- ~~Non-existent directory will cause high CPU usage.~~  
- Cannot detect virus on Pen Drive (i.e. external mounted directories).  

## Reference

- [ClamAV Official Site](https://www.clamav.net/)  
- [ClamAV Downloads](https://www.clamav.net/downloads)  
- [ClamAV Documentation](https://docs.clamav.net/)  
- [ClamAV GitHub](https://github.com/Cisco-Talos/clamav)