ReCloudStudio/WebHooker
1
0
Fork 0
mirror of https://github.com/ReCloudStudio/WebHooker.git synced 2026-09-22 16:11:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore: auto-fix lint & formatting [skip ci]

Browse source
This commit is contained in:
github-actions[bot] 2026-08-26 16:39:02 +00:00
parent c75567cf15
commit 1375db9a20
15 changed files with 160 additions and 88 deletions
Download patch file Download diff file Expand all files Collapse all files

18
docs/guide/configuration.md
View file

@ -16,16 +16,16 @@ WebHooker requires several secrets to function. For local development, store the
### Required Secrets
| Variable | Description |
| ----------------------- | ------------------------------------------------------------------------ |
| `GITHUB_WEBHOOK_SECRET` | Webhook secret from your GitHub App settings |
| `GITEA_WEBHOOK_SECRET` | Webhook secret from your Gitea instance (only to receive Gitea webhooks) |
| `GITHUB_CLIENT_ID` | OAuth client ID from App settings |
| `GITHUB_CLIENT_SECRET` | OAuth client secret from App settings |
| `DISCORD_TOKEN` | Discord bot token |
| `TELEGRAM_TOKEN` | Telegram bot token (from BotFather) — required for Telegram routes |
| Variable | Description |
| ----------------------- | -------------------------------------------------------------------------- |
| `GITHUB_WEBHOOK_SECRET` | Webhook secret from your GitHub App settings |
| `GITEA_WEBHOOK_SECRET` | Webhook secret from your Gitea instance (only to receive Gitea webhooks) |
| `GITHUB_CLIENT_ID` | OAuth client ID from App settings |
| `GITHUB_CLIENT_SECRET` | OAuth client secret from App settings |
| `DISCORD_TOKEN` | Discord bot token |
| `TELEGRAM_TOKEN` | Telegram bot token (from BotFather) — required for Telegram routes |
| `FEISHU_APP_ID` | Feishu app ID (from the app Credentials page) — required for Feishu routes |
| `FEISHU_APP_SECRET` | Feishu app secret — required for Feishu routes |
| `FEISHU_APP_SECRET` | Feishu app secret — required for Feishu routes |
> [!NOTE]
> `GITHUB_APP_ID` and `GITHUB_PRIVATE_KEY` (PKCS#8 PEM) are used by the GitHub App

8
docs/guide/deployment.md
View file

@ -231,11 +231,11 @@ To enable inbound:
### Required permissions
| Permission | Purpose |
| ---------- | ------- |
| `im:message` | Read and send direct messages and group chat messages. |
| Permission | Purpose |
| ------------------------ | ---------------------------------------------------------- |
| `im:message` | Read and send direct messages and group chat messages. |
| `im:message:send_as_bot` | Send messages as an app bot (alternative to `im:message`). |
| `im:message:send` | Send messages V2 (historical version, alternative). |
| `im:message:send` | Send messages V2 (historical version, alternative). |
> [!NOTE]
> Custom bots (group-level webhook URL) are not supported. WebHooker uses an **app bot** so message editing, token caching, multi-group routing, and inbound commands work the same way as Discord and Telegram.

8
docs/zh/guide/deployment.md
View file

@ -231,11 +231,11 @@ WebHooker 使用应用级凭证（`FEISHU_APP_ID` / `FEISHU_APP_SECRET`）请求
### 所需权限
| 权限 | 用途 |
| ---- | ---- |
| `im:message` | 读取和发送单聊与群聊消息。 |
| 权限 | 用途 |
| ------------------------ | ------------------------------------------------- |
| `im:message` | 读取和发送单聊与群聊消息。 |
| `im:message:send_as_bot` | 以应用机器人身份发送消息（`im:message` 的替代）。 |
| `im:message:send` | 旧版发送消息权限（`im:message` 的替代）。 |
| `im:message:send` | 旧版发送消息权限（`im:message` 的替代）。 |
> [!NOTE]
> 不支持“自定义机器人”的群级 Webhook URL。WebHooker 统一使用**应用机器人**，以保持与 Discord、Telegram 一致的凭证管理、消息编辑、多群路由与入站指令能力。

2
docs/zh/guide/logs.md
View file

@ -11,7 +11,7 @@
| `event` | 事件类型（如 `push`、`pull_request`、`custom`） |
| `repo` | 仓库全名（存在时） |
| `target` | 消息发送到的目标 id |
| `platform` | `discord`、`telegram` 或 `feishu` |
| `platform` | `discord`、`telegram` 或 `feishu` |
| `ok` | 发送是否成功 |
| `status` | 平台 API 的 HTTP 状态码（适用时） |
| `error` | 失败时的错误信息 |