docs: add Docker usage guidance#260
Merged
Merged
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (4)
🚧 Files skipped from review as they are similar to previous changes (4)
📝 WalkthroughWalkthroughDocker installation and usage documentation was added to the README and site, including API, CLI, Compose, and port-remapping examples. Security guidance now documents the unauthenticated API, Docker network binding, required protections, and parser input risks. ChangesDocker documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related issues
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Comment |
hfl0506
marked this pull request as ready for review
July 22, 2026 05:33
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/src/content/docs/installation.mdx`:
- Around line 21-24: Update Docker examples in
docs/src/content/docs/installation.mdx (lines 21-24), README.md (lines 70-71),
and docs/src/content/docs/commands/serve.mdx (lines 33-45) to bind published
port 8080 to 127.0.0.1, preserving any existing host-port mappings such as 7878.
In SECURITY.md (lines 28-31), clarify that non-loopback publishing requires
authentication, TLS, and appropriate access controls.
In `@README.md`:
- Around line 68-73: Separate the Docker and Compose alternatives into distinct
code blocks so the foreground docker run command does not prevent docker compose
up -d from executing. Apply this change in README.md lines 68-73 and
docs/src/content/docs/commands/serve.mdx lines 30-36, preserving both commands
and clearly presenting them as alternatives.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 12928535-4c78-4c93-ae1d-447495090f2a
📒 Files selected for processing (4)
README.mdSECURITY.mddocs/src/content/docs/commands/serve.mdxdocs/src/content/docs/installation.mdx
hfl0506
force-pushed
the
docs/docker-install
branch
from
July 22, 2026 06:41
72bdd0c to
4ab2e4e
Compare
hfl0506
added
documentation
fahimfaisaal
approved these changes
Jul 26, 2026
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
2 participants
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.
Related Issue
Closes #256
Changes
Test Result
/commands/serve
/installation
Summary by CodeRabbit
vizb serveAPI is unauthenticated and should not be exposed publicly without additional security controls.