WebHooker/.env.example
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

27 lines
778 B
Text

# GitHub
GITHUB_WEBHOOK_SECRET=your-webhook-secret
GITHUB_APP_ID=your-app-id
GITHUB_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----"
GITHUB_CLIENT_ID=your-client-id
GITHUB_CLIENT_SECRET=your-client-secret
# Discord
DISCORD_TOKEN=your-bot-token
DISCORD_PUBLIC_KEY=your-public-key
DISCORD_APPLICATION_ID=your-application-id
# Telegram
TELEGRAM_TOKEN=your-bot-token
TELEGRAM_WEBHOOK_SECRET=your-webhook-secret
# TELEGRAM_RICH_HEADER_HOST=https://your-domain
# Admin
ADMIN_USER_IDS=your-github-id,your-github-login
# 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