virtualzone/compose-updater

Compose Updater

https://img.shields.io/github/actions/workflow/status/virtualzone/compose-updater/build.yml?branch=master](https://github.com/virtualzone/compose-updater/actions) https://img.shields.io/github/v/release/virtualzone/compose-updater](https://github.com/virtualzone/compose-updater/releases) https://img.shields.io/github/release-date/virtualzone/compose-updater](https://github.com/virtualzone/compose-updater/releases) https://img.shields.io/docker/image-size/virtualzone/compose-updater](https://hub.docker.com/r/virtualzone/compose-updater) https://img.shields.io/github/license/virtualzone/compose-updater](https://github.com/virtualzone/compose-updater/blob/master/LICENSE)

镜像概述和主要用途

Compose Updater是一个持续监控运行中Docker容器的应用程序。当镜像更新时，会从仓库拉取（或通过--pull构建）更新后的版本，并重启Docker Compose服务组合（通过down和up -d命令）。

该工具适用于使用定期更新标签的场景（如image:latest或特定主版本image:v3）。不适用于使用不变标签的情况（如固定SemVer版本image:1.2.3），也不会更新Docker Compose文件以使用新版本标签。

核心功能和特性

• 持续监控容器镜像更新状态
• 自动拉取更新后的镜像
• 自动重启受影响的Docker Compose服务组合
• 支持通过标签指定需要监控的服务
• 可配置检查间隔、清理策略等参数
• 支持MQTT broker集成，发布更新和重启事件

使用场景和适用范围

• 需要自动保持容器镜像为最新版本的环境
• 使用动态更新标签（如latest、v1）管理容器的场景
• 希望减少手动检查和更新容器操作的运维流程
• 需通过消息通知跟踪容器更新状态的环境

使用方法和配置说明

1. 准备服务

需为要监控的服务添加两个标签：

yaml
version: '3'
services:
  web:
    image: nginx:alpine
    labels:
      - "docker-compose-watcher.watch=1"  # 标记服务需要被监控
      - "docker-compose-watcher.dir=/home/docker/dir"  # 指定docker-compose.yml所在目录

• docker-compose-watcher.watch=1：将服务暴露给Compose Updater监控
• docker-compose-watcher.dir：指定docker-compose.yml所在目录；若文件不是默认名称，可使用docker-compose-watcher.file标签指定完整路径和文件名（因无法从运行中容器定位docker-compose.yml文件，此配置必要）

2. 运行Compose Updater

使用Docker Compose运行：

yaml
version: '3'
services:
  watcher:
    image: virtualzone/compose-updater
    restart: always
    volumes:
      - "/var/run/docker.sock:/var/run/docker.sock:ro"  # 挂载Docker套接字
      - "/home/docker:/home/docker:ro"  # 挂载compose文件所在目录（只读）
    environment:
      INTERVAL: 60  # 检查间隔（分钟）

注意：

• 必须挂载/var/run/docker.sock和compose文件所在目录
• 单个Compose Updater实例可监控所有compose服务（无需每个docker-compose.yml配置一个实例）

registry认证配置

若拉取镜像的仓库需要认证，可挂载主机的~/.docker/config.json到容器内：

yaml
volumes:
  # 挂载主机的Docker配置（包含认证信息），假设主机用户为ubuntu
  - "/home/ubuntu/.docker/config.json:/root/.docker/config.json:ro"

配置参数

可通过环境变量（推荐）或命令行参数配置：

MQTT Broker集成

可将Compose Updater连接到MQTT Broker（如Eclipse Mosquitto或HiveMQ），以发布更新和重启事件。这些信息可用于通过mqttwarn或Home Assistant发送推送通知。

发布的主题

推送通知示例（Home Assistant）

以下Home Assistant配置在Docker组合更新并重启后通过***发送消息：

yaml
automation:
  - alias: "Docker Compose更新通知"
    trigger:
      - platform: mqtt
        topic: "composeupdater/update/composition/restart/done"
        value_template: "{{ value_json.composeFile }}"
    action:
      - service: notify.telegram_bot
        data:
          message: "Docker镜像已更新: {{ trigger.payload_json.composeFile }}"

许可证

GNU General Public License v3.0

Docker®是Docker, Inc.的商标。本项目不隶属于Docker, Inc.