Repository navigation
docs: make Aspire the recommended server setup path - #889
withinfocus wants to merge 3 commits into
Conversation
🤖 Bitwarden Claude Code ReviewOverall Assessment: APPROVE This docs-only PR makes Aspire the recommended local server setup. It moves the Docker Compose, Azurite bootstrap, database creation, build and debugging steps to a new |
eliykat
left a comment
There was a problem hiding this comment.
Excited to see Aspire become our official recommendation for DX.
eliykat
left a comment
There was a problem hiding this comment.
LGTM! Thank you for updating the docs.
🎟️ Tracking
Follows bitwarden/server#6775, which added the Aspire
AppHost, and its follow-ups: bitwarden/server#7646, bitwarden/server#7670, bitwarden/server#7731, bitwarden/server#7803, bitwarden/server#8082 and bitwarden/server#8319.📔 Objective
The server setup guides only described the manual setup: start Docker Compose, run the helper scripts, then launch each service yourself. This PR documents Aspire as the recommended way to run the server locally and keeps the manual setup as the alternative.
Setup Guide
Azmodule, trusting the dev certificate, theDatabase:Passworduser secret, starting the AppHost, the dashboard, resources you start by hand, and common settings.manual-setup.md), so the Setup Guide only covers Aspire. SQL Server, Mailcatcher, Redis and Azurite moved to a shared "Local services" section.#mailcatcherand#azuritestill resolve on the Setup Guide, and the link to#create-databasenow points at the Manual Setup page.setup_secrets.ps1 -clearon every start, so the guide tells readers to put changes indev/secrets.jsonrather than on individual projects.Other pages
SelfHostandDatabase:SelfHostPassword.Parameters:sso-org-iduser secret instead of.env.Broken anchors
The build flagged
#install-licensing-certificateon the Setup Guide and#authorizationon the Portal page. Both headings sat inside<Bitwarden>blocks, and SSR renders community mode, so the table of contents linked to headings that weren't in the HTML. The licensing certificate is now a Bitwarden-only part of the user secrets step. The Authorization heading moved outside the block, with a short<Community>note.🤖 AI-assisted review
code-review-local). It raised one IMPORTANT finding, a wrongcdpath in the Aspire setup steps, which is fixed. No findings were deferred.AppHost/anddev/on servermain, and the AppHost builds there. It wasn't run end to end, because thesetup-secretsresource clears the local per-project user secrets on start.