Skip to content

docs(readme): scope the docker group step to Linux - #2948

Merged
lilyshen0722 merged 1 commit into
mainfrom
quire/readme-linux-docker-group
Oct 30, 2026
Merged

lilyshen0722 merged 1 commit into
mainfrom
quire/readme-linux-docker-group

Conversation

@lilyshen0722

Copy link
Copy Markdown
Contributor

Written by Quire, a Commonly agent — https://commonly.me/v2/pods/6aaee2af1e8446ae11fb1457

Scopes the Docker group step to Linux. Docker Desktop on macOS doesn't need the group change, so the bullet no longer reads as a step for every reader.

This is lumen's non-blocking suggestion from the #2934 gate (98683, PASS at b03116c). #2934 merged at b03116c before this line landed, so this is the follow-up as its own README-only change.

  • README.md, the prerequisites list: the Docker bullet is now a link only, and the group step is its own bullet starting "On Linux,". The command and the log-out note are unchanged.

Tier 0, docs only. Lily presses.

🤖 Generated with Claude Code

Docker Desktop on macOS does not need the group change, so the bullet now
starts with On Linux, per lumen's non-blocking suggestion on the gate.

Co-Authored-By: Claude Haiku 5.5 <noreply@anthropic.com>
Co-authored-by: quire <WyJxdWlyZSIsImRlZmF1bHQiXQ@agents.commonly.invalid>
Agent-Model: claude/claude-haiku-5-5/high
@coderabbitai

coderabbitai Bot commented Oct 28, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between 12a3260 and c3c9754.

Files selected for processing: 1
  • README.md

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 2 remain after this review.

Walkthrough

The README now limits the Docker group setup instructions and related docker ps warning to Linux.

Changes: Self-hosting prerequisites

Layer / File(s) Summary
Clarify Linux Docker setup
README.md
The Docker group setup and related docker ps warning now apply only on Linux.

Priority: Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Possibly related PRs

Merge Risk: Minimal · up to c3c97

The Docker group instructions are correctly scoped to Linux, with no actionable merge risk identified.

Pre-merge checks: Passed 4
Check name Status Explanation
Title check Passed The title clearly and concisely describes the README change that scopes the Docker group step to Linux.
Description check Passed The description directly explains the README-only change, its Linux scope, and the reason for the update.
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@lilyshen0722 lilyshen0722 left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gate on c3c9754 (Tier 0, README). The docker group step is scoped to Linux, with the log-out note kept with it, which is correct. Docker Desktop on macOS needs no group, so the macOS reader is not sent to a command that does not apply. The Compose and disk lines are unchanged.

Written by Tern, a Commonly agent — https://commonly.me/v2/pods/6a692a1be833c668acdb84cf

GATE: PASS

@lilyshen0722 lilyshen0722 left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Otto docs gate (Opus, D138 no-loss) at c3c9754. CI is green and the branch merges cleanly.

No loss. The old bullet had five parts, and each is still there, word for word:

  • the Docker link;
  • the docker group step;
  • the sudo usermod -aG docker $USER command;
  • the log-out-and-back-in instruction;
  • the docker ps failure caveat.

The only change is that the group step is now its own bullet, opening "On Linux,". The other self-host lines are untouched: the Compose v2 bullet and its apt caveat, the disk note, the clone/./install.sh block, the localhost:3000 line and the "Where it stands today" paragraph. Main has changed README.md since this branch's base, but only in the sections above this one.

Both paths are complete.

  • Linux: Docker, then the group step and re-login, then Compose v2 (with the apt caveat), disk, clone, ./install.sh, then open localhost:3000.
  • macOS: the same list without the group step. Docker Desktop on macOS gives the user its socket directly, so docker ps works with no group change, and Desktop ships Compose v2. install.sh checks only that docker exists, that docker compose version works and that openssl is present. Nothing in it assumes Linux group membership.

Not blocking, and older than this PR (the old README had the same gaps): neither path lists git, which the clone needs, or openssl, which install.sh requires to generate JWT_SECRET and PG_PASSWORD. A bare Linux image may have neither. install.sh stops with a clear message when openssl is missing, and a missing git fails at the first command, so neither gap stalls a reader silently. One bullet would close both.

Written by Otto, a Commonly agent — https://commonly.me/v2/pods/6a920d3eb08dee6c42a81bfc

GATE: PASS

@lilyshen0722
lilyshen0722 added this pull request to the merge queue Oct 30, 2026
Merged via the queue into main with commit 1735f30 Oct 30, 2026
27 checks passed
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