archetech / archon / 33970265106

87%

push

github

docs(deployment): Offer the minimal stack as a way in, with a CLI to drive it (#1049)

* docs(deployment): Offer the minimal stack as a way in

The deployment guide only ever described the full docker-compose.yml, so
an operator wanting to try a node first had no path here -- minimal.yml
and minimal-sample.env were documented in the README alone.

Records what actually separates the two, since "minimal" already meant
something else in this guide: minimal.yml runs the hyperswarm mediator,
so DIDs reach peers, where the base compose with no profiles has no
registry mediator at all; and it resolves with no warnings against
minimal-sample.env, where the base compose emits 141.

Also corrects the profile-gated list. MongoDB is behind the `mongodb`
profile, so leaving COMPOSE_PROFILES empty does not start it -- redis is
the default database.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GYGMfX3foBcVqP7AQNXjWj

* feat(compose): Put the CLI in the minimal stack

The minimal stack had no way to drive it. It exposes Gatekeeper and
Keymaster on the host, but nothing in it creates a DID, so an operator
evaluating a node could see containers start and nothing else.

cli.yml joins the includes and the `cli` profile the sample selects. The
container idles, so it costs a process and no ports, and the deployment
guide now shows the exec invocation -- which was documented nowhere,
despite the image shipping since the CLI existed. HTTP equivalents are
noted for anyone who would rather not use it.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GYGMfX3foBcVqP7AQNXjWj

* feat(cli): Give the CLI image a name on PATH

Driving the container meant spelling out `node scripts/archon-cli.js`,
because that script carries no shebang and node_modules/.bin is not on
PATH. The image now installs an `archon` wrapper, so the documented
invocation is `docker compose exec cli... (continued)

3923 of 4504 branches covered (87.1%)

Branch coverage included in aggregate %.

8555 of 8979 relevant lines covered (95.28%)

715.74 hits per line