Skip to content

[Docs]: Align SOCKS5 HTTP/SSE routing documentation with configured outbound fetch #5119

Closed

Description

@lidge-jun

Documentation problem type

Incorrect documentation

Documentation location

docs-site/src/content/docs/reference/proxy-formats.md:257 and docs-site/src/content/docs/reference/configuration/providers.md:514

What is wrong or missing?

The proxy-format guide says HTTP/SSE does not use ALL_PROXY, and provider configuration says applicable ALL_PROXY retains native fetch. src/lib/proxy-env.ts:89 selects the built-in SOCKS tunnel for SOCKS5 ALL_PROXY. The server configuration guide already describes that behavior.

What should the documentation explain instead?

Distinguish HTTP(S) proxy handling from the SOCKS5 selection branch. Describe NO_PROXY exclusions, existing precedence and supported coding/protocol limits accurately.

Suggested wording or example

“When configured outbound fetch selects an explicit SOCKS5 proxy or SOCKS5 ALL_PROXY and NO_PROXY does not exempt the target, HTTP/SSE uses OpenCodex’s built-in tunnel. Scheme-specific HTTP(S) proxy settings retain their separate documented behavior.” Verify surrounding precedence text against the actual resolver.

Additional context or attachments

Pinned source: 7864869c31c41cca9830d93540238f17df8faafb. Static documentation/source comparison only; no runtime test result is claimed.

Update all four English source pages: docs-site/src/content/docs/reference/proxy-formats.md, docs-site/src/content/docs/reference/configuration/providers.md, docs-site/src/content/docs/reference/adapters.md:135, and docs-site/src/content/docs/guides/providers.md:975, plus every translated copy of the contradicted statements; cross-link the correct server configuration section. No runtime change or new behavioral test is needed. Use a text consistency scan plus docs build/hosted checks during implementation. Related #2894 and merged #4986/#5070.

Checks

  • I searched existing documentation issues.
  • No secrets or personal information are included.

Coordination: inspect open #3901 before implementation because it touches provider documentation and transport. Preserve its applicable changes and avoid a conflicting duplicate patch.

Activity

  1. added a commit that references this issue on Sep 19, 2026
    f117c20
  2. lidge-jun commented on Sep 19, 2026

    @lidge-jun
    OwnerAuthor

    Resolved by #5153, merged into dev as f117c20d1244bf20d8cf5bd35de5bb7c71003799.

    Acceptance checked at 7bc014a5a5d39ca81978c0ec2b90772eb03c1a81: four English pages and seven localized provider-configuration copies match configured SOCKS5 HTTP/SSE behavior, both server route sources honor NO_PROXY, fake-IP wording distinguishes SOCKS5 from non-SOCKS ALL_PROXY, and DNS/peer/private-address limitations remain intact. This does not claim the separate per-provider HTTP(S) work in #3901 is implemented.

    Final independent source/interdiff review passed, both review threads were resolved, and run35436860842 passed documentation build, structure gate and aggregate CI. Applicable control checks passed. Actual merge and dev ancestry were verified. Local suites/tests/typecheck/build were NOT RUN; runtime-inapplicable skips are not represented as test passes.

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationstreamingSSE, WebSocket, terminal stream frames

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions