almir/webhook 镜像文档

1. 镜像概述

almir/webhook 是 webhook 工具的 Docker 化版本。webhook 是一个轻量级 HTTP 回调服务器，可接收 HTTP 请求并触发预定义的命令或脚本。本镜像提供了 webhook 的容器化部署方案，简化了工具的安装、配置与运行流程。

2. 核心功能与特性

2.1 核心功能

• 接收 HTTP 请求并根据预定义规则触发命令执行
• 支持通过 JSON 配置文件定义钩子（hooks）及关联命令
• 提供详细日志输出，便于调试与监控

2.2 镜像特性

• 支持挂载宿主机钩子配置文件，实现配置动态更新
• 内置热重载（hotreload）机制，配置文件变更后自动生效
• 支持通过 Dockerfile 自定义镜像，集成特定钩子配置
• 灵活指定启动参数，适配不同运行场景

3. 使用场景与适用范围

3.1 典型使用场景

• CI/CD 自动化：接收代码仓库（如 GitHub、GitLab）的推送事件，触发构建或测试流程
• 自动化部署：接收部署请求 HTTP 回调，执行部署脚本（如更新应用、重启服务）
• 系统集成：作为第三方服务与内部系统的中间层，处理外部 HTTP 事件并触发内部操作
• 监控告警响应：接收监控系统告警 HTTP 请求，自动执行故障恢复命令

3.2 适用范围

适用于开发、测试及生产环境中需要轻量级 HTTP 回调处理的场景，尤其适合资源受限或需快速部署的环境。

4. 使用方法与配置说明

4.1 直接运行容器

通过挂载宿主机钩子配置文件目录，直接启动容器：

shell
docker run -d \
  -p 9000:9000 \
  -v /宿主机钩子文件目录:/etc/webhook \
  --name=webhook \
  almir/webhook \
  -verbose -hooks=/etc/webhook/hooks.json -hotreload

参数说明：

• -p 9000:9000：映射容器端口 9000（webhook 默认端口）到宿主机
• -v /宿主机钩子文件目录:/etc/webhook：挂载宿主机钩子配置文件目录到容器内 /etc/webhook
• --name=webhook：指定容器名称
• 启动参数：-verbose（输出详细日志）、-hooks=/etc/webhook/hooks.json（指定钩子配置文件路径）、-hotreload（启用配置热重载）

4.2 通过 Dockerfile 构建自定义镜像

若需将钩子配置文件内置到镜像中，可通过 Dockerfile 构建自定义镜像：

4.2.1 创建 Dockerfile

dockerfile
FROM almir/webhook
COPY hooks.json /etc/webhook/hooks.json  # 将宿主机 hooks.json 复制到容器内指定路径

4.2.2 构建与运行

将 Dockerfile 与 hooks.json 置于同一目录，执行以下命令：

shell
# 构建镜像
docker build -t my-webhook-image .

# 启动容器
docker run -d \
  -p 9000:9000 \
  --name=webhook \
  my-webhook-image \
  -verbose -hooks=/etc/webhook/hooks.json -hotreload

4.3 在 Dockerfile 中指定启动参数

通过 CMD 指令在 Dockerfile 中预定义启动参数，简化容器启动命令：

4.3.1 创建 Dockerfile

dockerfile
FROM almir/webhook
COPY hooks.json /etc/webhook/hooks.json
CMD ["-verbose", "-hooks=/etc/webhook/hooks.json", "-hotreload"]  # 预定义启动参数

4.3.2 构建与运行

shell
# 构建镜像
docker build -t my-webhook-image .

# 启动容器（无需额外指定参数）
docker run -d -p 9000:9000 --name=webhook my-webhook-image

5. 配置参数说明

webhook 启动参数可通过容器启动命令或 Dockerfile 的 CMD 指定，常用参数如下：

6. 部署示例

6.1 docker-compose 配置

创建 docker-compose.yml 文件，定义服务配置：

yaml
version: '3'
services:
  webhook:
    image: almir/webhook
    container_name: webhook
    ports:
      - "9000:9000"
    volumes:
      - ./hooks:/etc/webhook  # 挂载宿主机 ./hooks 目录到容器内 /etc/webhook
    command: ["-verbose", "-hooks=/etc/webhook/hooks.json", "-hotreload"]
    restart: unless-stopped  # 容器退出时自动重启（除非手动停止）

启动服务：

shell
docker-compose up -d