Watch
0
0
Fork
You've already forked hyperhive
0

docs: sort the top-level directories into five sections by what the reader wants

Every docs directory moves under 1-getting-started, 2-handbook,
4-implementation or 5-project; the options reference (section 3) comes from
the website and has no directory here. trust-boundary stays whole under the
handbook for now. web-ui, swarm and tools split between handbook and
implementation, and the command-line references move to
2-handbook/reference. Links, path references in code and nix, and the docs
index follow the moves; no page content changes.
This commit is contained in:
iris 2026-11-06 18:30:12 +01:00 • committed by mara
commit 6739bb903d
3 changed files with 736 additions and 701 deletions

View file

@ -5,7 +5,7 @@
# answers on the hive bridge, so neither can be confined to a network
# namespace of its own.
# Full vhost map + discovery flow + design rationale in
# `docs/networking/gateway.md`. Layout: ./options.nix (option declarations),
# `docs/4-implementation/networking/gateway.md`. Layout: ./options.nix (option declarations),
# ./vhosts.nix (the catch-all `_` vhost), ./declared-vhosts.nix
# (renders the vhosts service modules declare under `gateway.vhosts`), ./error-pages.nix
# (styled static pages), ./dns.nix + ./dnsmasq.nix (the resolver, which
@ -241,7 +241,7 @@ in
# and it puts a file at every cert path the config names or fails: one
# nginx cannot find takes the WHOLE gateway down, not one vhost. Both
# mechanisms, and what it cost the time this was
# collapsed: `docs/networking/gateway.md::Self-signed TLS (default)`.
# collapsed: `docs/4-implementation/networking/gateway.md::Self-signed TLS (default)`.
#
# ALWAYS runs (no ConditionPathExists) and is idempotent, because it
# has to reconcile broken state from earlier failed boots — a 0700 dir
@ -350,7 +350,7 @@ in
# through hive-priv after each agents.conf write, deliberately as an
# explicit trigger rather than a path unit. Why, and what hive-priv
# dispatches per unit state:
# `docs/networking/gateway.md::Per-agent unix-socket upstream`.
# `docs/4-implementation/networking/gateway.md::Per-agent unix-socket upstream`.
services.nginx = {
enable = true;
@ -414,7 +414,7 @@ in
};
# `/etc/hosts` entries for local dev — the bare hive domain plus
# every name a service module contributed. See `docs/networking/gateway.md`
# every name a service module contributed. See `docs/4-implementation/networking/gateway.md`
# ("Local dev").
#
# This does not restate the per-service list (the vhosts and the

View file

@ -1,7 +1,7 @@
# Static error/help pages the gateway serves for routes it has
# special-cased, all rendered from one Catppuccin-styled template.
# Useful pages instead of nginx's default 404/502 — see
# `docs/networking/gateway.md::Per-agent error pages` for the design rationale +
# `docs/4-implementation/networking/gateway.md::Per-agent error pages` for the design rationale +
# page-vs-status semantics. Published as `gateway.lib.errorPages`.
{ pkgs }:
let

View file

@ -51,7 +51,7 @@ in
# The gateway always terminates TLS: self-signed is the implicit
# floor when neither `tls.certDir` nor ACME is set, so there is no
# http-only mode. Listen addresses every vhost shares — plain http
# on `cfg.port` plus TLS on `cfg.httpsPort`. See `docs/networking/gateway.md`
# on `cfg.port` plus TLS on `cfg.httpsPort`. See `docs/4-implementation/networking/gateway.md`
# ("TLS modes").
listen = [
{
@ -90,7 +90,7 @@ in
# — invisibly, it works and keeps working against any certificate at
# all. Full reasoning for every directive here (plus two real
# footguns — session-cache keying, and a `Host`-header clobber that
# can recurse a subrequest into itself) is in docs/networking/gateway.md's
# can recurse a subrequest into itself) is in docs/4-implementation/networking/gateway.md's
# "Dialing another vhost by name" section — read it before touching
# this.
verifiedProxyTo = name: ''