mirror of
https://github.com/ReCloudStudio/WebHooker.git
synced 2026-09-22 16:11:29 +00:00
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
This commit is contained in:
parent
68cda9f178
commit
afe19795b1
25 changed files with 621 additions and 398 deletions
18
.env.example
18
.env.example
|
|
@ -1,7 +1,7 @@
|
|||
# GitHub
|
||||
GITHUB_WEBHOOK_SECRET=your-webhook-secret
|
||||
GITHUB_APP_ID=your-app-id
|
||||
GITHUB_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----"
|
||||
GITHUB_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----"
|
||||
GITHUB_CLIENT_ID=your-client-id
|
||||
GITHUB_CLIENT_SECRET=your-client-secret
|
||||
|
||||
|
|
@ -9,15 +9,19 @@ GITHUB_CLIENT_SECRET=your-client-secret
|
|||
DISCORD_TOKEN=your-bot-token
|
||||
DISCORD_PUBLIC_KEY=your-public-key
|
||||
DISCORD_APPLICATION_ID=your-application-id
|
||||
DISCORD_CHANNEL_ID=your-channel-id
|
||||
|
||||
# Telegram
|
||||
TELEGRAM_TOKEN=your-bot-token
|
||||
TELEGRAM_WEBHOOK_SECRET=your-webhook-secret
|
||||
# TELEGRAM_RICH_HEADER_HOST=https://your-domain
|
||||
|
||||
# Server
|
||||
PORT=3000
|
||||
BASE_URL=http://localhost:3000
|
||||
# Admin
|
||||
ADMIN_USER_IDS=your-github-id,your-github-login
|
||||
|
||||
# Config
|
||||
CONFIG_PATH=./config.yaml
|
||||
# Server / public URL (OAuth callbacks + Telegram webhook sync)
|
||||
BASE_URL=http://localhost:8787
|
||||
|
||||
# Optional
|
||||
# DOCS_URL=https://your-docs-site
|
||||
# GITHUB_REPO_URL=https://github.com/ReCloudStudio/WebHooker
|
||||
# LEGAL_CONTACT=contact@example.com
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue