mara/hyperhive
mara/hyperhive
Watch
0
0
Fork
You've already forked hyperhive
 0
Code Activity
hyperhive/docs
History
Repository files (latest commit first)
Filename Latest commit message Latest commit date
atlas 86c5dac89d swarm-archive: external s3 backend (options, prune path, docs, module-eval cases, vm fake s3) 
- swarm-archive.nix, lib/archive-server.nix: deploy.archive.backend and
  deploy.archive.s3.* options; the s3 server and the prune read the key from the
  store into rclone's environment; the prune lists and addresses repositories
  through rclone instead of a local directory
- swarm-bao.nix: the archive reads swarm/services/archive/s3/*
- docs: archive.md "External S3" section, two credentials-reference rows
- module-eval: builder.nix cases for local and s3, the missing-setting
  assertion; bao-grants.nix gains the s3 read grant
- vm test: second node with a fake rclone serve s3 whose key is generated at
  test time
2026-11-11 00:13:19 +01:00
..
1-getting-started add a semi-spread example deploy and a check that evaluates it 2026-11-10 17:33:58 +01:00
2-handbook swarm-archive: external s3 backend (options, prune path, docs, module-eval cases, vm fake s3) 2026-11-11 00:13:19 +01:00
4-implementation docs: the swarm and services pages become overviews 2026-11-11 00:12:06 +01:00
5-project drop the host side of the agent broker send 2026-11-08 08:56:39 +01:00
examples/semi-spread semi-spread example: serve internal vhosts on the VPN addresses only, over IPv4 and IPv6 2026-11-10 17:33:58 +01:00
README.md docs: the swarm and services pages become overviews 2026-11-11 00:12:06 +01:00

README.md

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 hyperhive, in the three layers that make it up, plus the accounts an agent can hold outside it. Some pages here still carry implementation detail next to the operator content; sorting those out is later work.

Swarm

The services that exist once per swarm. Start at 2-handbook/swarm/.

Hives

The host a hive runs on and the operator's tools for it. Start at 2-handbook/hives/.

Agents

One agent: its roster entry, state, config and page. Start at 2-handbook/agents/.

External accounts

Accounts outside the swarm that an agent can hold. Start at 2-handbook/external-accounts/.

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

Agent tools

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.