1 Commits

Author SHA1 Message Date
bcb633403f Merge pull request 'docs(journey): phase 7 — the installation path and administration' (#10) from feat/phase-7-docs into main
All checks were successful
PR checks / checks (push) Successful in 1m7s
Reviewed-on: #10
2026-08-24 15:24:18 +00:00
2 changed files with 8 additions and 13 deletions

12
PLAN.md
View File

@@ -909,16 +909,12 @@ Hero editor into Branding and theming, Web Bot Activity into Authentication.
it is **missing from website's root `.env.example`**, the file Compose actually reads. It is it is **missing from website's root `.env.example`**, the file Compose actually reads. It is
present in `server/.env.example`, which is the file local development copies, which is why this present in `server/.env.example`, which is the file local development copies, which is why this
has never bitten anyone in dev. The quickstart carries it, declared as an upstream omission so the has never bitten anyone in dev. The quickstart carries it, declared as an upstream omission so the
check fails the day it is fixed — **fixed in website#163**, which also adds `BOT_INTERNAL_KEY` to check fails the day it is fixed.
the README's "set at least" list for the same reason. When that merges, `checkQuickstart` goes red
here by design and the declaration is deleted in a one-line follow-up.
- **The installer points operators at a screen that no longer exists.** It prints - **The installer points operators at a screen that no longer exists.** It prints
`<site>/admin/shard`, and INSTALL.md §5 repeats it. Since the module-system cutover a module owns `<site>/admin/shard`, and INSTALL.md §5 repeats it. Since the module-system cutover a module owns
one path segment, and the screen is **`/admin/uo/link`**, labelled *Shard (uo-link)*. The old path one path segment, and the screen is **`/admin/uo/link`**, labelled *Shard (uo-link)*. Both the
does not even 404 — the SPA sends the operator to the dashboard, so the link looks like it worked binary (`installer` `main:src/sidecar.rs`) and the guide are stale; the journey documents the real
and the four values have nowhere to go. **Fixed in installer#22** (the path is a named constant and path and says the printed one does not resolve.
both handoff tests assert it) **and docs#174**; the journey names the real path and pins the note to
v0.1.0, which is what operators download until the next release.
- **The admin "Restart the server" button opens a `window.confirm`.** Its text is the honest - **The admin "Restart the server" button opens a `window.confirm`.** Its text is the honest
warning that a deployment with no supervisor does not come back — which is exactly why warning that a deployment with no supervisor does not come back — which is exactly why
`restart: unless-stopped` is called out as load-bearing on the install page rather than left as `restart: unless-stopped` is called out as load-bearing on the install page rather than left as

View File

@@ -106,11 +106,10 @@ sidebar — `/admin/uo/link`. Tick *Enable the shard integration*, paste **Base
**WebSocket URL**, **Auth token** and **Protocol**, and save. The ingest client restarts **WebSocket URL**, **Auth token** and **Protocol**, and save. The ingest client restarts
immediately. immediately.
<Aside type="caution" title="Installer v0.1.0 prints an older path for that screen"> <Aside type="caution" title="The installer prints an older path for that screen">
It prints `…/admin/shard`. Since the shard screens became part of the `uo` module — and a It prints `…/admin/shard`. Since the shard screens became part of the `uo` module, a module
module owns one path segment wherever it appears — the screen moved to **`/admin/uo/link`**. owns one path segment and the screen moved to **`/admin/uo/link`**. Use the sidebar, or
The old path does not fail visibly: the site sends you to the dashboard, which looks like the that path; the printed link no longer resolves.
link worked. Use the sidebar, or the path above. Fixed for the next release.
</Aside> </Aside>
The token is encrypted at rest and **never returned to any client** — losing it means The token is encrypted at rest and **never returned to any client** — losing it means