maccyber/micro-dockerhub-hook

micro-dockerhub-hook

镜像概述和主要用途

micro-dockerhub-hook是一个通过Webhook实现Docker自动部署的工具。它监听来自hub.docker.com的HTTP POST请求，并触发用户指定的脚本，从而实现Docker镜像的自动更新和部署。

核心功能和特性

• 轻量级：资源占用低，部署简单
• 配置过程简单：易于设置和使用
• 支持容器化运行：可在Docker容器中运行
• 多镜像更新支持：能够同时处理多个Docker镜像的更新
• 脚本灵活性：支持通过脚本触发docker或docker-compose命令
• 生产环境验证：已在生产环境中使用
• 完善的日志：提供详细的日志记录，便于问题排查

使用场景和适用范围

适用于需要通过Docker Hub自动部署应用的场景，特别适合开发者和运维人员在生产或测试环境中使用。当Docker Hub上的镜像更新时，可自动触发部署脚本，实现应用的无缝更新，减少手动操作，提高部署效率。

详细使用方法和配置说明

创建令牌

使用openssl、uuidgen或其他工具创建一个秘密令牌。不要使用任何斜杠，因为令牌将用于URL中。

sh
export TOKEN=$(uuidgen)
echo $TOKEN

安装方式

1. 在主机上运行

安装依赖

需先安装Node.js和npm。

sh
git clone http://github.com/maccyber/micro-dockerhub-hook
cd micro-dockerhub-hook
npm i

编辑配置

查看config.js文件并进行编辑：

sh
vim config.js

配置仓库和脚本

查看scripts/index.js文件并进行编辑：

sh
vim scripts/index.js

使用以下格式配置： 'repo/image[:tag]': 'script.sh [parameter1 parameter2]',

其中，tag和参数为可选。

记得为脚本添加执行权限：chmod +x script.sh

启动服务

sh
npm start

2. 使用docker-compose运行

克隆仓库：

sh
git clone http://github.com/maccyber/micro-dockerhub-hook

在docker.env文件中添加秘密令牌：

sh
vim docker.env

启动服务：

sh
docker-compose up -d

3. 从Docker Hub运行

克隆仓库：

sh
git clone http://github.com/maccyber/micro-dockerhub-hook

启动容器：

sh
docker run -d \
  -p 3000:3000 \
  -e TOKEN=${TOKEN} \
  -v ${PWD}/scripts:/src/scripts \
  -v /var/run/docker.sock:/var/run/docker.sock \
  --name micro-dockerhub-hook \
  maccyber/micro-dockerhub-hook

Docker Hub上的配置

访问 https://hub.docker.com/ -> 你的仓库 -> Webhooks

添加如下格式的Webhook（参考下图）：

!alt tag

将example.com替换为你的服务器域名或IP地址，将abc123替换为你的秘密令牌。

默认情况下，micro-dockerhub-hook监听3000端口。

本地机器测试

设置开发环境：

sh
git clone https://github.com/maccyber/micro-dockerhub-hook/
cd micro-dockerhub-hook
npm i
npm run dev

使用curl命令进行测试：

sh
curl -i -d @test/data/payload.json http://localhost:3000/$TOKEN