Skip to content

Commit 9755520

Browse files
sbx: document SOCKS5 upstream proxy and DOCKER_SANDBOXES_NO_PROXY (#25537)
<!--Delete sections as needed --> ## Description v0.35.0 adds SOCKS5 upstream proxy support and a companion exclusion variable. Release notes: https://github.com/docker/sandboxes/releases/tag/v0.35.0 > The sandbox proxy can chain upstream egress through a SOCKS5 proxy > (`socks5://` / `socks5h://`, with optional auth) via `DOCKER_SANDBOXES_PROXY`. > Add `DOCKER_SANDBOXES_NO_PROXY` to exclude destinations from > `DOCKER_SANDBOXES_PROXY`. Upstream changes: docker/sandboxes#4041 (SOCKS5 transport), docker/sandboxes#4056 (DOCKER_SANDBOXES_NO_PROXY) Updates the "Upstream proxy" section of `architecture.md`: - Documents `socks5://` and `socks5h://` scheme support, including the DNS resolution distinction between the two - Documents credential embedding in the URL (`socks5://user:pass@host:port`) - Adds `DOCKER_SANDBOXES_NO_PROXY` with a note clarifying it applies only to `DOCKER_SANDBOXES_PROXY` traffic, not `HTTP_PROXY`/`HTTPS_PROXY` - Removes the "only HTTP and HTTPS traffic can be forwarded" limitation bullet, which is no longer accurate with SOCKS5 ## Related issues or tickets <!-- Related issues, pull requests, or Jira tickets --> ## Reviews <!-- Notes for reviewers here --> <!-- List applicable reviews (optionally @tag reviewers) --> - [ ] Technical review - [ ] Editorial review - [ ] Product review Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
1 parent 6d97607 commit 9755520

1 file changed

Lines changed: 12 additions & 3 deletions

File tree

content/manuals/ai/sandboxes/architecture.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,15 +68,24 @@ and sets the upstream proxy for both HTTP and HTTPS to that URL. Unlike
6868
`HTTP_PROXY` and `HTTPS_PROXY`, it doesn't affect image pulls or the daemon's
6969
own requests.
7070

71+
`DOCKER_SANDBOXES_PROXY` accepts `http://`, `https://`, `socks5://`, and
72+
`socks5h://` URLs. With `socks5://`, DNS is resolved locally before the
73+
connection is handed to the proxy. With `socks5h://`, DNS resolution is
74+
delegated to the proxy. Both schemes support credentials in the URL:
75+
`socks5://user:pass@host:port`.
76+
77+
Set `DOCKER_SANDBOXES_NO_PROXY` to exclude specific destinations from
78+
`DOCKER_SANDBOXES_PROXY`, using standard comma-separated `NO_PROXY` matching
79+
semantics. This only affects traffic routed through `DOCKER_SANDBOXES_PROXY`
80+
— use `NO_PROXY` to exclude destinations from `HTTP_PROXY`/`HTTPS_PROXY`.
81+
7182
Set these variables in the environment where the sandbox daemon starts. The
7283
daemon starts automatically the first time a command needs it, so set the
7384
variables before you run a `sbx` command. If the daemon is already running,
7485
restart it for a change to take effect.
7586

76-
Two limitations apply:
87+
One limitation applies:
7788

78-
- Only HTTP and HTTPS traffic can be forwarded to an upstream proxy. Other TCP
79-
traffic can't be redirected to a proxy.
8089
- Proxy auto-configuration files, such as `proxy.pac`, aren't supported. Set the
8190
`HTTP_PROXY`, `HTTPS_PROXY`, or `DOCKER_SANDBOXES_PROXY` environment variables
8291
explicitly.

0 commit comments

Comments
 (0)