Docs · quanthea

The guides and references of the repository's docs/ folder, published as they are.

Get started

Getting started
This page takes you from nothing to a first dashboard in about ten minutes: run quanthea, sign in, give it a model and a data source, and ask for a…

Deploy
quanthea ships as one Docker image, ghcr.io/jboix/quanthea, for linux/amd64 and linux/arm64. It keeps its state in two volumes and reads an optional…
Configuration file
quanthea can be set up entirely from a file: the server settings, the users, sign-in, the data sources, the model, retention, queries, charts and…
Environment variables
Every variable quanthea reads. Each system setting can also come from the configuration file's server section: a variable wins over the file, and the…

Dashboards
A dashboard starts as a conversation. You say what you want to see, the agent proposes a plan, you approve it, and the dashboard builds beside the…
The library
The library holds every pinned dashboard, and the live snapshots. Every role opens it; viewers and analysts land there when they sign in.
Ask and Explain
A pinned dashboard answers questions about what it shows, and explains how each panel is computed. Both use the model, and both keep what they wrote, so…
Snapshots
A snapshot freezes a dashboard as you see it, data included, at a link. Share it in an incident channel or a postmortem: whoever opens it sees exactly…
Alerts
An alert watches one query and tells a channel when a condition holds: "tell me when checkout's 5xx share stays above 2% for 5 minutes". The agent writes…
Reports
A report runs a set of panels on a schedule, over a period, and sends the result: "every Monday at 8:00, last week's sales, compared with the week…

Users and sign-in
People always sign in to quanthea: there is no open access. Admins invite people and give each a role in Settings → Users, and choose how they sign in in…
Data sources
A connector is one data source quanthea reads: a PostgreSQL database, a Prometheus server, a Loki instance, an HTTP API. Admins add and tune them in…
Models and usage
quanthea brings no model of its own. An admin gives it one or more providers in Settings → Model, and Settings → Usage shows what they spent. Pinned…
Notification channels
Alerts and reports send their messages to channels: a Slack channel, a Discord channel, a Teams channel, PagerDuty, or any webhook. A message leaves…
History and retention
quanthea keeps history by design: versions are never rewritten, deleting goes to a bin first, and usage outlives every purge. Admins decide how long the…
Queries and charts
The agent rarely writes a query. It names the data it wants, and quanthea writes and tests the query from a query builder or a saved query. That costs…

Connectors & plugins
A connector kind teaches quanthea to read one kind of source, such as PostgreSQL. This guide adds one. A kind is a folder in apps/server/src/connectors/…
Plugins
Write a connector as a plugin: generate a project with npm create @quanthea/plugin, build it against @quanthea/plugin-kit, and test it with the conformance suite.