Add proxy configuration instructions - #180
Conversation
Add instructions for running behind a proxy in README.
WalkthroughA new "Behind a Proxy" section is added to README.md documenting proxy environment variable configuration and ChangesProxy Configuration Documentation
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. 👉 Get your free trial and get 200 agent minutes per Slack user (a $50 value). 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. Review rate limit: 7/8 reviews remaining, refill in 7 minutes and 30 seconds.Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 81-82: Edit the README wording in the proxy instructions to fix
two typos: change "setup correctly" to "set up correctly" and change "run the
this action" to "run this action" so the sentence reads clearly when referring
to HTTPS_PROXY/http_proxy and the NODE_USE_ENV_PROXY=1 environment variable;
update the two phrases in the sentence that currently contains "HTTPS_PROXY or
`https_proxy` or `HTTP_PROXY` or `http_proxy` are setup correctly. Then run the
this action" to the corrected wording.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 81-82: Add a comma after the word "proxy" in the sentence starting
"If you are running this behind a proxy" so it reads "If you are running this
behind a proxy, make sure your `HTTPS_PROXY` or `https_proxy` or `HTTP_PROXY` or
`http_proxy` are set up correctly." This is the sentence that mentions the
environment variables (`HTTPS_PROXY`, `https_proxy`, `HTTP_PROXY`, `http_proxy`)
and the `NODE_USE_ENV_PROXY=1` instruction.
- Around line 81-91: Clarify which proxy environment variables to set by
updating the README text around the proxy section: explain that most CI systems
and tooling expect the uppercase variants (HTTPS_PROXY, HTTP_PROXY) but some
shells/clients use lowercase (https_proxy, http_proxy), and recommend setting
both or at minimum the uppercase ones; also note to keep NODE_USE_ENV_PROXY=1
when running behind a proxy and update the example to either show both
HTTPS_PROXY and http_proxy or add a short parenthetical stating “uppercase
preferred; set lowercase if your environment requires it” so users aren’t
confused by the single-example using only HTTPS_PROXY.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
|
can we please merge this ! |
Add instructions for running behind a proxy in README.