Skip to content

README.md

Latest commit

 

History

History
74 lines (52 loc) · 5.2 KB

README.md

File metadata and controls

74 lines (52 loc) · 5.2 KB

Webhook Config UI

在网页中快速生成可调用的 webhook 配置（YAML/JSON 片段）及调用 URL、curl 示例，便于复制到 ./hooks 目录（默认）或单文件配置中使用。

同一套 UI 也可在主程序中启用：使用 ./webhook -config-ui（默认目录模式）或 ./webhook -hooks hooks.json -config-ui（单文件模式）启动后，访问页面即可。详见 配置参数。

能力边界与适用场景

  • 适合谁：需要在本地或内网快速生成/调整 hook 配置的开发者或运维；希望用表单和「插入示例」减少手写 JSON/YAML 的情况。
  • 做什么：生成单条 hook 的 YAML/JSON 片段、调用 URL 与 curl 示例；在目录模式（默认 ./hooks 或显式 -hooks-dir）下可将生成结果保存到该目录。不提供配置版本管理、回滚、多用户或权限控制。
  • 不做啥：Config UI 是配置生成器，不是完整的配置托管或管控平台；不会替代 -hooks 指定的文件、不会自动重载或校验已有配置的语法。

运行方式

与主程序共用同一二进制，启用后会在主服务上挂载 Config UI（默认端口 9000）：

# 默认端口 9000
go run . -config-ui

# 指定端口
go run . -config-ui -port 9090

# 通过环境变量
CONFIG_UI_ENABLED=true go run .
PORT=9090 CONFIG_UI_ENABLED=true go run .

编译后使用同一二进制：

go build -o webhook .
./webhook -config-ui
./webhook -config-ui -port 9090

发布产物中的 webhook-config-ui 与 webhook 为同一程序，用法一致。运行 ./webhook -config-ui 或 ./webhook-config-ui -config-ui 即可，默认监听 9000。

使用说明

  1. 浏览器打开 http://localhost:9000/config-ui（或你指定的端口/路径）。
  2. 填写表单：
    • 必填：Hook ID、执行命令
    • 可选：工作目录、响应消息、Webhook 服务地址（如 http://localhost:9000，用于生成正确的调用 URL）、HTTP 方法、成功状态码、是否返回命令输出等
    • 可选（高级）：响应头、传递参数/环境变量、触发规则、请求 Content-Type（均为 JSON 格式；若填写则需为合法 JSON，否则生成接口会返回 400 及错误说明）
  3. 可点击「加载示例」快速填充一份示例（id、执行命令、Webhook 地址等），再点「生成」试跑。
  4. 点击「生成」后，页面会展示：
    • 调用 URL（如 http://localhost:9000/hooks/my-hook）
    • curl 示例
    • YAML 与 JSON 配置片段
  5. 可复制或下载 YAML/JSON 片段，粘贴到 webhook 的 hooks.yaml / hooks.json 中使用。可选区块（响应头、传递参数、触发规则等）默认折叠，点击「可选」展开；高级 JSON 字段旁有「插入示例」可填入最小合法示例。YAML/JSON 结果块可折叠以节省空间。成功生成后会记住 Hook ID 与 Webhook 服务地址（localStorage），下次打开页面时自动回填（若为空）。
  6. 下一步：将配置复制到 hooks 文件；目录模式（默认 ./hooks 或显式 -hooks-dir）下可在结果区直接保存到该目录；显式 -hooks 单文件模式下请复制/下载后手动保存。请确认 -urlprefix 与页面上方生成的调用 URL 前缀一致，避免调用地址与真实端点不符。

与 webhook 同机部署

与 webhook 主服务共用监听端口：

  • webhook 主服务（默认目录模式）：例如 ./webhook → :9000（hooks 端点 /hooks/:id）
  • webhook 主服务 + Config UI：例如 ./webhook -config-ui → :9000（UI 路径默认 /config-ui）
  • webhook 主服务（单文件兼容模式）：例如 ./webhook -hooks hooks.json -config-ui → :9000

可编写 docker-compose.yml 或 systemd 单元，分别启动两个进程；生成结果中的「调用 URL」需与 webhook 实际监听地址一致（可在生成后手动替换 host/port）。

技术说明

  • 本程序复用 internal/configui 包，静态资源与页面配置仅在该包内维护一份（internal/configui/config/、internal/configui/static/），通过包内 embed 打入二进制，单二进制即可运行。
  • 页面配置来自 internal/configui/config/page.yaml（i18n 与表单结构）。
  • 生成 API：POST {config-ui-path}/api/generate，请求体为表单对应 JSON，响应为 { "yaml", "json", "callUrl", "curlExample" }；错误时返回 { "error": "..." } 及 4xx 状态码。此外还有 GET {config-ui-path}/api/capabilities（返回是否支持保存到目录）与 POST {config-ui-path}/api/save（将配置写入 hooks 目录）。完整端点说明见 API 参考（Config UI 章节）。

故障排查

  • 页面空白：若仅见白屏，多为模板字段与结构体不一致（如模板用了 {{.Id}} 而结构体为 ID）。当前模板已使用 {{.ID}}，重新构建并运行即可。
  • 表单无法提交 / 复制无效：确认浏览器控制台无 JS 报错；检查 /static/js/app.js 是否正常加载（Network 面板）。
  • 生成接口 400：查看响应体中的 error 字段，多为「id / execute-command 未填」或「可选 JSON 格式错误」。