docs(docker): promote install script to Option 1, reorder install paths#1547
Merged
brunobuddy merged 1 commit intomainfrom Apr 13, 2026
Merged
docs(docker): promote install script to Option 1, reorder install paths#1547brunobuddy merged 1 commit intomainfrom
brunobuddy merged 1 commit intomainfrom
Conversation
Self-hosters skimming DOCKER_README.md hit the first install option they see, so burying the one-command install script at Option 3 was leaving the easiest path on the table. This PR reorders the Installation section to lead with the script and demote the manual paths: - Option 1: Quickstart install script (recommended) — lead with the one-shot bash <(curl ...) command; follow with the review-first flow for audit-minded users. - Option 2: Docker Compose (manual) — unchanged content, relabeled "manual" so the contrast with the script is explicit. Adds an explicit "generate a secret and paste it over the placeholder" step that mirrors what the install script does for you. - Option 3: Docker Run (bring your own PostgreSQL) — unchanged. Also adds a one-line intro under the Installation heading noting that all three paths converge on the setup wizard, and updates the table of contents anchors to match the new headings. No code changes. Full test suite still green locally (backend 181 suites / 3507 tests, frontend 105 files / 2103 tests, backend e2e 15 suites / 107 tests, both tsc clean).
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1547 +/- ##
=======================================
Coverage 97.93% 97.93%
=======================================
Files 118 118
Lines 8581 8581
Branches 3230 3230
=======================================
Hits 8404 8404
Misses 175 175
Partials 2 2
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Self-hosters skimming
docker/DOCKER_README.mdhit the first install option they see, so burying the one-command install script at Option 3 was leaving the easiest path on the table. This PR reorders the Installation section to lead with the script and demote the manual paths.Before
After
bash <(curl -sSL ...)command; follows with the review-first 3-command flow for audit-minded usersAlso adds a one-sentence intro under the Installation heading noting that all three paths converge on the setup wizard, and updates the table of contents anchors to match the new headings.
Follows the pattern used by NocoDB, Supabase, and similar self-hosted tools — the one-liner is the first thing users see, with transparent alternatives listed below.
Test plan
###headings (Option 1/2/3 slugs regenerated)npm test --workspace=packages/backend— 181 suites / 3507 tests passnpm run test:e2e --workspace=packages/backend— 15 suites / 107 tests pass (fresh Postgres DB)npm test --workspace=packages/frontend— 105 files / 2103 tests passnpx tsc --noEmitclean in both backend and frontendSummary by cubic
Promotes the one-command install script to Option 1 (recommended) in the Docker install docs so the fastest path is the first thing users see. Relabels Docker Compose as “manual” Option 2 with an explicit secret-generation step, keeps Docker Run as Option 3, adds a brief intro noting all paths end at the setup wizard, and updates ToC anchors.
Written for commit 9e62c6b. Summary will update on new commits.