From 53d2e5cfeb09763683071b57494b4e81a92ac1db Mon Sep 17 00:00:00 2001 From: Ahmed Allam Date: Wed, 2 Sep 2026 14:34:33 +0000 Subject: [PATCH] docs: note viewer steering, history, and report prerequisites --- README.md | 2 +- docs/usage/viewer.mdx | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 77c5e0ae..4facdb50 100644 --- a/README.md +++ b/README.md @@ -172,7 +172,7 @@ strix view my-run-name strix view --host 0.0.0.0 --port 8080 --no-open ``` -The dashboard shows the findings, a live map of the agent team, and past runs, and it can steer a running scan. Nothing leaves your machine, and the UI ships prebuilt. `strix view` binds to `127.0.0.1` and prints a tokened link that grants access to the run, so share it carefully. +The dashboard shows the findings, a live map of the agent team, and past runs. Nothing leaves your machine, and the UI ships prebuilt. `strix view` binds to `127.0.0.1` and prints a tokened link that grants access to the run, so share it carefully. See the [viewer documentation](https://docs.strix.ai/usage/viewer) for the options and for reaching the viewer from another machine. diff --git a/docs/usage/viewer.mdx b/docs/usage/viewer.mdx index 147bbd0d..01f42c57 100644 --- a/docs/usage/viewer.mdx +++ b/docs/usage/viewer.mdx @@ -36,14 +36,14 @@ The UI ships prebuilt with Strix, so there is no extra install and no JavaScript - **Overview** — run status, target, and a severity breakdown of everything found so far. - **Vulnerabilities** — each validated finding with its severity, details, and reproduction steps. - **Agent graph** — a live map of the multi-agent team, and what each agent is doing. -- **Steering** — send instructions to a live scan to redirect the agents during the run. -- **History** — browse past runs on this machine and move between them. -- **Reports** — generate a shareable report and send it by email. +- **Steering** — send instructions to a live scan to redirect the agents during the run. Steering works only in the dashboard the running scan opens. A standalone `strix view` has no live scan to steer. +- **History** — browse past runs on this machine and move between them. Verify your email address in the dashboard to unlock the other runs. +- **Reports** — generate a shareable report and send it by email. Verify your email address first. ## Sharing The Link - The token in the printed URL grants access to the run data, the history, and the steering of a live scan. Share it only with trusted users. + The token in the printed URL grants access to the run data, and to the steering of a live scan. Share it only with trusted users. To reach the viewer from another machine, start it with `--host 0.0.0.0` and replace `0.0.0.0` in the printed URL with a reachable IP address or hostname. Restrict the port with your firewall. A request without the token-derived session cannot read run data.