a7ea91f529
Add a top-level `README.md` mapping the boxes and per-machine docs under `docs/boxes/` (grouped `colony/`, `home/`, `misc/`), one file per host, VM and container documenting role, services and networking with source pointers. Also point `AGENTS.md` at the new docs. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
23 lines
809 B
Markdown
23 lines
809 B
Markdown
# qclk
|
|
|
|
The `qclk` service container.
|
|
|
|
- **Source:** [`shill/containers/qclk/`](../../../nixos/boxes/colony/vms/shill/containers/qclk)
|
|
- **Host:** NixOS container on `shill`
|
|
|
|
## Role
|
|
|
|
- Runs the custom `qclk` service, exposing an API that is reached over a
|
|
dedicated WireGuard **`management`** network. Managed devices are configured as
|
|
WireGuard peers (each gets an address in the `qclk` prefix), and AS211024
|
|
trusted hosts are allowed to reach the API.
|
|
- `shill` routes the `qclk` prefix to this container.
|
|
|
|
## Networking
|
|
|
|
- `internal` assignment on the `ctrs` network (alt name `qclk-ctr`), plus the
|
|
`management` WireGuard interface carrying the `qclk` prefix.
|
|
|
|
> Check `qclk/default.nix` for the current peer list and exactly what the service
|
|
> does — this entry intentionally stays high-level.
|