From the source of truth
Documentation
What the broker does, every key it takes, every series it exposes and every table it keeps.
The design is the authoritative documentation. Tests take their expectations from it.
The design says what Sagüin does; the configuration, metrics and storage documents define every key, every series and every table. The contribution guide, release notes and licence live here too. These pages are copied into this static site by npm run sync:docs, never fetched from GitHub in a visitor's browser.
Design
The rules, channels, the store, $saguin topics, bridges, access and reload, operations, and every MQTT flow, with Sagüin’s choices where MQTT leaves them open.
Read documentConfiguration
Every key of Sagüin’s configuration file, with its default and meaning, and the keys it refuses, with their replacements.
Read documentMetrics
Every series Sagüin exposes on /metrics, with its labels and meaning.
Read documentStorage
Every SQLite table Sagüin keeps, the schema version, and tuning: machines, drives, settings and capacity.
Read documentContributing
How to contribute to Sagüin, starting with finding where the design is wrong, ambiguous or incomplete.
Read documentChangelog
Sagüin’s release notes, one section for each tagged release.
Read documentLicense
The Apache License 2.0, under which Sagüin is distributed.
Read documentnpm run sync:docs.