mirror of
https://github.com/wu736139669/hapi.git
synced 2026-08-05 06:24:37 +00:00
weishu
b7503d9309
- split installation.md into installation/deployment/notifications - merge cursor/grok guides into new agents.md with full support matrix - sidebar: grouped sections; add namespace, deployment, notifications, native companion contract - fix license footer (AGPL-3.0), settings schema fields and $id - fix drift in pwa, faq, namespace, how-it-works, voice-assistant, quick-start, native-companion-contract - move mermaid lightbox dogfood doc to localdocs (untracked) - README: complete agent list, replace dead cursor/grok links
68 lines
1.9 KiB
Markdown
68 lines
1.9 KiB
Markdown
# Notifications
|
|
|
|
Get notified when sessions need input, request permissions, fail, or complete — via Telegram, Server酱 (ServerChan), Web Push, or voice.
|
|
|
|
Web Push works out of the box once you [install the PWA](./pwa.md); no configuration needed. The channels below are optional.
|
|
|
|
## Telegram Setup
|
|
|
|
Enable Telegram notifications and Mini App access:
|
|
|
|
1. Message [@BotFather](https://t.me/BotFather) and create a bot
|
|
2. Set the bot token and public URL
|
|
3. Start the hub and bind your account
|
|
|
|
```bash
|
|
export TELEGRAM_BOT_TOKEN="your-bot-token"
|
|
export HAPI_PUBLIC_URL="https://your-public-url"
|
|
|
|
hapi hub
|
|
```
|
|
|
|
Then message your bot with `/start`, open the app, and enter your `CLI_API_TOKEN`.
|
|
|
|
Related environment variables:
|
|
|
|
- `TELEGRAM_NOTIFICATION` - Enable/disable Telegram notifications (default: `true`)
|
|
|
|
**Troubleshooting:**
|
|
|
|
- If binding fails, verify `HAPI_PUBLIC_URL` is accessible from the internet
|
|
- Telegram Mini App requires HTTPS (not HTTP)
|
|
|
|
## ServerChan (Server酱) Setup
|
|
|
|
Server酱 pushes notifications to WeChat and other channels. The hub sends ServerChan messages when a session is ready for input, requests a permission, a task fails, or a session completes.
|
|
|
|
1. Get a SendKey from [sct.ftqq.com](https://sct.ftqq.com/)
|
|
2. Set the SendKey and start the hub:
|
|
|
|
```bash
|
|
export SERVERCHAN_SENDKEY="your-sendkey"
|
|
export HAPI_PUBLIC_URL="https://your-public-url"
|
|
|
|
hapi hub
|
|
```
|
|
|
|
Messages include a link back to the session, built from `HAPI_PUBLIC_URL`.
|
|
|
|
Related environment variables:
|
|
|
|
- `SERVERCHAN_NOTIFICATION` - Enable/disable ServerChan notifications (default: `true`)
|
|
|
|
Both values can also be set in `settings.json` (`serverChanSendKey`, `serverChanNotification`).
|
|
|
|
## Voice assistant setup
|
|
|
|
Enable voice control:
|
|
|
|
1. Get an API key from [elevenlabs.io](https://elevenlabs.io/app/settings/api-keys)
|
|
2. Set the environment variable:
|
|
|
|
```bash
|
|
export ELEVENLABS_API_KEY="your-api-key"
|
|
hapi hub --relay
|
|
```
|
|
|
|
See [Voice Assistant](./voice-assistant.md) for usage details.
|