tarampampam/webhook-tester Docker 镜像 - 轩辕镜像 | Docker 镜像高效稳定拉取服务

WebHook Tester

该应用允许您使用唯一的随机生成URL测试和调试webhook及HTTP请求。您可以自定义响应码、Content-Type HTTP头、响应内容，甚至设置响应延迟。

它是webhook.site、requestinspector.com等服务的免费自托管替代方案。

!screencast

[!TIP] 演示版本可在wh.tarampamp.am访问。请注意，该演示功能有限，不持久化数据，且可能偶尔不可用，但您可以免费试用。

该应用使用Go构建以实现高性能，包含轻量级UI（基于ReactJS），已编译到二进制文件中，无需额外资源。WebSocket支持提供UI中的实时webhook通知，无需pusher.com等第三方服务！

核心功能与特性

• 独立运行，使用内存存储/发布订阅系统，无需第三方依赖
• 完全自定义webhook的响应码、头和正文
• 支持将本地运行实例暴露到公网（通过隧道功能）
• 基于ReactJS的内置快速UI
• 基于scratch的多架构Docker镜像
• Docker中以非特权用户运行
• 充分测试且文档完善的源代码
• 包含CLI健康检查子命令
• UI中支持请求的二进制视图
• 支持JSON和人类可读的日志格式
• 健康检查端点（/healthz）
• 可自定义webhook响应
• 内置WebSocket支持
• 内存和CPU使用高效
• 免费、开源且可扩展

存储

应用支持3种存储驱动：memory（内存）、Redis和fs（文件系统），通过--storage-driver标志配置。

• 内存驱动：适用于本地调试，无需持久化存储，应用关闭后记录的请求将被清除
• Redis驱动：跨应用重启保留数据，适用于需要数据持久化的环境，也用于负载均衡后的多实例部署
• 文件系统驱动：将所有数据存储在本地文件系统，适用于需要在应用重启间保留数据的场景

发布/订阅

WebSocket通知的发布/订阅系统支持两种驱动：memory（内存）和Redis，通过--pubsub-driver标志配置。

运行多个应用实例时，需使用Redis驱动。

隧道功能

使用***隧道驱动捕获来自公网的webhook请求。通过设置--tunnel-driver=***标志并提供***认证令牌（--***-auth-token）启用。启用后，应用会自动创建隧道，无需手动安装或运行***（即使在Docker中）。

通过此公网URL，您可以测试来自GitHub、GitLab、Bitbucket等外部服务的webhook，不会错过任何请求！

常见问题

是否可以使用预定义（静态）webhook URL（会话），确保即使没有数据持久化也能捕获发送的请求？

可以，只需使用--auto-create-sessions标志或设置环境变量AUTO_CREATE_SESSIONS=true。在v1版本中，需在应用启动时定义会话以启用此功能；但从v2开始，只需启用此功能即可。其工作原理很简单：如果传入请求包含UUID格式的前缀（例如[***]），将自动为此请求创建会话。您只需在UI中打开该会话（[***]）即可。

安装

Docker镜像

[!NOTE] 建议避免使用latest标签，因为主要版本升级可能包含破坏性变更。应使用X.Y.Z格式的特定标签以确保版本一致性。

二进制文件

从发布页面下载适用于您架构的最新二进制文件。例如，在amd64系统（如Debian、Ubuntu）上安装：

shell
curl -SsL -o ./webhook-tester [***]
chmod +x ./webhook-tester
./webhook-tester start

[!TIP] 每个发布版本包含适用于Linux、Darwin（macOS）和Windows的二进制文件（支持amd64和arm64架构）。您可以从发布页面的"Assets"部分下载适合您系统的二进制文件。只需下载并运行单个二进制文件即可。

Kubernetes

通过ArtifactHUB的Helm chart安装。

使用方法

Docker快速启动

最简单的运行方式是使用Docker镜像：

shell
docker run --rm -t -p "8080:8080/tcp" ghcr.io/tarampampam/webhook-tester:2

[!NOTE] 此命令使用默认配置在8080端口启动应用（-p参数中的第一个端口是主机端口，第二个是容器内的应用端口）。

然后，在浏览器中打开localhost:8080开始测试webhook。要停止应用，在运行它的终端中按Ctrl+C。

自定义配置

如需自定义配置，可参考以下CLI帮助或执行应用的--help标志。

CLI接口

webhook测试工具。

用法：

bash
$ app [全局标志] [命令] [命令标志] [参数...]

全局标志

start命令（别名：s、server、serve、http-server）

启动HTTP/HTTPs服务器。

用法：

bash
$ app [全局标志] start [命令标志] [参数...]

支持的标志：

start healthcheck子命令（别名：hc、health、check）

HTTP(S)服务器的健康检查器。用途：Docker健康检查。

用法：

bash
$ app [全局标志] start healthcheck [命令标志] [参数...]

支持的标志：

许可证

这是开源软件，根据MIT许可证授权。