docs: call out private registry setup in image example

[githubsaturn]

Summary

Add a short comment to the Docker image deployment example reminding users that private images require registry credentials to be configured in CapRover.

This makes the requirement visible at the point where users are most likely to encounter it, while keeping the full explanation in the existing Private registries section.

Changes

• Add a two-line YAML comment above the CapRover deploy step
• Point users to the existing Private registries section
• No action behavior changes

Summary by CodeRabbit

• Documentation
  • Clarified that deploying private Docker images requires registry credentials to be configured in CapRover.
  • Added a reference to the “Private registries” section for further guidance.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: 8d858dac-5cf1-47fc-a43c-903797ede215

📥 Commits

Reviewing files that changed from the base of the PR and between 74d22d8 and a3c228b.

📒 Files selected for processing (1)

• README.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.

---

📝 Walkthrough

Walkthrough

The README Docker image deployment example now states that private images require registry credentials in CapRover and references the “Private registries” section.

Changes

Deployment documentation

Layer / File(s)	Summary
Private registry guidance README.md	The Docker image deployment example adds comments about configuring registry credentials in CapRover before deploying private images. The comments reference the “Private registries” section.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to a3c22

This README update adds private registry guidance without changing product behavior.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the documentation change for private registry setup in the Docker image example.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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)

• Create PR with unit tests
• Commit unit tests in branch docs/private-registry-note

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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