hyperhive/docs/web-ui
Repository files (latest commit first)
Filename Latest commit message Latest commit date
atlas 7003d14d2c deploy: split the homeserver's host decisions out of swarm.matrix
`swarm.*` is what a hive needs to be a *client* of the swarm. For the
homeserver that is what it IS from anywhere: its package, the name it
answers to, the ports and URLs it is reached on, and the client id it is
registered under. Whether it is exposed, which peers it trusts, how large
a request it accepts and where its host-local secrets sit are decisions
of the machine running it, so openFirewall, trustedServers,
maxRequestSize, registrationTokenFile, gui.enable and
sso.clientSecretFile move to `deploy.matrix.*`.

Two sub-blocks split rather than moving whole, on their own evidence.
`gui.enable` is whether THIS host serves the web client; `gui.package` is
which client, an artifact identity, and stays. `sso.clientSecretFile` is a
path on one host; `clientId` must match the id in authelia's register, so
it is swarm-wide. Each half now points at the other, because the rendered
docs put them on separate pages.

hive-gateway passed the whole `swarm.matrix` attrset into vhosts.nix, so
that file read a moving option through an argument with no option path
anywhere in it. It now takes `matrixDeployCfg` beside `matrixCfg` — the
only shape that carries a split namespace across that boundary.

While there: vhosts.nix read `matrixCfg.enable`, which has been a rename
alias for `deploy.matrix.enable` since the enable moved. Reading it made
the module system print `Obsolete option services.hyperhive.swarm.matrix.
enable is used` on EVERY evaluation of every host — a deprecation warning
no operator could silence, because the config tripping it was ours. That
shim lives in hive-matrix.nix rather than in this file's table, which is
why deploy.nix's header claim to be their single home is now qualified
in the new block's comment.

glue-matrix-bao-token.nix read the registration token through its own
`matrixCfg` alias; with that read repointed, the binding had no reader
left, so it goes, and the comment naming it is reworded.

module-eval gains a case configuring a hive through all six OLD paths and
asserting two rendered effects — the host firewall's port list and the
container's bind-mount table — because the new paths evaluate fine
without the shims. `gui.enable` is set to the opposite of its default so
the definition has to land rather than agreeing with it by accident.
2026-09-07 14:24:52 +02:00
..
agent.md docs: restructure into topic subdirectories, collapse duplicated index 2026-09-02 01:55:37 +02:00
css-vars.md swarm-ui: derive theme override from colors.css instead of duplicating hex values 2026-08-18 23:58:48 +02:00
dashboard.md deploy: split the homeserver's host decisions out of swarm.matrix 2026-09-07 14:24:52 +02:00
design-guide.md treefmt: apply prettier 2026-09-02 15:25:07 +02:00
README.md treefmt: apply prettier 2026-09-02 15:25:07 +02:00
shape.md docs: restructure into topic subdirectories, collapse duplicated index 2026-09-02 01:55:37 +02:00
terminal-rendering.md agent term: add a setting to hide debug-level output 2026-09-02 20:40:22 +02:00

Dashboard & Web UI

The operator-facing entry point for running a hive day to day. If you want implementation detail — wire formats, DOM structure, event plumbing — see Dashboard layout, Per-agent page, Shape, and CSS theme variables below; this page only covers what you actually do here.

Where things are

Everything starts at the H0M3 hub, served at / — a grid of tiles linking to every surface (Dashboard, Flow, Logs, Builds, Stats, Settings, Core, Credentials). Every page links back to H0M3, so you're never more than one click from the hub.

The dashboard itself (/dashboard.html) is where you'll spend most of your time. It's a single page with exactly four tabs:

  • SW4RM — every agent, live. This is the default tab and the one you'll check most.
  • Y3R C4LL — anything waiting on you: pending approvals. If an agent needs a decision from you, it's here.
  • P3RM1SS10NS — what tools and system-level access each agent has.
  • SCH3DUL3S — scheduled prompts and agent self-reminders.

Everything else lives on its own page instead, all reachable from the H0M3 hub: Flow (/flow.html, the raw live message stream across the whole swarm), Logs (/logs.html, per-agent and host journals), Stats (/stats.html, swarm-wide usage stats), Builds (/builds.html, the rebuild queue and build history), Core (/core.html, tombstones and container resource use), and Credentials (/credentials.html, provisioning matrix/GitHub/forge accounts per agent). Your local browser preferences (notifications) live in the dashboard's Y3R C4LL tab now, not a separate page.

Each agent also has its own page — a full terminal view of that agent's session, reachable by clicking its name anywhere in the dashboard, or directly at /agent/<name>/ (or http://<host>:<port>/ if the gateway isn't in front).

The things you'll actually do

Check on an agent. SW4RM shows every container as a row: name, whether it's running, what it's currently doing (a live status pill — rebuilding…, starting…, and so on — while something's in flight), and quick links (stats, screen, forge profile). Click the name to open its terminal and watch it work in real time.

Approve something an agent is waiting on. Y3R C4LL is the one tab worth checking regularly — it's everything that needs you: approvals for config changes. The tab's count pill tells you at a glance if anything's pending.

Approve or reject a config change. Agent config changes (new packages, env vars, MCP servers) go through an approval queue rather than landing automatically — you'll see them on Y3R C4LL, with a diff of what's changing.

Start, stop, restart, or rebuild an agent. Select one or more agents on SW4RM (click the icon) and use the selection bar, or use the per-agent menu on a single row. Rebuilding re-applies that agent's current config; use it after approving a change, or whenever an agent shows as "needs update."

Watch a build. BU1LDS shows the rebuild queue live, plus a streaming log of whatever's currently building. Useful right after approving a change or bumping a flake input.

Grant or revoke a tool/capability. P3RM1SS10NS is a checkbox matrix — rows are agents, columns are tool groups or capabilities. Nothing takes effect until you hit save all at the bottom of the tab; a save queues a rebuild for whichever agents actually changed.

Read an agent's logs. The Logs page's AGENT tab pulls a live journald view for any agent + service; the per-agent menu's journal logs → link jumps straight there, pre-filtered.

Set up a schedule or check on a reminder. SCH3DUL3S covers both — recurring or one-shot prompts you schedule for one or more agents, and reminders agents have set for themselves.

Provision an account for an agent. The Credentials page covers Matrix, GitHub, and external-forge accounts per agent, without editing that agent's config repo.

More depth

  • Dashboard layout — every tab and standalone page, in full implementation detail: endpoint shapes, event wiring, exact badge-derivation rules.
  • Per-agent page — the per-agent terminal, composer, side panel, slash commands, and per-agent endpoints.
  • Shape (shared by both) — the SPA skeleton, SSE multiplexing, and other plumbing shared across every page.
  • CSS theme variables — the colour system, for anyone touching the frontend's CSS.