From 249635430d260686d1a9c8fe7e5f5f238c401d8c Mon Sep 17 00:00:00 2001 From: lexis Date: Fri, 29 May 2026 02:22:16 +0200 Subject: [PATCH] docs: add hyperhive.domain + matrix module to README host config (follow-up to #552) --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 6c618412..9c46ee0f 100644 --- a/README.md +++ b/README.md @@ -88,6 +88,22 @@ system closure. Off by default (the toplevels are pinned to Alternatively warm the store manually: `nix build git+https://forge.darkest.space/hyperhive/hyperhive#agent-base-toplevel`. +Optional: set `hyperhive.domain = "example.com";` to define the +canonical hostname for hyperhive subsystems that need a stable public +name. No default — subsystems that require it (currently: +`hyperhive.matrix`) assert non-null at eval time with a clear error +message if it is missing. + +Optional: set `hyperhive.matrix.enable = true;` to spin up a private +[matrix-tuwunel](https://github.com/girlbossceo/conduwuit) homeserver +in a nixos-container. Requires `hyperhive.domain` to be set first. +The `server_name` (embedded irrevocably in every user and room ID) +defaults to `matrix.`; override with +`hyperhive.matrix.serverName = "chat.example.com";` if needed. State +lives at `/var/lib/nixos-containers/hive-matrix/`. Federation is +enabled with an empty `trusted_servers` list; e2ee is deferred to +a follow-up (#551). + ## Agent configuration Per-agent settings live in each agent's `agent.nix` and are synced to