docs

Documentation

Everything you need for setup, configuration, and building from source.

Start with the main README for an overview, or jump to a specific topic below.

Document	Description
FAQ	Common questions — requirements, models, privacy, settings, capabilities
Troubleshooting	Connection issues, performance, models, tool calling, thinking mode, server
Model Guide	Supported models, capabilities, RAM requirements, recommendations
Client Setup	Setup guides for Home Assistant, Open WebUI, OpenClaw, Python, curl

Document	Description
API Reference	Full endpoint reference — request/response formats, parameters, examples
Home Assistant REST API	REST sensors, server control commands, automation examples
Prometheus Metrics	Metric names, types, PromQL examples, Grafana setup

Document	Description
Security	Bearer token auth, network exposure, HTTPS, server control endpoints
Privacy Policy	What data the app accesses, stores, and sends over the network

Document	Description
Building from Source	Prerequisites, build commands, signing, flavors, versioning
Architecture	Internal architecture, package structure, threading model, request flow
Model Allowlist Schema	JSON schema for model allowlist — fields, badges, defaults, examples

Document	Description
Changelog	Release history and version notes
License	Apache License 2.0