summaryrefslogtreecommitdiffstats
path: root/docs/dashboard.md
diff options
context:
space:
mode:
authortv <tv@krebsco.de>2026-11-18 12:48:29 +0000
committertv <tv@krebsco.de>2026-11-18 13:59:42 +0100
commitd130c0612b4c63f2d30da65ebcc231018c1f2606 (patch)
tree8700f2d53351cbbecbe772ea7701bf6240d5210c /docs/dashboard.md
parent0bfe07af92a775b0e896e0fc5a989a1d9b65f7b3 (diff)
docs: references to another document's section linked to it
Where a document names a section of another after linking to it ("([`store.md`](store.md), Pinned checkpoints)"), the name links to that section too, by the id both GitHub and cgit's about filter give its heading; paragraphs that grew past the width are wrapped anew, links and code kept on one line each.
Diffstat (limited to 'docs/dashboard.md')
-rw-r--r--docs/dashboard.md88
1 files changed, 46 insertions, 42 deletions
diff --git a/docs/dashboard.md b/docs/dashboard.md
index d11bf3c..009ac03 100644
--- a/docs/dashboard.md
+++ b/docs/dashboard.md
@@ -21,36 +21,39 @@ session) goes to at once without one. There, a user logs in with its password
(`--htpasswd`, the same file the API's basic authentication takes, which the dashboard
never asks for itself, nor takes from the browser: no browser password prompt, the
node never challenges a browser), or with a token: from `continuum-signed login` (by key,
-[`access.md`](access.md), Tokens), or any other. The page keeps a session for the
-browser, a cookie no script reads and no other site's page sends, renewed while the
-dashboard is open (half way through the token's life, looked at again when the page
-shows, so after the computer slept too) until the login ends (`--session-lifetime`),
-then back to the login page; it ends with the token's lifetime once not renewed, or
-with "Log out of this browser" on the login page, or "log out" in the user's menu on the dashboard (its
-name, top right), which ends this browser's session only: the page stops reading
-and goes to the login page, and brought back by the browser's back button it loads
-again, so it shows nothing from before. Where the page got in by
-what it can't end, the proxy's, "log out" is greyed, and says how instead. The menu's "credentials…" shows the user's keys, each by its name
-and as much of the key as fits the dialog, cut in the middle where it doesn't (its end
-and comment always shown, the whole in its tooltip), and `edit` at the right: its name
-and `.pub` line in fields, to save, or to delete with the red `Delete` (on a second
-click from half a second to 3 s after the first, as in the document box; the last key
-only where the user has a password on this node, which it logs in by then); or one
-added below; what fails says why where it was asked, to be set right and tried again. Under a
-strict policy, it says how to sign them anew (`continuum-signed key-add`); and where
-the password is: in each node's `--htpasswd`. The page and the login page run their
-own script only (a content security policy naming it by its hash), and no other page
-may frame them. The API listens on localhost unless `--bind-addr` says otherwise;
-to look at a node on another machine, forward the port (`ssh -L 3000:localhost:3000
-<machine>`) or put a TLS proxy in front ([`operations.md`](operations.md), Behind a reverse proxy).
+[`access.md`](access.md), [Tokens](access.md#tokens)), or any other. The page keeps a
+session for the browser, a cookie no script reads and no other site's page sends, renewed
+while the dashboard is open (half way through the token's life, looked at again when the
+page shows, so after the computer slept too) until the login ends (`--session-lifetime`),
+then back to the login page; it ends with the token's lifetime once not renewed, or with
+"Log out of this browser" on the login page, or "log out" in the user's menu on the
+dashboard (its name, top right), which ends this browser's session only: the page stops
+reading and goes to the login page, and brought back by the browser's back button it loads
+again, so it shows nothing from before. Where the page got in by what it can't end, the
+proxy's, "log out" is greyed, and says how instead. The menu's "credentials…" shows the
+user's keys, each by its name and as much of the key as fits the dialog, cut in the middle
+where it doesn't (its end and comment always shown, the whole in its tooltip), and `edit`
+at the right: its name and `.pub` line in fields, to save, or to delete with the red
+`Delete` (on a second click from half a second to 3 s after the first, as in the document
+box; the last key only where the user has a password on this node, which it logs in by
+then); or one added below; what fails says why where it was asked, to be set right and
+tried again. Under a strict policy, it says how to sign them anew
+(`continuum-signed key-add`); and where the password is: in each node's `--htpasswd`. The
+page and the login page run their own script only (a content security policy naming it by
+its hash), and no other page may frame them. The API listens on localhost unless
+`--bind-addr` says otherwise; to look at a node on another machine, forward the port
+(`ssh -L 3000:localhost:3000 <machine>`) or put a TLS proxy in front
+([`operations.md`](operations.md),
+[Behind a reverse proxy](operations.md#behind-a-reverse-proxy)).
Every node has its own dashboard, and shows the swarm as that node sees it: what it
knows of the others, what they report to it, and its own figures.
## The page
-At the top, the node's alias and node ID; in orange, when this node's clock is off
-from its peers' ([`measurements.md`](measurements.md), Clocks), by how much; and the connection's status:
+At the top, the node's alias and node ID; in orange, when this node's clock is off from
+its peers' ([`measurements.md`](measurements.md), [Clocks](measurements.md#clocks)), by
+how much; and the connection's status:
| Status | Meaning |
|---|---|
@@ -247,14 +250,14 @@ measured.
* **Double-click a node**: subscribe to its links, or no longer. The page then reads
the node's own links from it, live, as it measures them (its
`/admin/dashboard/links/own/events`, at the dashboard it publishes,
- `--dashboard-url`), with a token from this node that lets it read the member list
- only ([`access.md`](access.md), Tokens); its links are drawn as it reports them, over what
- this node knows of them. The browser must reach that dashboard: not one behind NAT, on
- Tor alone, or plain `http` from an `https` page; the node allows this page's origin
- as a member's dashboard (`--cors-origins` for others). Subscriptions are kept in the
- browser, and handed over with the rest; going to another node's dashboard, the node
- left is subscribed to there (this node itself never is: its links and messages are
- the page's own).
+ `--dashboard-url`), with a token from this node that lets it read the member list only
+ ([`access.md`](access.md), [Tokens](access.md#tokens)); its links are drawn as it
+ reports them, over what this node knows of them. The browser must reach that dashboard:
+ not one behind NAT, on Tor alone, or plain `http` from an `https` page; the node allows
+ this page's origin as a member's dashboard (`--cors-origins` for others). Subscriptions
+ are kept in the browser, and handed over with the rest; going to another node's
+ dashboard, the node left is subscribed to there (this node itself never is: its links
+ and messages are the page's own).
* **Right-click a node**: its menu: subscribing to its links (or not), and `go to its
dashboard`, greyed where the node publishes none, and on this node's own.
* **Go to a node's dashboard** (its menu): in this page, where the node publishes one
@@ -322,7 +325,7 @@ them: no HELLOs, keepalives or syncing of its own; their tooltip says so), with:
| via | The address this node sends to it at, and whether `direct` or `relayed`: as much as the box's width leaves, cut short with an ellipsis; all of it in the tooltip. |
| rtt | The round trip on that path. |
| hop | How long its sync and blob messages take to come, by its clock and this node's, its clock offset taken off (`hopDelay` in [`measurements.md`](measurements.md)): this minute's mean, then the last 15 minutes' means as bars, oldest first (a minute without messages blank). Good to half the round trip, but the trend exactly: bars growing mean the link, or a queue on it, gets slower. All figures in the tooltip. |
-| clock | How far its clock is ahead of this node's (behind: `−`), give or take (in the tooltip); in orange beyond `--clock-skew-warn`, for sure ([`measurements.md`](measurements.md), Clocks). |
+| clock | How far its clock is ahead of this node's (behind: `−`), give or take (in the tooltip); in orange beyond `--clock-skew-warn`, for sure ([`measurements.md`](measurements.md), [Clocks](measurements.md#clocks)). |
| reaches | How many members besides this node it reaches, as it said ([`peers.md`](peers.md)); `(+n)`: of those, how many this node doesn't reach itself, which it is a way to. By name in the tooltip, those marked `+`. Blank until it said so in this session. |
| epoch | The epoch it last said it is on, by its generation ([`remakes.md`](remakes.md)); orange where it isn't this node's (they don't sync then); its ID in the tooltip; blank while unknown. |
@@ -434,10 +437,11 @@ they come (a tenth of a second after the first of a moment's), and are listed in
order they went, as the map runs them: each by when its node logged it, on this node's
clock (a subscribed node's taken back by how far its clock is ahead, as the map chains
the clocks; its own clock's time in the tooltip of the time), so one a slower stream
-brought late goes in among those of its moment, not at the bottom. The PINGs the paths layer sends on its own, and the PONGs it answers
-PINGs with, are listed too: under the node at the address they went to, where it is
-known, else under the address. Not listed: WHO and ME, which stay in the layers
-below the node (they are counted, [`measurements.md`](measurements.md), Traffic).
+brought late goes in among those of its moment, not at the bottom. The PINGs the paths
+layer sends on its own, and the PONGs it answers PINGs with, are listed too: under the
+node at the address they went to, where it is known, else under the address. Not listed:
+WHO and ME, which stay in the layers below the node (they are counted,
+[`measurements.md`](measurements.md), [Traffic](measurements.md#traffic)).
A subscribed node's messages with its peers are listed too, as they come from it:
named by both ends, the receiver first (`b ← a`), each once, as on the map (those
@@ -530,17 +534,17 @@ it reads from each node itself: `GET /admin/dashboard/links/own/events` there, a
transport, relayed, dormant, or a round trip moved by a fifth; it looks every 2 s) or
it enters a new epoch, with the epoch it is in. The page asks with a token from this
node that reads the member list only (`Authorization: Bearer`, [`access.md`](access.md),
-Tokens), refreshed half way through its life; the other node allows the page's origin
-by CORS where it is a member's dashboard (`--cors-origins` for others). A stream that
-fails is opened again, waiting longer each time (up to a minute).
+[Tokens](access.md#tokens)), refreshed half way through its life; the other node allows
+the page's origin by CORS where it is a member's dashboard (`--cors-origins` for others).
+A stream that fails is opened again, waiting longer each time (up to a minute).
The links a member reports: its neighbours and the peers it holds dormant (a neighbour
that goes dormant is one no more, but stays listed until it is heard from again), by
which transport, whether only through a relay, the round trip (as the paths layer
measures it), whether it holds the peer dormant or the path is down, the peer's other
transports with a path up (each with its fastest path's round trip, and whether it goes
-only through a relay), and the peer's clock against the member's ([`measurements.md`](measurements.md),
-Per peer, `clock`).
+only through a relay), and the peer's clock against the member's
+([`measurements.md`](measurements.md), [Per peer](measurements.md#per-peer), `clock`).
**Clocks.** The clocks in the links on the map (this node's and the subscribed nodes')
chain every member's clock to this node's, along the narrowest bounds, and the page