`webhook` 容器 ⚓

![Image Size]([] ![Last Commit]([] ![Build Status]([] ![Become a GitHub Sponsor]([]

轻量级、最小化的 webhook 容器。

镜像概述和主要用途

本镜像是一个轻量级、最小化的 webhook 容器，基于 adnanh/webhook 项目构建。主要用途是运行 webhook 服务，接收 HTTP 请求并触发预定义的钩子（hooks），执行相应的命令或脚本，适用于自动化流程、事件响应等场景。

核心功能和特性

轻量级设计：镜像体积小，资源占用低
配置灵活：支持通过 YAML/JSON 文件定义钩子
热重载：支持钩子配置文件热重载（-hotreload 参数），无需重启服务
详细日志：支持 verbose 模式，输出详细运行日志
多平台支持：可从 GitHub 容器注册表（GHCR）和 Docker Hub 获取镜像
时区配置：支持通过环境变量设置系统时区

使用场景和适用范围

适用于需要通过 HTTP 请求触发命令执行的场景，例如：

代码仓库推送事件后的自动部署
监控系统告警触发的故障恢复脚本
定时任务或外部事件触发的系统维护操作
跨服务的事件通知与响应处理

详细使用方法和配置说明

镜像来源

Docker 镜像可从以下两个仓库获取：

GitHub 容器注册表（GHCR）
Docker Hub

若使用 GHCR，将示例中的 thecatlady/webhook 替换为 ghcr.io/thecatlady/webhook 即可。

Docker Compose（推荐）

在 docker-compose.yml 文件中添加以下服务定义：

yaml
services:
  webhook:
    image: thecatlady/webhook
    container_name: webhook
    command: -verbose -hooks=hooks.yml -hotreload
    environment:
      - TZ=America/New_York # 可选
    volumes:
      - /path/to/appdata/config:/config:ro  # 本地配置目录挂载为只读
    ports:
      - 9000:9000  # 映射 webhook 服务端口
    restart: always

从包含 docker-compose.yml 文件的目录运行以下命令启动服务：

bash
docker-compose up -d

Docker CLI

直接执行以下命令创建并启动容器：

bash
docker run -d \
  --name=webhook \
  -e TZ=America/New_York `# 可选` \
  -v /path/to/appdata/config:/config:ro \
  -p 9000:9000 \
  --restart always \
  thecatlady/webhook \
  -verbose -hooks=hooks.yml -hotreload

更新方法

当镜像有新版本时，根据部署方式选择以下更新步骤。

Docker Compose

在包含 docker-compose.yml 文件的目录运行：

bash
docker-compose pull webhook  # 拉取最新镜像
docker-compose up -d         # 重启服务
docker image prune           # 清理旧镜像（可选）

Docker CLI

执行以下命令，然后重新运行原始 docker run 命令：

bash
docker stop webhook          # 停止当前容器
docker rm webhook            # 删除当前容器
docker pull thecatlady/webhook  # 拉取最新镜像
docker image prune           # 清理旧镜像（可选）

参数说明

容器通过运行时参数配置，以下是主要参数说明：

参数	功能描述
`-e TZ=<时区>`	设置系统时区，值为时区数据库名称（如 `Asia/Shanghai`），参考时区数据库列表（可选）
`-v /path/to/appdata/config:/config:ro`	挂载本地配置目录到容器内 `/config`（只读），钩子配置文件（YAML/JSON）需放在此目录下；将 `/path/to/appdata/config` 替换为本地实际路径
`-p 9000:9000`	端口映射，容器内 webhook 服务默认监听 9000 端口，映射到主机的 9000 端口（除非仅通过同一 Docker 网络内的其他容器访问，否则必须配置）
`--restart <策略>`	容器重启策略，推荐设置为 `always`（总是重启）或 `unless-stopped`（除非手动停止）
`command` 中的参数	webhook 服务参数，参考 Webhook 参数文档： `-verbose`：输出详细日志 `-hooks=hooks.yml`：指定钩子配置文件名 `-hotreload`：启用配置文件热重载（若修改配置，需完整指定所有参数）