Skip to content

First run: the console's Set up your server flow (F1) - #156

Merged
KodeStar merged 7 commits into
mainfrom
feat/first-run-f1
Oct 21, 2026
Merged

KodeStar merged 7 commits into
mainfrom
feat/first-run-f1

Conversation

@KodeStar

Copy link
Copy Markdown
Owner

This documents first-run setup Phase F1 (KodeStar/audiosilo-server#162, merged): the console's "Set up your server" flow.

  • User Guide: First run now leads with the flow. Each of the 8 steps gets a section and a screenshot, then the Overview "Finish setting up" card. The printed banner and --setup are kept as the way the admin account is made, and --setup now asks for the account only. The Docker, Unraid and binary install pages and the console tour now point at the flow.
  • Developer:
    • web-ui.md: the /setup handover and a new "The first-run setup flow" section.
    • configuration.md: --setup and how config-declared libraries show.
    • API reference: GET/PUT /admin/setup and POST /admin/setup/preview, plus the POST /setup changes and the error codes.
    • data-model.md: setup_state and migration 0053, plus the audit action.
  • Screenshots:
    • The new screenshots/capture-setup.mjs builds a books folder whose tags and folder names disagree.
    • capture-admin.mjs marks the demo servers as set up first, so the admin shots don't land on the flow.
    • 11 shots were added or recaptured.

The docs build passes. The branch had /simplify and /code-review high --fix. The screenshots were captured before the review's refactor of the capture scripts, and the pipeline wasn't re-run after it (syntax-checked only).

Pairs with KodeStar/audiosilo-server#162.

capture-setup.mjs drives the --setup server: the account page, its hand-over,
then the console's eight setup steps and the Overview's Finish setting up card,
on a generated books folder whose tags and folder names disagree.
capture-admin.mjs marks its servers set up so the flow never takes its shots.
The admin account still comes from the printed banner or --setup, whose page
now asks only for the account and hands over. Each of the eight steps gets a
section and a screenshot, plus the Overview's Finish setting up card; the
quickstarts point their library step at the flow.
The /setup page asks only for the account (old library fields still
accepted, marking the folder step done), the console flow and its Overview
card in web-ui.md, GET/PUT /admin/setup and POST /admin/setup/preview in the
reference, invalid_setup_step, the setup_state key and migration 0053, the
settings.setup audit action, --setup in configuration.md, and the mapping row.
# Conflicts:
#	docs-developers/server/auth-and-security.md
#	docs-users/getting-started/first-run.md
@KodeStar
KodeStar merged commit 348db6b into main Oct 21, 2026
1 check passed
@KodeStar
KodeStar deleted the feat/first-run-f1 branch October 21, 2026 21:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant