Container details now carry the image id and the HostConfig resource limits
(CPU cores and shares, memory and swap bytes, pids, device requests) plus sandbox flags
(privileged, read-only rootfs, network mode, restart policy), with null meaning unlimited. A new
GET /api/v1/docker/containers/{name}/stats returns one live sample: CPU percent
of one core, memory working set, processes, block IO and network bytes. Peers
proxy the new route.
Env, labels, command lines and mounts are deliberately excluded from the payload.
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Documentation index
Start with the project README.
User guide
Read in order:
how-it-works.md: what the binary does, what it reads and serves, auth, lifecycle, signals, commandsinstall.md: Nix package, NixOS module, or from source with an example systemd unitconfiguration.md: layers (file, env, flags), every section, validation, what reloadsoperations.md: tokens, MCP clients, network exposure, Docker access, OpenTelemetry, troubleshooting
Reference
| Doc | Contents |
|---|---|
api.md |
Full REST route table, MCP tools/prompts/resources, client setup, Origin and Host checks |
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 |
Native TLS: configuration, self-signed example, SIGHUP rotation, ACME and sops paths |
consolidator.md |
Peers (consolidator): config, agenix tokens, threat model, firewall, reload |
Contributors
| Doc | Contents |
|---|---|
development.md |
Toolchain, tests, version stamp, OpenAPI regeneration |
hooks.md |
Git hooks and flake checks |
ARCHITECTURE.md |
Design, decisions, verification |
TODO.md |
Work tracking |
AGENTS.md |
Guidance for AI coding agents |
plan/ |
Plans for the next big phase |
Workstream records (archived)
Archived. The files in
workstreams/are historical records of how the project was built (scope, owned files, design notes, logs). They are not maintained. Current design is inARCHITECTURE.mdand open work is inTODO.md.
| Card | Phase | Depends on |
|---|---|---|
| P0 Foundation | 0 | none |
| WS-A systemd | 1 | P0 |
| WS-B journal | 1 | P0 |
| WS-C docker | 1 | P0 |
| WS-D auth + DB | 1 | P0 |
| WS-E REST | 2 | A, B, C, D |
| WS-F MCP | 2 | A, B, C, D |
| WS-G OTel | 2 | A, B, C |
| P3 Integration | 3 | E, F, G |
| WS-I TLS | 4 | P3 |
| WS-H NixOS | 4 | P3, WS-I (gate result pending) |
| P5 Consolidator | 5 | WS-H, WS-I (folder: contracts, decisions, WS-T and A to F) |
| WS-G OpenAPI | 5 (stand-alone) | P5 |
| WS-H final fixes | 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.