Skip to content

Add proxy configuration instructions - #180

Open
wasabbe wants to merge 2 commits into
oven-sh:mainfrom
wasabbe:main
Open

Add proxy configuration instructions#180
wasabbe wants to merge 2 commits into
oven-sh:mainfrom
wasabbe:main

Conversation

@wasabbe

@wasabbe wasabbe commented May 2, 2026

Copy link
Copy Markdown

Add instructions for running behind a proxy in README.

Add instructions for running behind a proxy in README.
@coderabbitai

coderabbitai Bot commented May 2, 2026

Copy link
Copy Markdown

Walkthrough

A new "Behind a Proxy" section is added to README.md documenting proxy environment variable configuration and NODE_USE_ENV_PROXY=1 usage for running the action behind a proxy, including an example GitHub Actions step.

Changes

Proxy Configuration Documentation

Layer / File(s) Summary
Documentation
README.md
New "Behind a Proxy" section documents proxy environment variables (HTTPS_PROXY, HTTP_PROXY, and lowercase variants) and NODE_USE_ENV_PROXY=1 usage with an example GitHub Actions workflow step.
🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately and concisely describes the main change—adding proxy configuration instructions to the README.
Description check ✅ Passed The description is directly related to the changeset, clearly stating that proxy setup instructions are being added to the README.
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.

✏️ 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.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

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.

❤️ Share
Review rate limit: 7/8 reviews remaining, refill in 7 minutes and 30 seconds.

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 36ae3542-244c-4bd9-b603-b4c37e6fd17b

📥 Commits

Reviewing files that changed from the base of the PR and between 0c5077e and 8c83f90.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: cebb094e-3c8a-49a8-8564-b94a29029f0c

📥 Commits

Reviewing files that changed from the base of the PR and between 8c83f90 and 6cc74cb.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md
Comment thread README.md
@wasabbe

wasabbe commented Jun 12, 2026

Copy link
Copy Markdown
Author

can we please merge this !

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