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
99 lines
3.0 KiB
JSON
99 lines
3.0 KiB
JSON
{
|
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
"$id": "https://hapi.run/docs/schemas/settings.schema.json",
|
|
"title": "HAPI Settings",
|
|
"description": "Configuration file for HAPI (~/.hapi/settings.json)",
|
|
"type": "object",
|
|
"properties": {
|
|
"cliApiToken": {
|
|
"type": "string",
|
|
"description": "Shared secret for CLI authentication. Auto-generated if not set. ENV: CLI_API_TOKEN"
|
|
},
|
|
"apiUrl": {
|
|
"type": "string",
|
|
"format": "uri",
|
|
"default": "http://localhost:3006",
|
|
"description": "Hub URL for CLI connections. ENV: HAPI_API_URL"
|
|
},
|
|
"extraHeaders": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"description": "Extra headers for CLI to hub HTTP and WebSocket requests. ENV: HAPI_EXTRA_HEADERS_JSON"
|
|
},
|
|
"listenHost": {
|
|
"type": "string",
|
|
"default": "127.0.0.1",
|
|
"description": "Hub HTTP bind address. ENV: HAPI_LISTEN_HOST"
|
|
},
|
|
"listenPort": {
|
|
"type": "integer",
|
|
"default": 3006,
|
|
"minimum": 1,
|
|
"maximum": 65535,
|
|
"description": "Hub HTTP port. ENV: HAPI_LISTEN_PORT"
|
|
},
|
|
"publicUrl": {
|
|
"type": "string",
|
|
"format": "uri",
|
|
"description": "Public URL for external access (e.g., Telegram Mini App). ENV: HAPI_PUBLIC_URL"
|
|
},
|
|
"corsOrigins": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Allowed CORS origins. ENV: CORS_ORIGINS (comma-separated)"
|
|
},
|
|
"telegramBotToken": {
|
|
"type": "string",
|
|
"description": "Telegram Bot API token from @BotFather. ENV: TELEGRAM_BOT_TOKEN"
|
|
},
|
|
"telegramNotification": {
|
|
"type": "boolean",
|
|
"default": true,
|
|
"description": "Enable Telegram notifications. ENV: TELEGRAM_NOTIFICATION"
|
|
},
|
|
"serverChanSendKey": {
|
|
"type": "string",
|
|
"description": "ServerChan SendKey for WeChat push notifications. ENV: SERVERCHAN_SENDKEY"
|
|
},
|
|
"serverChanNotification": {
|
|
"type": "boolean",
|
|
"default": true,
|
|
"description": "Enable ServerChan notifications. ENV: SERVERCHAN_NOTIFICATION"
|
|
},
|
|
"relayAuthKey": {
|
|
"type": "string",
|
|
"description": "Per-hub relay auth key issued by the relay server. Auto-obtained if not set. ENV: HAPI_RELAY_AUTH"
|
|
},
|
|
"vapidKeys": {
|
|
"type": "object",
|
|
"description": "Auto-generated Web Push VAPID keys. Do not edit manually.",
|
|
"properties": {
|
|
"publicKey": {
|
|
"type": "string"
|
|
},
|
|
"privateKey": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": ["publicKey", "privateKey"]
|
|
},
|
|
"machineId": {
|
|
"type": "string",
|
|
"description": "Auto-generated unique machine identifier. Do not edit manually."
|
|
},
|
|
"machineIdConfirmedByServer": {
|
|
"type": "boolean",
|
|
"description": "Internal flag. Do not edit manually."
|
|
},
|
|
"runnerAutoStartWhenRunningHappy": {
|
|
"type": "boolean",
|
|
"description": "Auto-start runner when running hapi command."
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
}
|