Authoritative project documentation
Deployment guide matrix — with and without Scout Bee
Every supported way to run ApiaryLens is documented twice: once for Scout Bee, the guided lifecycle companion, and once as a fully manual procedure that never requires Scout. Both columns are first-class — Scout automates the documented manual steps, it never replaces them.
This page is the honest index of that matrix. A guide is linked only when it has been task-tested against the exact released artifact it documents; everything else is listed with its real status and the public issue tracking it. Nothing here links to an artifact that has not been released.
The matrix
| Deployment | With Scout Bee | Without Scout (manual) |
|---|---|---|
| Local-only (web PWA, no cloud backend) | Draft — awaiting the Scout Bee release (SCOUT-002) and the owner walkthrough | Draft — written against today's product; first-class standalone mode (no sync UI, local backup/restore) is in flight (WEB-001) |
| On-prem Docker Compose | Draft — awaiting the Scout Bee release (SCOUT-002) and the owner walkthrough | Available: Manual Compose install — task-tested against the published release bundle |
| Cloudflare (your own account) | Draft — awaiting the Scout Bee release (SCOUT-002) and the owner walkthrough | Awaiting validation — drafted and artifact-verified; publication is blocked until the owner-run live Cloudflare lifecycle is recorded |
| Air-gap (zero egress, transported media) | Draft — awaiting the Scout Bee release (SCOUT-002), the transported-media flow design, and the owner walkthrough | Available: Air-gap install and transported update — task-tested end to end on a pristine egress-blocked host against the published v0.1.0-preview.6 bundle |
| Windows app | On hold — the Windows client is on hold pending a full rewrite (Phase 3); Scout's windows_client target stays feature-flagged off until then |
On hold — same rewrite; the web app works on Windows in any modern browser today |
Status vocabulary: Available = published here, task-tested against the exact released artifact. Draft = written but unpublished; the publication gate (task-tested against the released artifact, end to end) has not been passed yet. Awaiting validation = the guide and artifact checks are done but the end-to-end walk that gates publication has not been recorded. On hold = no work scheduled until its phase begins.
What Scout Bee does — and what that means for manual installs
Scout Bee is not released yet. When it is, every guide in the left column will state exactly what Scout does for that path, and it is the same three things every time:
- Verify — check each downloaded artifact's SHA-256 against the published release manifest and verify its keyless signing attestation before anything is installed.
- Install — apply the documented deployment steps for the chosen target, in order, stopping at the first failure.
- Health-check — confirm the deployment reports the expected release identity and passes its health checks before declaring success.
Manual operators do the same three things by hand, and every manual guide in the right column documents them: the verification commands, the install steps, and the health verification. Choosing the manual path never means accepting less safety — only doing the same work yourself.
See the Scout Bee installation and operations guide for the intended Scout workflow, published for review ahead of its release, and Verify a release for the verification procedure every path shares.