mirror of
https://github.com/ReCloudStudio/WebHooker.git
synced 2026-09-23 00:21:28 +00:00
RhenCloud
d996dbe45d
- deployment: drop DISCORD_CHANNEL_ID, add ADMIN_USER_IDS, PKCS#8 key note, applications.commands invite scope, and an optional Gateway section - getting-started: PKCS#8 .dev.vars example, remove channel ID - introduction: REST delivery, optional DiscordGateway DO, delivery dedup, /admin Web UI in architecture and data flow - index: refresh Workers feature, add Web UI & slash commands feature
135 lines
4.8 KiB
Markdown
135 lines
4.8 KiB
Markdown
# Deployment
|
|
|
|
## Cloudflare Setup
|
|
|
|
### 1. Create KV Namespace
|
|
|
|
```bash
|
|
npx wrangler kv namespace create KV
|
|
```
|
|
|
|
This outputs a namespace ID. Update `wrangler.jsonc` with the ID:
|
|
|
|
```jsonc
|
|
{
|
|
"kv_namespaces": [
|
|
{
|
|
"binding": "KV",
|
|
"id": "your-namespace-id",
|
|
},
|
|
],
|
|
}
|
|
```
|
|
|
|
### 2. Set Secrets
|
|
|
|
```bash
|
|
npx wrangler secret put GITHUB_WEBHOOK_SECRET
|
|
npx wrangler secret put GITHUB_APP_ID
|
|
npx wrangler secret put GITHUB_PRIVATE_KEY # PKCS#8 PEM (BEGIN PRIVATE KEY)
|
|
npx wrangler secret put GITHUB_CLIENT_ID
|
|
npx wrangler secret put GITHUB_CLIENT_SECRET
|
|
npx wrangler secret put DISCORD_TOKEN
|
|
npx wrangler secret put ADMIN_USER_IDS # comma-separated GitHub IDs/logins allowed into the Web UI
|
|
```
|
|
|
|
::: tip Target channels are configured per route
|
|
There is no global channel secret. Each route in the [Web UI](/guide/configuration#web-ui) declares its own target channel (and optional thread), so `DISCORD_CHANNEL_ID` is not needed.
|
|
:::
|
|
|
|
::: warning GitHub App private key must be PKCS#8
|
|
GitHub issues private keys in PKCS#1 format (`BEGIN RSA PRIVATE KEY`). Cloudflare Workers' JWT signing requires PKCS#8. Convert first:
|
|
|
|
```bash
|
|
openssl pkcs8 -topk8 -inform PEM -outform PEM -nocrypt \
|
|
-in your-app.private-key.pem -out gh_pk_pkcs8.pem
|
|
```
|
|
|
|
Then upload `gh_pk_pkcs8.pem` as `GITHUB_PRIVATE_KEY`.
|
|
:::
|
|
|
|
The Discord Gateway is optional. Set `DISCORD_GATEWAY_ENABLED` in `wrangler.jsonc` `vars` (`"false"` by default). See [Gateway (optional)](#gateway-optional) below.
|
|
|
|
### 3. Deploy
|
|
|
|
```bash
|
|
npx wrangler deploy
|
|
```
|
|
|
|
Your worker is now live at `https://webhooker.<your-subdomain>.workers.dev`.
|
|
|
|
### 4. Configure GitHub Webhook
|
|
|
|
1. Go to your GitHub App settings
|
|
2. Set **Webhook URL** to `https://webhooker.<your-subdomain>.workers.dev/webhook`
|
|
3. Set **Webhook secret** to match `GITHUB_WEBHOOK_SECRET`
|
|
|
|
## GitHub App Setup
|
|
|
|
### 1. Create App
|
|
|
|
1. Go to <https://github.com/settings/apps/new>
|
|
2. Fill in:
|
|
- **GitHub App name**: `WebHooker` (or your choice)
|
|
- **Homepage URL**: your domain
|
|
- **Webhook URL**: `https://your-domain/webhook`
|
|
- **Webhook secret**: generate and copy to `GITHUB_WEBHOOK_SECRET`
|
|
3. Set permissions:
|
|
- **Repository permissions**: Contents (read), Issues (write), Pull requests (write), Metadata (read)
|
|
- **Organization permissions**: Members (read) — if needed
|
|
4. Subscribe to events (all 23 supported):
|
|
- Push, Pull request, Issues, Issue comment, Workflow run, Release, Create, Delete, Star, Fork, Check run, Pull request review, Pull request review comment, Commit comment, Deployment status, Member, Label, Milestone, Discussion, Discussion comment, Repository, Code scanning alert, Dependabot alert
|
|
5. Generate private key → save contents to `GITHUB_PRIVATE_KEY` env var
|
|
|
|
### 2. Install App
|
|
|
|
1. After creation, go to the App settings page
|
|
2. Click "Install App" → select org/user
|
|
3. Choose repositories to monitor
|
|
|
|
### 3. Configure OAuth
|
|
|
|
1. Go to App → OAuth settings
|
|
2. Set **Callback URL**: `https://your-domain/auth/github/callback`
|
|
3. Copy Client ID and Client Secret to env
|
|
|
|
## Discord Bot Setup
|
|
|
|
1. Go to <https://discord.com/developers/applications>
|
|
2. Create a new application → go to Bot section
|
|
3. Copy the bot token to `DISCORD_TOKEN`
|
|
4. Invite the bot with the `bot` and `applications.commands` scopes and the `View Channels` + `Send Messages` + `Send Messages in Threads` permissions (combined integer `274877910016`):
|
|
|
|
```text
|
|
https://discord.com/oauth2/authorize?client_id=YOUR_BOT_CLIENT_ID&permissions=274877910016&scope=bot+applications.commands
|
|
```
|
|
|
|
5. Configure target channels **per route** in the Web UI (`/admin`) — no global channel ID is required.
|
|
|
|
### Gateway (optional)
|
|
|
|
Messages are sent via the Discord **REST API**, so pushing works with just `DISCORD_TOKEN`. The Gateway connection is only needed to (a) show the bot as **online** and (b) enable the in-Discord slash / context-menu commands.
|
|
|
|
- `DISCORD_GATEWAY_ENABLED=false` (default): REST-only, no Gateway connection.
|
|
- `DISCORD_GATEWAY_ENABLED=true`: a Durable Object holds the Gateway connection and registers the `/gh` slash command plus the `GitHub: 添加/编辑/删除评论` message commands per guild.
|
|
|
|
When enabled, users run `/gh login` to link their GitHub account and can then comment on issues/PRs as themselves. See the [README](https://github.com/ReCloudStudio/WebHooker#bot-commands-comment-on-github-as-yourself) for the full command reference.
|
|
|
|
## Custom Domain (Optional)
|
|
|
|
To use a custom domain instead of `*.workers.dev`:
|
|
|
|
1. Go to your Cloudflare Worker settings
|
|
2. Add a custom domain or route
|
|
3. Update `BASE_URL` to match
|
|
|
|
## Docker
|
|
|
|
A Dockerfile is provided for containerized deployments (e.g., behind a reverse proxy):
|
|
|
|
```bash
|
|
docker build -t webhooker .
|
|
docker run -p 8787:8787 --env-file .env webhooker
|
|
```
|
|
|
|
Note: Docker mode runs without Durable Objects and KV. Use Cloudflare deployment for full functionality.
|