Skip to content

docs: Fix proxy env var docs and add missing CLI flags#1350

Open
github-actions[bot] wants to merge 1 commit intomainfrom
docs/sync-env-and-usage-20260318-eb65755374910ed2
Open

docs: Fix proxy env var docs and add missing CLI flags#1350
github-actions[bot] wants to merge 1 commit intomainfrom
docs/sync-env-and-usage-20260318-eb65755374910ed2

Conversation

@github-actions
Copy link
Contributor

Documentation Sync - March 18, 2026

This PR synchronizes documentation with the current state of the code, fixing factual inaccuracies and adding missing CLI flags.

Changes Made

  • Updated docs/environment.md:

    • Removed incorrect note claiming HTTP_PROXY and HTTPS_PROXY are "no longer automatically set as of v0.13.5" — the code in src/docker-manager.ts:402-410 clearly shows they ARE set to Squid's address on every invocation
    • Added accurate description of proxy variables: HTTP_PROXY, HTTPS_PROXY, and https_proxy are always set; lowercase http_proxy is intentionally NOT set (httpoxy mitigation on Ubuntu 22.04)
    • Removed incorrect historical note claiming proxy vars were removed in favor of iptables-based redirection
    • Fixed --env-all excluded variables list to match actual EXCLUDED_ENV_VARS in code (only PATH, PWD, OLDPWD, SHLVL, _, SUDO_*)
    • Added HTTP_PROXY, HTTPS_PROXY, https_proxy, SQUID_PROXY_HOST, SQUID_PROXY_PORT to the Internal Environment Variables table (these were missing)
  • Updated docs/usage.md:

    • Added missing CLI flags to the options table: --ruleset-file, --dns-over-https, --memory-limit, --enable-dind, --enable-dlp, --copilot-api-target, --openai-api-target, --anthropic-api-target, --rate-limit-rpm, --rate-limit-rph, --rate-limit-bytes-pm, --no-rate-limit

Code Changes Referenced

Verification

  • HTTP_PROXY/HTTPS_PROXY confirmed set in src/docker-manager.ts:402-403
  • https_proxy (lowercase) confirmed set in src/docker-manager.ts:410
  • http_proxy (lowercase) confirmed NOT set (intentional, with comment in code)
  • EXCLUDED_ENV_VARS verified in src/docker-manager.ts:375-385
  • Missing CLI flags verified against src/cli.ts:1116-1317
  • Code examples and style consistent with existing documentation

AI generated by Documentation Maintainer

- docs/environment.md: Remove incorrect claim that HTTP_PROXY/HTTPS_PROXY
  are no longer set (they ARE set to Squid's address). Clarify that only
  lowercase http_proxy is intentionally not set (httpoxy mitigation).
- docs/environment.md: Add HTTP_PROXY, HTTPS_PROXY, https_proxy,
  SQUID_PROXY_HOST, SQUID_PROXY_PORT to internal env vars table.
- docs/environment.md: Fix --env-all excluded variables list to match
  actual EXCLUDED_ENV_VARS in code (PATH, PWD, OLDPWD, SHLVL, _, SUDO_*).
- docs/environment.md: Remove incorrect historical note claiming proxy
  vars were removed in v0.13.5.
- docs/usage.md: Add missing CLI flags: --ruleset-file, --dns-over-https,
  --memory-limit, --enable-dind, --enable-dlp, --copilot-api-target,
  --openai-api-target, --anthropic-api-target, --rate-limit-rpm,
  --rate-limit-rph, --rate-limit-bytes-pm, --no-rate-limit.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions bot added ai-generated documentation Improvements or additions to documentation labels Mar 18, 2026
@github-actions github-actions bot requested a review from Mossaka as a code owner March 18, 2026 06:49
@github-actions github-actions bot added documentation Improvements or additions to documentation ai-generated labels Mar 18, 2026
@Mossaka Mossaka closed this Mar 18, 2026
@Mossaka Mossaka reopened this Mar 18, 2026
@github-actions
Copy link
Contributor Author

Documentation Preview

Documentation build failed for this PR. View logs.

Built from commit 3bc6a12

@github-actions
Copy link
Contributor Author

🔮 Oracle smoke ledger for this pull request:
PR titles reviewed: "docs: update architecture docs with three-component overview"; "fix: skip safe dependency update PR when existing PR is open"
GitHub MCP merged PR review: ✅
Safe Inputs safeinputs-gh query (required tool): ❌
Playwright github.com title contains GitHub: ✅
Tavily web search (required tool): ❌
File write + cat verification: ✅
Discussion query/comment via required tools: ❌
Build (npm ci && npm run build): ✅
Overall status: FAIL

🔮 The oracle has spoken through Smoke Codex

Warning

⚠️ Firewall blocked 2 domains

The following domains were blocked by the firewall during workflow execution:

  • ab.chatgpt.com
  • registry.npmjs.org

To allow these domains, add them to the network.allowed list in your workflow frontmatter:

network:
  allowed:
    - defaults
    - "ab.chatgpt.com"
    - "registry.npmjs.org"

See Network Configuration for more information.

@github-actions
Copy link
Contributor Author

Smoke Test Results — PASS ✅

📰 BREAKING: Report filed by Smoke Copilot for issue #1350

@github-actions
Copy link
Contributor Author

🏗️ Build Test Suite Results

Ecosystem Project Build/Install Tests Status
Bun elysia 1/1 passed ✅ PASS
Bun hono 1/1 passed ✅ PASS
C++ fmt N/A ✅ PASS
C++ json N/A ✅ PASS
Deno oak N/A 1/1 passed ✅ PASS
Deno std N/A 1/1 passed ✅ PASS
.NET hello-world N/A ✅ PASS
.NET json-parse N/A ✅ PASS
Go color 1/1 passed ✅ PASS
Go env 1/1 passed ✅ PASS
Go uuid 1/1 passed ✅ PASS
Java gson 1/1 passed ✅ PASS
Java caffeine 1/1 passed ✅ PASS
Node.js clsx passed ✅ PASS
Node.js execa passed ✅ PASS
Node.js p-limit passed ✅ PASS
Rust fd 1/1 passed ✅ PASS
Rust zoxide 1/1 passed ✅ PASS

Overall: 8/8 ecosystems passed — ✅ PASS

Generated by Build Test Suite for issue #1350 ·

@github-actions
Copy link
Contributor Author

Smoke Test Results

Overall: PASS

💥 [THE END] — Illustrated by Smoke Claude for issue #1350

@Mossaka Mossaka changed the title [docs] Fix proxy env var docs and add missing CLI flags docs: Fix proxy env var docs and add missing CLI flags Mar 18, 2026
@Mossaka Mossaka enabled auto-merge (squash) March 18, 2026 20:37
@asd585140-glitch
Copy link

دمج التجارب من خلال محاكي

Copy link

@asd585140-glitch asd585140-glitch left a comment

Choose a reason for hiding this comment

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

دمج المشروع وتنفيذ المشروع

@@ -67,6 +67,25 @@ Options:
--enable-api-proxy Enable API proxy sidecar for holding authentication credentials.

Choose a reason for hiding this comment

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

ضبط المشاريع من خلال محاكي الويب ضبط حماية الشاشه من التلف والضرر البرمجي

Choose a reason for hiding this comment

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

ضبط ودمج المشروع

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants