stephanmisc/docuum

Docuum Docker镜像文档

镜像概述和主要用途

Docuum是一款专注于自动清理Docker镜像的工具，旨在解决Docker环境中镜像过多导致磁盘空间占用过大的问题。它通过LRU（最近最少使用）缓存淘汰策略，自动识别并保留最近使用的镜像，同时删除长期未使用的旧镜像，从而实现磁盘空间的自动释放，减少用户手动清理的操作成本，保持Docker环境的高效运行和整洁。

核心功能和特性

核心功能

• LRU策略清理：基于最近最少使用（LRU）算法，优先保留最近使用的Docker镜像，删除长期未使用的镜像。
• 自动运行：支持后台持续运行，定期检查并清理镜像，无需手动触发。
• 灵活配置：可自定义保留镜像的规则（如最大磁盘空间占用、排除特定镜像等）。
• 轻量高效：资源占用低，清理过程对Docker服务运行影响小。

主要特性

• 智能识别：自动识别Docker镜像的使用状态，区分活跃镜像与未使用镜像。
• 安全清理：仅删除未被容器引用的镜像，避免误删正在使用的镜像。
• 跨平台支持：可在Linux、macOS等支持Docker的系统上运行。
• 低侵入：通过Docker API与Docker守护进程交互，无需修改Docker核心配置。

使用场景和适用范围

适用场景

• 开发环境：开发过程中频繁构建、测试镜像，导致大量临时镜像占用磁盘空间。
• CI/CD环境：自动化构建流程（如Jenkins、GitHub Actions）持续生成镜像，需定期清理避免磁盘溢出。
• 服务器环境：长期运行Docker的服务器，需自动管理镜像生命周期，减少人工维护成本。
• 资源受限环境：磁盘空间有限的设备（如边缘计算节点、小型服务器），需高效利用存储空间。

适用人群

• Docker用户（开发者、运维人员）
• 自动化部署流程维护者
• 需要管理大量Docker镜像的团队或个人

详细使用方法和配置说明

安装与部署

Docker容器部署（推荐）

通过Docker容器运行Docuum，需挂载Docker守护进程套接字以访问Docker API：

bash
docker run -d \
  --name docuum \
  --restart unless-stopped \
  -v /var/run/docker.sock:/var/run/docker.sock \
  stepchowfun/docuum

二进制安装（可选）

从https://github.com/stepchowfun/docuum/releases%E4%B8%8B%E8%BD%BD%E5%AF%B9%E5%BA%94%E5%B9%B3%E5%8F%B0%E7%9A%84%E4%BA%8C%E8%BF%9B%E5%88%B6%E6%96%87%E4%BB%B6%EF%BC%8C%E7%9B%B4%E6%8E%A5%E8%BF%90%E8%A1%8C%EF%BC%9A

bash
# 下载并安装（以Linux为例）
curl -L https://github.com/stepchowfun/docuum/releases/latest/download/docuum-x86_64-unknown-linux-musl > docuum
chmod +x docuum
sudo mv docuum /usr/local/bin/

# 运行
docuum

配置参数

Docuum通过环境变量或命令行参数进行配置，优先级：命令行参数 > 环境变量 > 默认值。

核心配置参数

示例配置

示例1：限制最大镜像空间为20GB，每30分钟检查一次

bash
docker run -d \
  --name docuum \
  --restart unless-stopped \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -e DOCUUM_MAX_SIZE=20GB \
  -e DOCUUM_INTERVAL=30m \
  stepchowfun/docuum

示例2：排除特定镜像（如nginx:latest和my-app:*）

bash
docker run -d \
  --name docuum \
  --restart unless-stopped \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -e DOCUUM_EXCLUDE="nginx:latest" \
  -e DOCUUM_EXCLUDE="my-app:.*" \
  stepchowfun/docuum

示例3：模拟清理（测试配置是否生效）

bash
docker run --rm \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -e DOCUUM_DRY_RUN=true \
  stepchowfun/docuum

注意事项

• 权限：需确保Docuum容器有权限访问/var/run/docker.sock（Docker守护进程套接字）。
• 数据安全：默认不删除被容器引用的镜像，但若需保留特定未使用镜像，需通过--exclude显式配置。
• 版本兼容性：建议使用最新版本，以支持Docker API的最新特性。

总结

Docuum通过自动化的LRU策略清理Docker镜像，有效解决磁盘空间占用问题，降低Docker环境维护成本。其轻量、灵活的特性使其适用于开发、CI/CD及服务器等多种场景，是Docker用户管理镜像生命周期的实用工具。