Skip to content

docs(sandbox): add sandbox proxy user guide #1083#1084

Merged
zhongwen666 merged 4 commits into
alibaba:masterfrom
zhongwen666:doc/proxy_guide
Jun 12, 2026
Merged

docs(sandbox): add sandbox proxy user guide #1083#1084
zhongwen666 merged 4 commits into
alibaba:masterfrom
zhongwen666:doc/proxy_guide

Conversation

@zhongwen666

Copy link
Copy Markdown
Collaborator

Changes

  • Add a new "Sandbox Proxy" user guide page (sidebar position 6) under the v1.8.x User Guides section.
  • Document the HTTP and WebSocket proxy modes exposed by ROCK Admin at /sandboxes/{sandbox_id}/proxy/..., including target-port selection (path / header / query), port restrictions (>=1024, <=65535, port 22 forbidden), and error handling (HTTP 400 / WebSocket close 1008 / 1011).
  • Provide the same page in both English (docs/versioned_docs/...) and Simplified Chinese (docs/i18n/zh-Hans/...) so the two locales stay in sync.

Code Changes

  • docs/versioned_docs/version-1.8.x/User Guides/sandbox_proxy.md: new English page covering HTTP proxy, WebSocket proxy, port restrictions, error reference, and quick decision guide.
  • docs/i18n/zh-Hans/docusaurus-plugin-content-docs/version-1.8.x/User Guides/sandbox_proxy.md: matching Simplified Chinese translation.

Related Issue

Closes #1083

Document the HTTP/WebSocket proxy endpoints exposed by ROCK Admin,
including target-port selection (path/header/query), port restrictions,
and error handling. Provided in both English and Chinese (zh-Hans).
@zhongwen666 zhongwen666 merged commit cff897e into alibaba:master Jun 12, 2026
6 of 7 checks passed
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.

[Feature] Add user guide for sandbox HTTP/WebSocket proxy

2 participants