Refactor: README.md Docker #2112
Conversation
WalkthroughREADME updates: Docker setup instructions for injecting/overriding proxies.xml were split into Mac/Linux and Windows examples, a remote raw GitHub download (with wget example) was added, volume-mount examples were clarified per OS, and guidance to edit proxies.xml and restart the container was included. The Access section text was slightly reworded. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Suggested reviewers
Poem
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (2)
README.md (2)
180-184: Heading level and punctuation: use H3 and drop trailing colon.Matches MD001/MD026 and keeps hierarchy consistent.
Apply this diff:
- #### For Mac/Linux: + ### For Mac/Linux
190-190: Tighten phrasing.Minor readability tweak.
Apply this diff:
- Now you can change the configuration in `proxies.xml` and restart the container. + You can now edit `proxies.xml` and restart the container to apply the changes.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~171-~171: There might be a mistake here.
Context: ...st:2000). 3. Change the Configuration - Download [proxies.xml](https://raw.githu...
(QB_NEW_EN)
🪛 markdownlint-cli2 (0.17.2)
README.md
180-180: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
180-180: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
185-185: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Analyze (java)
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (3)
README.md (3)
172-176: Raw URL path fix looks good; resolves potential 404.The switch to the standard raw.githubusercontent.com path is correct and mirrors prior feedback.
172-176: Tighten wording and add curl alternative (macOS-friendly).Also improves the “or:” phrasing.
- - Download [proxies.xml](https://raw.githubusercontent.com/membrane/api-gateway/master/distribution/router/conf/proxies.xml) or: + - Download [proxies.xml](https://raw.githubusercontent.com/membrane/api-gateway/master/distribution/router/conf/proxies.xml) or download with wget: @@ - wget https://raw.githubusercontent.com/membrane/api-gateway/master/distribution/router/conf/proxies.xml - ``` + wget https://raw.githubusercontent.com/membrane/api-gateway/master/distribution/router/conf/proxies.xml + # or with curl + curl -L -o proxies.xml https://raw.githubusercontent.com/membrane/api-gateway/master/distribution/router/conf/proxies.xml + ```Optional: consider pinning the URL to a tag or commit for reproducibility.
169-169: Fix grammar and clarity in access instruction.Prefer “preconfigured APIs” to reflect what’s shipped and correct the article.
- Test an API by opening [http://localhost:2000](http://localhost:2000). + Test the preconfigured APIs by opening [http://localhost:2000](http://localhost:2000).
🧹 Nitpick comments (2)
README.md (2)
185-188: Quote Windows path and add PowerShell variant.Prevents failures when the working directory contains spaces and clarifies shells.
**Windows:** ```bash - docker run -v %cd%\proxies.xml:/opt/membrane/conf/proxies.xml -p 2000:2000 predic8/membrane + docker run -v "%cd%\proxies.xml:/opt/membrane/conf/proxies.xml" -p 2000:2000 predic8/membrane ``` + PowerShell: + ```powershell + docker run -v "${PWD}\proxies.xml:/opt/membrane/conf/proxies.xml" -p 2000:2000 predic8/membrane + ```
190-190: Make container restarts easier.Offer a named container tip.
- You can now edit `proxies.xml` and restart the container to apply the changes. + You can now edit `proxies.xml` and restart the container to apply the changes. + + Tip: add `--name membrane` to the `docker run` commands above to restart it easily with `docker restart membrane`.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~171-~171: There might be a mistake here.
Context: ...st:2000). 3. Change the Configuration - Download [proxies.xml](https://raw.githu...
(QB_NEW_EN)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Analyze (java)
🔇 Additional comments (1)
README.md (1)
178-184: Mac/Linux bind mount example LGTM.Quoting $(pwd) is correct and avoids issues with spaces.
2 participants
Summary by CodeRabbit