Portainer Templates logo

Portainer Templates

Clamav Clamav

Container

OtherAnitvirus

ClamAV® is an open source antivirus engine for detecting trojans, viruses, malware & other malicious threats.

Image details

Pulls: 192.7M
Architecture: amd64, arm64, arm/v7, arm, arm64/v8
Image size: 46 MB
Latest: 1.1.2-buster
User: mkodockx
Created: Jan 31, 2015
Updated: 3 years ago
Status: active

Configuration

Type
Container
Platform
linux
Image
mkodockx/docker-clamav:alpine
Ports
3310:3310/tcp
Volumes
/etc/timezone : /etc/timezone/etc/localtime : /etc/localtime/etc/clamav : /portainer/Files/AppData/Config/clamav/config/var/lib/clamav : /portainer/Files/AppData/Config/clamav/virus_definitions
Restart
unless-stopped

Template by novaspirit

Notes

Template created by Pi-Hosted Series
Check our Github page: https://github.com/pi-hosted/pi-hosted

Official Webpage: https://docs.clamav.net/
Official Docker Documentation: https://hub.docker.com/r/mkodockx/docker-clamav

Pre-installation script must be RAN before you install: wget -qO- https://raw.githubusercontent.com/pi-hosted/pi-hosted/master/tools/install_clamav.sh | bash



Standalone Install

Select an install method, to see config/commands for deploying Clamav

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Clamav, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

More install options in our documentation.

docker-clamav

ClamAV Logo
ClamAV latest.stable
Dockerized open source antivirus daemons for use with
ClamAV daemon as a Docker image. It builds with a current virus database and runs freshclam in the background constantly updating the virus signature database. clamd itself is listening on exposed port 3310.

Releases

Find the latest releases at the official docker hub registry. There are different releases for the different platforms.

Usage

The container run as user clamav with uid=101 and gid=102.

Debian (default, :latest, :buster-slim, :stretch-slim)

  • buster-slim
  • stretch-slim
docker run -d -p 3310:3310 mkodockx/docker-clamav:buster-slim

Alpine (:alpine, :alpine-edge)

  • alpine
  • alpine-edge
docker run -d -p 3310:3310 mkodockx/docker-clamav:alpine

Linked usage recommended, to not expose the port to "everyone". 
docker run -d --name av mkodockx/docker-clamav(:alpine)
docker run -d --link av:av application-with-clamdscan-or-something

Environment VARs

Proxy

Thanks to @mchus proxy configuration is possible.
  • HTTPProxyServer: Allows to set a proxy server
  • HTTPProxyPort: Allows to set a proxy server port

Database Mirror

Specifying a particular mirror for freshclam is also possible.
  • DatabaseMirror: Hostname of the mirror web server.

Custom Configuration Files

Mount custom configuration files into the container.
  • FRESHCLAMCONFFILE: Path to custom freshclam.conf file, e.g. /mnt/freshclam.conf.
  • CLAMDCONFFILE: Set the path to a custom clamd.conf file, e.g. /mnt/clamd.conf.

Persistency

Virus update definitions are stored in /var/lib/clamav. To store the defintion just mount the directory as a volume, docker run -d -p 3310:3310 -v ./clamav:/var/lib/clamav mkodockx/docker-clamav:latest

docker-compose

See example with Nextcloud at docker-compose.yml. You still need to configure the AntiVirus files app in Nextcloud.
You can find a tutorial here: https://www.virtualconfusion.net/clamav-for-nextcloud-on-docker/

Healthcheck

The images provide with check.sh a file to check for the healthyness of the running container. To enable the health check configure your docker run or compose file. The start period should be adjusted to your system needs. Slow internet connection, with limited cpu and IO speed might require larger values.

Examples

Via docker run:
docker run --health-cmd=./check.sh \
            --health-start-period=120s \
            --health-interval=60s \
            --health-retries=3 \
            -p 3310:3310 mkodockx/docker-clamav:alpine`

Via docker-compose 
services:
  clamav:
    healthcheck:
      test: ["CMD", "./check.sh"]
      interval: 60s
      retries: 3
      start_period: 120s

Build multi-arch

This image provides support for different platforms
  • x86
  • amd64
  • arm32v7
  • arm64v8

Known Forks

Serve Clamav on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying clamav.example.com to http://clamav:3310

Add this to your Caddyfile

clamav.example.com {
	reverse_proxy http://clamav:3310
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs clamav
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:3310 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :3310
  • Stop the other service, or pick a different host port. In 3310:3310 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:3310. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, clamav can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 3310

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /etc/timezone (and the same for the other mapped folders)

Image won't pull

Test the pull directly on the host: docker pull mkodockx/docker-clamav:alpine

  • "manifest unknown" means the tag no longer exists.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64, arm/v7, arm, arm64/v8
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect clamav --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A single container

Clamav runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Clamav needs bundled into one download. This template pulls mkodockx/docker-clamav:alpine, which Docker fetches once (about 46 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Clamav's comes from Docker Hub, published by mkodockx.

Version tags

The bit after the colon in the image name is the version tag. This one pins alpine, so every redeploy gives you that exact build until you bump it yourself.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, arm/v7, arm, arm64/v8, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 3310:3310 means it's reachable on port 3310 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 3310:3310

Volumes

A volume is where Clamav keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /etc/timezone from /etc/timezone on the host
  • /etc/localtime from /etc/localtime on the host
  • /etc/clamav from /portainer/Files/AppData/Config/clamav/config on the host
  • /var/lib/clamav from /portainer/Files/AppData/Config/clamav/virus_definitions on the host

Restart policy

The restart policy here is unless-stopped, so Docker restarts Clamav after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Nothing custom is set, so Clamav sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container clamav. That's what you'll spot in the containers list and use in commands like docker logs clamav.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Clamav up. Add the template list to Portainer once, then deploying Clamav is a click rather than a wall of config.