crazymax/diun

DIUN (Docker Image Update Notifier) 镜像文档

概述

DIUN（Docker Image Update Notifier）是一款轻量级工具，旨在监控Docker镜像（包括Docker Hub、私有仓库、OCI镜像等）的更新状态。当目标镜像有新版本发布时，DIUN会通过配置的通知渠道（如邮件、Slack、***等）发送提醒，帮助用户及时掌握镜像变更，适用于个人开发、企业运维等场景。

核心功能与特性

• 多源镜像支持：兼容Docker Hub、私有Docker仓库、OCI镜像仓库（如GitHub Container Registry、GitLab Container Registry）等多种镜像源。
• 灵活的监控规则：支持按镜像名称、标签、架构等条件过滤监控对象，可自定义检查频率（如每小时、每天）。
• 丰富的通知渠道：支持邮件（SMTP）、Slack、、、Webhook等多种通知方式，满足不同场景的消息触达需求。
• 轻量高效：基于Go语言开发，镜像体积小（约10MB），资源占用低，支持容器化部署。
• 配置灵活：支持通过环境变量、配置文件（YAML/JSON）或Docker标签注入配置，适配不同使用习惯。

核心功能

• 镜像更新检测：支持基于镜像摘要、标签、语义化版本（SemVer）等维度检测更新。
• 多平台架构支持：可针对特定架构（如amd64、arm64）的镜像进行监控。
• 标签过滤：支持通过正则表达式或通配符过滤需要监控的镜像标签（如仅监控latest或v*标签）。
• 历史记录追踪：记录已通知的镜像版本，避免重复通知。
• 可扩展的通知系统：支持自定义通知模板，适配不同渠道的消息格式。

使用场景

• 个人开发者：监控项目依赖的基础镜像（如node:18-alpine、nginx:alpine），及时了解更新以同步开发环境。
• 企业运维：监控生产环境中使用的Docker镜像，确保安全补丁或功能更新能被及时发现并评估是否需要升级。
• CI/CD流程辅助：作为自动化流程的前置环节，当基础镜像更新时触发构建或测试流程。

使用方法

1. 快速启动（Docker Run）

bash
docker run -d \
  --name diun \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v $(pwd)/diun.yml:/diun.yml:ro \
  -e TZ=Asia/Shanghai \
  crazy-max/diun:latest

2. Docker Compose 配置

yaml
version: "3.8"

services:
  diun:
    image: crazy-max/diun:latest
    container_name: diun
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - ./diun.yml:/diun.yml:ro
      - ./data:/data  # 存储历史记录
    environment:
      - TZ=Asia/Shanghai
      - DIUN_LOG_LEVEL=info  # 日志级别：debug/info/warn/error
      - DIUN_WATCH_WORKERS=2  # 并发检查工作线程数
    restart: unless-stopped

3. 配置文件（diun.yml）

DIUN的核心配置通过diun.yml文件定义，支持监控规则、通知渠道等详细设置。以下是基础配置示例：

yaml
# 全局配置
watch:
  workers: 2  # 并发检查工作线程数（默认：1）
  schedule: "0 */6 * * *"  # 检查频率（Cron表达式，默认：每天一次）
  firstCheckNotif: false  # 首次检查是否发送通知（默认：false）

# 监控规则
watchers:
  - name: "my-project"
    images:
      - "docker.io/library/nginx:alpine"  # Docker Hub镜像
      - "ghcr.io/crazy-max/diun:latest"   # GitHub Container Registry镜像
      - "my-private-registry.com/app:v*"  # 私有仓库镜像（支持标签通配符）
    platforms:
      - "linux/amd64"
      - "linux/arm64"  # 仅监控指定架构的镜像
    tags:
      - pattern: "latest"  # 监控标签规则
      - pattern: "v[0-9]+.[0-9]+.[0-9]+"  # 语义化版本标签（正则表达式）
        strict: true  # 严格匹配模式

# 通知配置
notif:
  slack:
    webhookURL: "https://hooks.slack.com/services/XXX/XXX/XXX"  # Slack Webhook地址
    channel: "#docker-updates"  # 目标频道
    templateTitle: "🔄 {{ .Image }} has been updated"  # 自定义标题模板
  email:
    smtpHost: "smtp.gmail.com"
    smtpPort: 587
    smtpUsername: "user@gmail.com"
    smtpPassword: "app-password"
    from: "DIUN <diun@example.com>"
    to: ["admin@example.com"]

4. 环境变量配置

除配置文件外，部分核心参数可通过环境变量设置（优先级低于配置文件）：

5. 通知渠道详情

DIUN支持多种通知渠道，以下为常用渠道的配置要求：

Slack

• 需配置webhookURL（通过Slack应用创建Incoming Webhook获取）。
• 可选配置channel（目标频道）、username（发送消息的用户名）、templateTitle/templateBody（自定义模板）。

***

• 需配置token（*** Bot Token）和chatIDs（目标聊天ID列表）。
• 通过/getid机器人获取聊天ID。

邮件（SMTP）

• 需配置SMTP服务器地址（smtpHost）、端口（smtpPort）、认证信息（smtpUsername/smtpPassword）。
• 支持TLS/SSL加密（通过smtpSSL/smtpTLS控制）。

注意事项

• 镜像权限：若监控私有仓库镜像，需确保DIUN容器有权访问仓库（可通过挂载Docker配置文件~/.docker/config.json实现：-v ~/.docker/config.json:/root/.docker/config.json:ro）。
• Cron表达式：检查频率需符合Cron语法（如*/30 * * * *表示每30分钟检查一次）。
• 历史记录：数据目录（/data）需持久化存储，避免容器重启后丢失已通知记录。

参考链接

• 官方GitHub仓库：https://github.com/crazy-max/diun
• 完整配置文档：https://crazy-max.github.io/diun/configuration/
• 通知模板语法：https://crazy-max.github.io/diun/notification-templates/