docs: tighten deployment runbooks
Some checks failed
CI / fmt, clippy, docs (push) Failing after 5s
CI / test (ubuntu-latest) (push) Failing after 5s
CI / test (macos-latest) (push) Has been cancelled
CI / test (windows-latest) (push) Has been cancelled
CI / iroh integration smoke tests (push) Has been cancelled
Security / RustSec cargo-audit (push) Has been cancelled
CodeQL / Analyze Rust (push) Has been cancelled

This commit is contained in:
Eric Wendland 2026-07-11 11:54:50 +02:00
commit 0595b39532
4 changed files with 128 additions and 13 deletions

View file

@ -6,6 +6,48 @@ documents, blobs, pipes, and future multi-user collaboration.
This project is not the Ethereum `geth` client. The project and executable are
still named `geth`.
## First 10 Minutes
Build the single binary, initialize an isolated home, start the daemon, and
verify the local control path:
```sh
cargo build -p geth
export GETH_HOME="$(mktemp -d)"
printf 'GETH_HOME=%s\n' "$GETH_HOME"
./target/debug/geth init
./target/debug/geth daemon run
```
Keep the daemon running. In a second shell, reuse the printed `GETH_HOME` value:
```sh
export GETH_HOME="<same directory>"
./target/debug/geth wait daemon --timeout-ms 30000
./target/debug/geth status --json
./target/debug/geth doctor --json
```
This creates a local-only identity for evaluation. Before enrolling other
machines, use the owner setup in `geth guide owner-setup`; it records an
OpenSSH admin public key as the trust anchor and signs the initial keychain
statements without copying the private key into geth state.
Start with these documents when moving beyond the local smoke test:
- [`docs/architecture.md`](docs/architecture.md): ownership, trust, transport,
and module boundaries.
- [`docs/command-stability.md`](docs/command-stability.md): commands suitable
for automation and commands that remain experimental.
- [`docs/compatibility.md`](docs/compatibility.md): CLI, JSON, protocol, store,
and signed-operation compatibility rules.
- [`docs/automation-examples.md`](docs/automation-examples.md): shell, Python,
and user-service examples.
- [`docs/production-readiness-roadmap.md`](docs/production-readiness-roadmap.md):
the pre-deployment gate and its current status.
- [`docs/dogfood-checklist.md`](docs/dogfood-checklist.md): required
two-machine evidence before broader deployment.
## One Binary
There is one executable: `geth`.
@ -85,7 +127,7 @@ a binary OpenSSH KRL generated through `ssh-keygen -k`. `geth ssh cert sync
`geth ssh revocation sync <node-id>` pull certificate-flow and revocation
metadata from an authorized peer over Iroh.
## MVP Features
## Current Feature Surface
The bootstrap implementation provides: