feat(docs): Mokosh local Compose + OCI login docs for mokosh-server (PMS-678) #387

Merged
nrupard merged 1 commit from feat/PMS-678-mokosh-setup-docs into main 2026-07-21 21:30:13 +02:00
Owner

What

PMS-678 asks for public docs on running Mokosh locally with Docker Compose and understanding the OCI registry login model. It is filed under mokosh, but the public-facing documentation lives under Bunyip for now, so this delivers it as bunyip per-application docs for the mokosh-server app - rendered on a full page at /apps/mokosh-server/docs/* (satisfying the "application page, not a cut-off pop-up" AC).

Content (seed migration, 3 pages)

  • Running with Docker Compose - a self-contained single-host compose.yml (server + postgres), grounded in the distribution template docker/template/mokosh-server/compose.yml and mokosh-server's env (DATABASE_URL, OIDC_ISSUER/OIDC_AUDIENCE, ENCRYPTION_KEY, RUN_MIGRATIONS), simplified for local use (no Traefik/Infisical).
  • The image registry and signing in - oci.a8n.systems, a8n.systems credentials, what access requires, and the suspended/deactivated-account behaviour. Verified against bunyip-oci oci_auth: an account with deleted_at set (suspended/deactivated) is rejected as unauthorized, and access is gated by is_access_allowed.
  • Splitting the server and web across hosts - the mokosh-server (backend + db) vs mokosh-www (frontend) split.

Verified

Migration validated on a throwaway postgres (3 pages seeded, 5 total for mokosh-server; bodies and the compose $$ escaping intact); bunyip-api compiles (migration embeds); prefix unique.

Note

Filed under PMS-678 (mokosh). Delivered in the bunyip repo per the "public docs live under Bunyip" decision; the commit references PMS-678.

## What PMS-678 asks for public docs on running Mokosh locally with Docker Compose and understanding the OCI registry login model. It is filed under mokosh, but the public-facing documentation lives under Bunyip for now, so this delivers it as **bunyip per-application docs for the `mokosh-server` app** - rendered on a full page at `/apps/mokosh-server/docs/*` (satisfying the "application page, not a cut-off pop-up" AC). ## Content (seed migration, 3 pages) - **Running with Docker Compose** - a self-contained single-host `compose.yml` (server + postgres), grounded in the distribution template `docker/template/mokosh-server/compose.yml` and mokosh-server's env (`DATABASE_URL`, `OIDC_ISSUER`/`OIDC_AUDIENCE`, `ENCRYPTION_KEY`, `RUN_MIGRATIONS`), simplified for local use (no Traefik/Infisical). - **The image registry and signing in** - `oci.a8n.systems`, a8n.systems credentials, what access requires, and the suspended/deactivated-account behaviour. Verified against bunyip-oci `oci_auth`: an account with `deleted_at` set (suspended/deactivated) is rejected as unauthorized, and access is gated by `is_access_allowed`. - **Splitting the server and web across hosts** - the `mokosh-server` (backend + db) vs `mokosh-www` (frontend) split. ## Verified Migration validated on a throwaway postgres (3 pages seeded, 5 total for mokosh-server; bodies and the compose `$$` escaping intact); bunyip-api compiles (migration embeds); prefix unique. ## Note Filed under PMS-678 (mokosh). Delivered in the bunyip repo per the "public docs live under Bunyip" decision; the commit references PMS-678.
feat(docs): seed Mokosh setup docs (compose, registry login, split) for mokosh-server (PMS-678)
All checks were successful
E2E / Playwright against deployment (pull_request) Successful in 33s
Check / fmt + clippy + build + tests (pull_request) Successful in 3m48s
Create release / Create release from merged PR (pull_request) Has been skipped
4de3cc8c9f
PMS-678 asks for public docs on running Mokosh locally and the OCI registry login model. It is filed under mokosh, but the public-facing documentation lives under Bunyip for now, so this is delivered as bunyip per-application docs for the mokosh-server app - rendered on a full page at /apps/mokosh-server/docs/*, not a cut-off pop-up.

A seed migration adds three pages: Running with Docker Compose (a self-contained single-host setup, grounded in the distribution template docker/template/mokosh-server/compose.yml and mokosh-server's env), The image registry and signing in (oci.a8n.systems, a8n.systems credentials, and the suspended/deactivated-account behaviour verified against bunyip-oci's oci_auth flow - a suspended account is rejected as unauthorized and can no longer pull), and Splitting the server and web across hosts. Validated on a throwaway postgres (three pages seeded, bodies and the compose $$ escaping intact).

#PMS-678

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
nrupard deleted branch feat/PMS-678-mokosh-setup-docs 2026-07-21 21:30:13 +02:00
Sign in to join this conversation.
No reviewers
No labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
psa-systems/bunyip!387
No description provided.