fix(docs): clear the quickstart drift the upstream fixes caused
All checks were successful
PR checks / checks (pull_request) Successful in 1m1s

The three defects phase 7 found are fixed and merged: website#163
(SECRET_ENC_KEY missing from the root .env.example, plus BOT_INTERNAL_KEY in
the README's "set at least" list) and installer#22 + docs#174 (the handoff
printing /admin/shard).

website#163 turned checkQuickstart red here, which is precisely what the
declaration was built to do -- it fails the moment a declared key appears
upstream, so the note describing the omission cannot outlive the defect. The
SECRET_ENC_KEY entry is deleted and notInUpstreamEnvExample is now empty; the
export stays so the next divergence gets an entry rather than passing quietly.

The stale-path Aside on Connect a game server is pinned to v0.1.0 rather than
calling the installer permanently wrong, and now says WHY the old path is worse
than a 404: the SPA has no route for it, so it redirects to the dashboard and
the link looks like it worked.

v0.1.0 is still the current download, and not only because releases lag. The
release run for installer#22 built every artifact and pushed tag v0.1.1, then
took a 500 creating the release -- so the tag is orphaned and no binaries were
published. Raised on installer; nothing is worked around here.

This also recovers 084ee0b, which was pushed to feat/phase-7-docs after PR #10
had already merged f499f2b, and so never reached main.

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
2026-08-24 11:39:36 -05:00
parent bcb633403f
commit a993b872ac
3 changed files with 32 additions and 21 deletions

View File

@@ -106,10 +106,15 @@ sidebar — `/admin/uo/link`. Tick *Enable the shard integration*, paste **Base
**WebSocket URL**, **Auth token** and **Protocol**, and save. The ingest client restarts
immediately.
<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, a module
owns one path segment and the screen moved to **`/admin/uo/link`**. Use the sidebar, or
that path; the printed link no longer resolves.
<Aside type="caution" title="Installer v0.1.0 prints an older path for that screen">
It prints `…/admin/shard`. Since the shard screens became part of the `uo` module — and a
module owns one path segment wherever it appears — the screen moved to **`/admin/uo/link`**.
The old path does not fail visibly: the site has no route for it, so it sends you to the
dashboard, and that looks like the link worked. The four values you were just told to paste
then have nowhere to go. Use the sidebar, or the path above.
Corrected in the installer's `main`; v0.1.0 is still the current download.
</Aside>
The token is encrypted at rest and **never returned to any client** — losing it means

View File

@@ -110,22 +110,21 @@ export const env = [
];
/**
* `SECRET_ENC_KEY` is in this quickstart and NOT in upstream's `.env.example`, which is why
* it needs a declaration rather than passing quietly.
* Keys this quickstart sets that upstream's `.env.example` does not, each with the reason.
*
* Found by booting this exact file against the published image (phase 7): the server calls
* `resolveKey()` in `utils/secretBox.js` at require time and throws
* `SECRET_ENC_KEY must be set in production`, so the container crash-loops before it ever
* listens. It is documented in `server/.env.example` — the file local development copies —
* and missing from the root `.env.example` that Compose actually reads.
* **Empty, and that is the point.** Its one entry was `SECRET_ENC_KEY`: phase 7 booted this
* exact file against the published image and the container crash-looped before it ever
* listened, because `resolveKey()` in `utils/secretBox.js` throws
* `SECRET_ENC_KEY must be set in production` at require time. The variable was documented in
* `server/.env.example` — the file local development copies — and missing from the root
* `.env.example` that Compose actually reads.
*
* The check treats the omission as upstream's bug, not as licence: it fails the moment the
* variable appears in `.env.example`, so this note cannot outlive the defect it describes.
* The declaration was written so it could not outlive the defect: the check fails the moment
* a declared key appears upstream. website#163 fixed `.env.example`, this repo went red on
* the next run, and the entry was deleted. Keep the export — the next divergence gets an
* entry here rather than passing quietly.
*/
export const notInUpstreamEnvExample = {
SECRET_ENC_KEY:
"the app refuses to start in production without it (utils/secretBox.js), but website's root .env.example does not list it",
};
export const notInUpstreamEnvExample = {};
/**
* Variables upstream's `.env.example` carries that the quickstart leaves out, each with the