# Documentation index Start with the project [README](../README.md). ## User guide Read in order: 1. [`how-it-works.md`](how-it-works.md): what the binary does, what it reads and serves, auth, lifecycle, signals, commands 2. [`install.md`](install.md): Nix package, NixOS module, or from source with an example systemd unit 3. [`configuration.md`](configuration.md): layers (file, env, flags), every section, validation, what reloads 4. [`operations.md`](operations.md): tokens, MCP clients, network exposure, Docker access, OpenTelemetry, troubleshooting ## Reference | Doc | Contents | | ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [`api.md`](api.md) | Full REST route table, MCP tools/prompts/resources, client setup, Origin and Host checks | | [`openapi.json`](openapi.json) | Generated OpenAPI 3.1 description of the REST API and MCP endpoint; regenerate with `cargo run -- openapi --peers > docs/openapi.json`; rendered by the running binary at `/docs` (Redoc) | | [`tls.md`](tls.md) | Native TLS: configuration, self-signed example, SIGHUP rotation, ACME and sops paths | | [`consolidator.md`](consolidator.md) | Peers (consolidator): config, agenix tokens, threat model, firewall, reload | ## Contributors | Doc | Contents | | -------------------------------------- | ------------------------------------------------------------ | | [`development.md`](development.md) | Toolchain, tests, version stamp, OpenAPI regeneration | | [`hooks.md`](hooks.md) | Git hooks and flake checks | | [`ARCHITECTURE.md`](../ARCHITECTURE.md) | Design, decisions, verification | | [`TODO.md`](../TODO.md) | Work tracking | | [`AGENTS.md`](../AGENTS.md) | Guidance for AI coding agents | | [`plan/`](../plan/README.md) | Plans for the next big phase | ## Workstream records (archived) > **Archived.** The files in [`workstreams/`](workstreams/) are historical records of how the project was built (scope, owned files, design notes, logs). They are not maintained. Current design is in [`ARCHITECTURE.md`](../ARCHITECTURE.md) and open work is in [`TODO.md`](../TODO.md). | Card | Phase | Depends on | | -------------------------------------------------------- | --------------- | ---------------------------------------------------------- | | [P0 Foundation](workstreams/P0-foundation.md) | 0 | none | | [WS-A systemd](workstreams/WS-A-systemd.md) | 1 | P0 | | [WS-B journal](workstreams/WS-B-journal.md) | 1 | P0 | | [WS-C docker](workstreams/WS-C-docker.md) | 1 | P0 | | [WS-D auth + DB](workstreams/WS-D-auth.md) | 1 | P0 | | [WS-E REST](workstreams/WS-E-rest.md) | 2 | A, B, C, D | | [WS-F MCP](workstreams/WS-F-mcp.md) | 2 | A, B, C, D | | [WS-G OTel](workstreams/WS-G-otel.md) | 2 | A, B, C | | [P3 Integration](workstreams/P3-integration.md) | 3 | E, F, G | | [WS-I TLS](workstreams/WS-I-tls.md) | 4 | P3 | | [WS-H NixOS](workstreams/WS-H-nixos.md) | 4 | P3, WS-I (gate result pending) | | [P5 Consolidator](workstreams/P5-consolidator/README.md) | 5 | WS-H, WS-I (folder: contracts, decisions, WS-T and A to F) | | [WS-G OpenAPI](workstreams/WS-G-openapi.md) | 5 (stand-alone) | P5 | | [WS-H final fixes](workstreams/WS-H-final-fixes.md) | 5 | P5 final review | Dependency order: P0, then A to D in parallel, then E to G in parallel, then P3, then WS-I, then WS-H. Phase 5 (P5) came after, then the OpenAPI doc and the final fixes.