docs/README.md

Ref: Size: 1.8 KiB History
# eitri docs

By what you're trying to do:

**Understand it**

- [architecture.md](architecture.md)—the architectural invariants and the
  executable governance that enforces them
- [ethos.md](ethos.md)—the design principles; what to fall back on when a
  debate stalls
- [shape.html](shape.html)—the generated, explorable package graph
  (`make shape` regenerates)

**Run a fleet**

- [quickstart.md](quickstart.md)—from nothing to a VM you can SSH into, on
  the hosted plane
- [self-hosting.md](self-hosting.md)—running the whole control plane yourself
- [byo-idp.md](byo-idp.md)—signing the console in against your own OIDC
  provider instead of the bundled issuer
- [cert-rotation.md](cert-rotation.md)—rotating the server's QUIC identity,
  and why expiry is never an emergency
- [credential-revocation.md](credential-revocation.md)—leaked host
  credentials, leaked SSH certs, and the disaster levers
- [upgrade.md](upgrade.md)—upgrading agents from the console, the server,
  and cloud-hypervisor
- [releases.md](releases.md)—what shipped in each version, and where the
  tarballs live

**Use a fleet**

- [joining.md](joining.md)—putting a machine into the fleet, Linux or Mac
- [connecting.md](connecting.md)—reaching a guest through the jump gate with
  your own tenant CA
- [networking.md](networking.md)—published ports, and a guest on your own LAN
- [volumes.md](volumes.md)—durable block storage a guest keeps past its VM
- [mcp.md](mcp.md)—`/mcp`, the endpoint that lets Claude drive VMs
- [faq.md](faq.md)—guest networking, and the other sharp edges

**Why it's this way**

- [decisions.md](decisions.md)—the settled decisions, the alternatives they
  beat, and the reasons
- [assumptions.md](assumptions.md)—what those decisions rest on, and which
  claims are proven versus still taken on trust