mara/hyperhive
mara/hyperhive
Watch
0
0
Fork
You've already forked hyperhive
 0
Code Activity
hyperhive/docs/README.md
iris 30a8f71bb5 docs: the trust-boundary pages keep the operator guidance, the mechanism moves to implementation 
boundary.md keeps the model, the design rule, why network isolation
matters and host admin socket access; the hive-priv socket activation and
the per-agent socket directory move to 4-implementation/trust-boundary.
security.md keeps the agent trust model and the path-name rule; the nix
builds mode with its threat model, and the hive-c0re privilege separation,
move to their own pages there. Headings and text move as they were, with
one level shaved off the heading depth. Links, code and nix pointers, and
the docs index follow the moves.
2026-11-06 19:45:11 +01:00

10 KiB
Raw Blame History

hyperhive docs

Depth reference for hyperhive — the substrate, not the pitch (that's the top-level README / website). Every page here stands alone; pick the one matching your task rather than reading top to bottom. The docs sit in five sections, by what the reader wants:

  1. Getting started: what hyperhive is, and how to bring one up.
  2. Handbook: running and using a hive and a swarm.
  3. Options reference: every NixOS option.
  4. Implementation: how it works inside.
  5. Project: how the project itself works.

1. Getting started

2. Handbook

Using and operating the hive and the swarm. Some pages here still carry implementation detail next to the operator content; sorting those out is later work.

Web UI and tools

Agent lifecycle

Trust boundary and security

Accounts and integrations

Swarm

3. Options reference

The autogenerated NixOS options reference (every services.hyperhive.* / hyperhive.* option, host and agent) lives on the website, built from the module declarations: the options site. Nothing of it sits in this tree.

4. Implementation

Turn loop, scheduler, CI, observability

Networking

Swarm services

Trust boundary mechanics

Web UI internals

Crate reference

  • What does a specific Rust crate do, on its own terms? → 4-implementation/crates/ — every workspace crate's own README.md, one level up from source; the crate itself is still the source of truth, this is just a walkable mirror.

5. Project

How the project itself works: processes, conventions, design guides.