部署
Cloudflare 设置
1. 创建 KV 命名空间
bunx wrangler kv namespace create KV这会输出一个命名空间 ID。更新 wrangler.jsonc,填入 ID:
{
"kv_namespaces": [
{
"binding": "KV",
"id": "your-namespace-id",
},
],
}2. 设置密钥
bunx wrangler secret put GITHUB_WEBHOOK_SECRET
bunx wrangler secret put GITHUB_CLIENT_ID
bunx wrangler secret put GITHUB_CLIENT_SECRET
bunx wrangler secret put DISCORD_TOKEN
bunx wrangler secret put DISCORD_PUBLIC_KEY # Discord 应用的公钥(开发者门户获取),交互功能必需
bunx wrangler secret put TELEGRAM_TOKEN # Telegram Bot Token(BotFather 获取)—— Telegram 路由必需
bunx wrangler secret put ADMIN_USER_IDS # 逗号分隔的 GitHub ID/登录名,允许进入 Web UI目标频道按路由配置
不存在全局频道密钥。每条路由在 Web 控制台 中声明各自的目标频道(及可选的子区/thread),因此不需要 DISCORD_CHANNEL_ID。
GitHub App ID / 私钥为可选
GITHUB_APP_ID + GITHUB_PRIVATE_KEY(PKCS#8 PEM)仅用于 App 安装流程,在安装后选择页解析安装所属账号的登录名。可以跳过不设——页面会显示匿名 inst-{installationId} 分组。OAuth 流程只需要 GITHUB_CLIENT_ID / GITHUB_CLIENT_SECRET。
Discord 交互通过 HTTPS Interactions Endpoint 送达,需要设置 DISCORD_PUBLIC_KEY 并把 Interactions Endpoint URL 指向 https://your-domain/discord/interactions。参见下方 Interactions Endpoint。
3. 创建 D1 数据库并执行迁移
bunx wrangler d1 create webhooker将返回的数据库 ID 填入 wrangler.jsonc:
{
"d1_databases": [
{
"binding": "DB",
"database_name": "webhooker",
"database_id": "your-database-id",
},
],
}然后执行迁移:
bun run db:migrate:prod # 将迁移应用到远端 D1 数据库
bun run db:migrate # 将迁移应用到本地(Miniflare)数据库db:migrate 脚本执行 wrangler d1 migrations apply webhooker(见 package.json),逐一应用 migrations/ 下的 SQL 文件,并在 d1_migrations 表中记录已应用的版本。
曾用 d1 execute 迁移过的数据库
如果数据库已有这些表/列(例如之前用 wrangler d1 execute --file 迁移过),可能缺少 d1_migrations 追踪表,db:migrate:prod 会尝试重新执行所有迁移;0002_log_detail.sql 中的 ALTER TABLE ... ADD COLUMN 语句会因列已存在而失败。此时请直接执行文件:
bunx wrangler d1 execute webhooker --remote --file ./migrations/0001_init.sql
bunx wrangler d1 execute webhooker --remote --file ./migrations/0002_log_detail.sql
bunx wrangler d1 execute webhooker --remote --file ./migrations/0003_telegram_links.sql
bunx wrangler d1 execute webhooker --remote --file ./migrations/0004_add_group_id.sql
bunx wrangler d1 execute webhooker --remote --file ./migrations/0005_audit_logs.sql4. 创建队列(可选)
QUEUE 绑定会通过 Cloudflare Queues 投递 webhook(异步分发,带重试退避与死信队列)。跳过此步则保持同步内联分发。
bunx wrangler queues create webhooker-delivery
bunx wrangler queues create webhooker-delivery-dlq队列已在 wrangler.jsonc 中声明(queues.producers / queues.consumers),无需修改绑定。webhooker-delivery 消费者对可重试失败做指数退避重试(5s/30s/2m/10m),达到 max_retries 后消息进入 webhooker-delivery-dlq 并标记为 dead。
5. 部署
bunx wrangler deployWorker 现在可通过 https://webhooker.<your-subdomain>.workers.dev 访问。
6. 配置 GitHub Webhook
- 进入 GitHub App 设置页面
- 设置 Webhook URL 为
https://webhooker.<your-subdomain>.workers.dev/webhook - 设置 Webhook secret 与
GITHUB_WEBHOOK_SECRET一致
7.(可选)配置 Gitea Webhook
- 在 Gitea 仓库中进入 设置 → Web 钩子 → 添加 Web 钩子 → Gitea
- 设置 目标 URL 为
https://webhooker.<your-subdomain>.workers.dev/webhook - 设置 HTTP 方法 为
POST、Content Type 为application/json - 设置 密钥 与
GITEA_WEBHOOK_SECRET一致 - 选择要触发的事件(push、议题、拉取请求、发布等)
GitHub App 设置
1. 创建 App
- 打开 https://github.com/settings/apps/new
- 填写:
- GitHub App name:
WebHooker(或自定义名称) - Homepage URL: 你的域名
- Webhook URL:
https://your-domain/webhook - Webhook secret: 生成并复制到
GITHUB_WEBHOOK_SECRET
- GitHub App name:
- 设置权限:
- Repository permissions: Contents (read)、Issues (write)、Pull requests (write)、Metadata (read)、Checks (read)、Deployments (read)、Discussions (read)、Code scanning alerts (read)、Dependabot alerts (read)
- Organization permissions: Members (read) —— 如果需要
- 订阅事件(全部 28 种支持的事件):
- Push、Pull request、Issues、Issue comment、Workflow run、Workflow job、Status、Deployment、Deployment status、Ping、Release、Create、Delete、Star、Fork、Check run、Check suite、Pull request review、Pull request review comment、Commit comment、Member、Label、Milestone、Discussion、Discussion comment、Repository、Code scanning alert、Dependabot alert
- 生成私钥 — 可选;设置
GITHUB_APP_ID+GITHUB_PRIVATE_KEY后,安装后页面会显示安装所属账号的登录名(见上方提示)。
2. 安装 App
- 创建后,进入 App 设置页面
- 点击 "Install App" → 选择组织/用户
- 选择要监控的仓库
3. 配置 OAuth
- 进入 App → OAuth 设置
- 设置 Callback URL:
https://your-domain/auth/github/callback - 将 Client ID 和 Client Secret 复制到环境变量
Discord Bot 设置
创建新应用 → 进入 Bot 部分
将 Bot Token 复制到
DISCORD_TOKEN使用
bot与applications.commands两个 scope 邀请 Bot,并勾选View Channels+Send Messages+Send Messages in Threads权限(组合整数274877910016):texthttps://discord.com/oauth2/authorize?client_id=YOUR_BOT_CLIENT_ID&permissions=274877910016&scope=bot+applications.commands在 Web UI(
/admin)中按路由配置目标频道——无需全局频道 ID。
Interactions Endpoint
消息通过 Discord REST API 发送,因此仅凭 DISCORD_TOKEN 即可推送。交互(斜杠命令、按钮、modal)则通过 HTTPS Interactions Endpoint 送达:
- 在 Discord 开发者门户 → General Information 复制应用的 Public Key,填入
DISCORD_PUBLIC_KEY。 - 将 Interactions Endpoint URL 设为
https://your-domain/discord/interactions。 - 所有交互请求都使用 Ed25519 签名验证(
X-Signature-Ed25519覆盖X-Signature-Timestamp + body)。
/gh 斜杠命令与 GitHub: 添加/编辑/删除评论 消息命令由定时任务(每 5 分钟)同步注册:按服务器即时可用,同时全局注册(24h 去重,约 1 小时传播)。Bot 从不连接 Discord Gateway,因此显示为离线——消息推送不受影响(始终走 REST)。
用户运行 /gh login 绑定自己的 GitHub 账号,即可以本人身份评论 issue/PR。完整命令说明见机器人命令。
Telegram 机器人配置
- 用 @BotFather 创建机器人,将 Token 复制到
TELEGRAM_TOKEN。 - (可选)设置
TELEGRAM_WEBHOOK_SECRET;webhook 注册时会作为secret_token传给 Telegram,POST /telegram/webhook使用时间安全比较校验。 - Worker 会在定时任务中自动同步 webhook(
setWebhook指向{BASE_URL}/telegram/webhook),因此无需手动调用setWebhook——只需确保BASE_URL已设置。 - 将机器人加入群组(或启用话题),在路由配置中用
chatId/topicId指定目标。
在 Telegram 中,/gh 命令(/gh login、/gh logout、/gh comment <内容>、/gh merge、/gh close)通过在通知消息上回复来使用——见机器人命令。
头像使用内置 GET /api/richheader 渲染为链接预览卡片(可用 TELEGRAM_RICH_HEADER_HOST 覆盖)。
自定义域名(可选)
要使用自定义域名替代 *.workers.dev:
- 进入 Cloudflare Worker 设置
- 添加自定义域名或路由
- 更新
BASE_URL以匹配
NOTE
本项目是一个 Cloudflare Worker,依赖 wrangler.jsonc 中声明的 KV 与 D1 绑定,无法作为独立的 Node/容器进程运行。Queues 绑定(QUEUE)可选——未绑定时 webhook 分发保持内联同步。