WebHooker/docs/zh/index.md at afe19795b1e9690d58f80f58033ebf8551efae81

mirror of https://github.com/ReCloudStudio/WebHooker.git synced 2026-09-22 16:11:29 +00:00

wyf9 afe19795b1

docs: sync documentation with current codebase

- Update event formatter count 23 -> 28 (add ping, workflow_job, status, deployment, check_suite)
- Document Telegram support end-to-end (routes, /gh commands, richheader, secrets)
- Fix route schema to use targets array and group fields (owners, emoji)
- Correct KV/D1 storage layout (msg:*, i18n:*, D1 links/send_logs)
- Note GITHUB_APP_ID/GITHUB_PRIVATE_KEY are unused; drop legacy DISCORD_CHANNEL_ID/PORT/CONFIG_PATH
- Remove stale Docker deployment section
- Update color table, branch filter compatibility, admin API endpoints
- AGENTS.md: add Documentation section requiring doc updates after functional changes

2026-08-05 17:22:15 +08:00

1.5 KiB

Raw Blame History

layout

hero

features

home

name

text

tagline

actions

WebHooker

GitHub Webhook → Discord

通过 Cloudflare Workers 接收 GitHub 事件，应用过滤器，将格式化消息路由到 Discord 频道/子区与 Telegram 群组/话题。

theme	text	link
brand	快速开始	/zh/guide/getting-started

theme	text	link
alt	在 GitHub 上查看	https://github.com/ReCloudStudio/WebHooker

title	details
28 种事件格式化器	为 push、pull_request、issues、release、workflow_run 及其他 23 种事件类型提供丰富的 Discord 嵌入与 Telegram HTML 消息，支持颜色编码输出。

title	details
灵活的过滤器	支持按事件类型、仓库、参与者、操作、分支（含 PR）和关键字（支持正则）过滤。支持排除模式。

title	details
Cloudflare Workers	运行在 Cloudflare 边缘网络上。通过 Discord REST API 与 Telegram Bot API 发送消息，并通过 Ed25519 验签的 Interactions Endpoint 支持 `/gh` 命令。

title	details
Web UI、分组与命令	在内置管理控制台中管理路由、分组与发送日志。绑定你的 GitHub 账号，通过 /gh 命令以本人身份评论 issue/PR（Discord 或 Telegram）。

title	details
签名验证	使用 Web Crypto API 进行 HMAC-SHA256 webhook 签名验证与 Ed25519 交互签名验证，支持时间安全比较。

title	details
原地更新	workflow_run 进度在运行推进时于同一条消息上原地更新，Discord 与 Telegram 均支持。

1.5 KiB Raw Blame History Unescape Escape

1.5 KiB

Raw Blame History