🧹 Docker Host Cleanup

Tool prunes images, containers, networks and volumes scheduled and keeps your Docker hosts clean. See Docker Hub for more details about it.

Supported Tags

latest, 24.0 (Dockerfile)
23.0 (Dockerfile)
20.10 (Dockerfile)
19.03 (Dockerfile)
18.09 (Dockerfile)
18.03 (Dockerfile)

Note: The image supports these architectures: linux/amd64, linux/arm64/v8

Technologies

Docker CLI
Cron

Dependencies

Docker

Usage

Note: Don't use the latest tag in production. Choose it according to the version of Docker you are using on your machine. Get the version with docker version.

Environment Variables

Control the cleanup behaviour with environment variables.

Name	Default	Example	Description
`CRON_INTERVAL`	–	`0 3 * * *`	Set cron schedule
`PRUNE_BUILD_CACHES`	`false`	`true`	Remove all unused build caches
`PRUNE_BUILD_CACHES_FILTER`	-	`until=24h`	Remove filtered and unused build caches.
`PRUNE_CONTAINERS`	`false`	`true`	Remove all stopped containers
`PRUNE_CONTAINERS_FILTER`	-	`until=24h`	Remove filtered and stopped containers. See Docker docs for more examples.
`PRUNE_IMAGES`	`false`	`true`	Remove all unused images
`PRUNE_IMAGES_FILTER`	-	`until=24h`	Remove filtered and unused images. See Docker docs for more examples.
`PRUNE_NETWORKS`	`false`	`true`	Remove all unused networks. Networks will be removed after container cleanup.
`PRUNE_NETWORKS_FILTER`	-	`until=24h`	Remove filtered and unused networks. Networks will be removed after container cleanup. See Docker docs for more examples.
`PRUNE_VOLUMES`	`false`	`true`	⚠️ Remove all local volumes that are not referenced by any container. Networks will be removed after container cleanup.

Option 1: Run as a Container

docker container run \
    --volume /var/run/docker.sock:/var/run/docker.sock \
    --env CRON_INTERVAL="0 3 * * *" \
    --env PRUNE_IMAGES=true \
    servivum/docker-host-cleanup:latest

Option 2: Run as a Service

docker service create \
    --name docker-host-cleanup \
    --mount type=bind,source=/var/run/docker.sock,destination=/var/run/docker.sock \
    --env CRON_INTERVAL="0 3 * * *" \
    --env PRUNE_IMAGES=true \
    servivum/docker-host-cleanup:latest

Option 3: Deploy as a Stack

Adapt docker-compose.production.yml to your needs and deploy it with:

docker stack deploy -c docker-compose.production.yml docker-host-cleanup

Contributing

To release a new version on Docker Hub run:

export DOCKER_VERSION="24.0"

# Init buildx
docker buildx create --use

# Build, tag and push
docker buildx build \
  --file $DOCKER_VERSION/Dockerfile \
  --platform linux/amd64,linux/arm64/v8 \
  --tag servivum/docker-host-cleanup:$DOCKER_VERSION \
  --push \
  .

License

GNU General Public License v3.0