docs: rename WSProxy to App Proxy across the manual

yomybaby · agatha197 · commit dcc10dce8ae0 · 2026-05-18T06:24:27.000Z
FR-2841 (#7300) renamed all WSProxy i18n keys/values to App Proxy in the UI. This updates the user manual accordingly. - admin_menu Resource Group fields: WSProxy Server Address → App Proxy Server Address, WSProxy API Token → App Proxy API Token - overview: keep architectural `wsproxy` daemon mentions in inline code; clarify UI surface is App Proxy - trouble_shooting: update WSProxy references to App Proxy - TERMINOLOGY.md: new App Proxy entry with formerly-WSProxy guidance and Terms-to-Avoid row Updated in all 4 languages (en/ko/ja/th). Part of the recent main-branch docs catch-up plan (Work Item 5).
diff --git a/packages/backend.ai-webui-docs/TERMINOLOGY.md b/packages/backend.ai-webui-docs/TERMINOLOGY.md
@@ -129,6 +129,26 @@ Backend.AI's GPU virtualization technology that allows sharing a single physical
 | Endpoint | The access point created for a served model |
 | Inference | The operation of running predictions through a served model |
 
+### App Proxy (formerly WSProxy)
+
+The proxy component that relays in-container application traffic (Jupyter, Terminal, TensorBoard, etc.) between the user's browser and the compute session. Renamed from **WSProxy** to **App Proxy** in the UI in FR-2841. The internal binary / daemon is still named `wsproxy`; only the user-facing label changed.
+
+| Language | Term | Notes |
+|----------|------|-------|
+| English | App Proxy | Use "App Proxy (formerly WSProxy)" on first mention for users familiar with the old term. |
+| Korean | App Proxy | UI 라벨은 영문 그대로 사용합니다. 처음 언급할 때 "App Proxy(이전 명칭 WSProxy)"로 적어 줍니다. |
+| Japanese | App Proxy | UIラベルは英語のまま使用します。初出時は「App Proxy（旧称 WSProxy）」と表記します。 |
+| Thai | App Proxy | ใช้ป้ายภาษาอังกฤษเดิม เมื่อกล่าวถึงครั้งแรกให้เขียนว่า "App Proxy (ชื่อเดิม WSProxy)" |
+
+**Field labels** (Resource Group settings):
+
+| EN | KO | JA | TH |
+|----|----|----|----|
+| App Proxy Server Address | App Proxy 서버 주소 | App Proxy サーバアドレス | ที่อยู่เซิร์ฟเวอร์ App Proxy |
+| App Proxy API Token | App Proxy API 토큰 | App Proxy APIトークン | โทเค็น API ของ App Proxy |
+
+**Do NOT use** "WSProxy" as the user-facing label in new documentation. Keep `wsproxy` (lowercase, in `code` style) only when referring to the internal binary, daemon, or config key (e.g., `wsproxy.proxyURL` in `config.toml`).
+
 ### Container vs Kernel / Image
 
 | Term | Meaning |
@@ -186,3 +206,4 @@ These terms match sidebar menu items. Keep documentation references consistent w
 | data folder | storage folder / vfolder | Non-standard |
 | worker node | agent node | Reserve "worker node" for model serving context only |
 | compute node | agent node | Non-standard in docs |
+| WSProxy (as a UI label) | App Proxy | Renamed in FR-2841; use `wsproxy` (code style) only for the internal binary/daemon |
diff --git a/packages/backend.ai-webui-docs/src/en/admin_menu/admin_menu.md b/packages/backend.ai-webui-docs/src/en/admin_menu/admin_menu.md
@@ -1046,8 +1046,8 @@ You can deactivate a resource policy by turning off Active Status.
 The resource group edit dialog contains the following additional fields:
 
 - **Allowed session types**: Since users can choose the type of session, the resource group can allow certain types. You should allow at least one session type. The allowed session types are Interactive, Batch, Inference, and System.
-- **WSProxy Server Address**: Sets the WSProxy address for the resource group's Agents to use. If you set a URL in this field, WSProxy will relay the traffic of an app like Jupyter directly to the compute session via Agent bypassing Manager (v2 API). By enabling the v2 API, you can lower the Manager's burden when using app services. If a direct connection from WSProxy to the Agent node is not available, leave this field blank to fall back to the v1 API.
-- **WSProxy API Token**: The API token for authenticating with the WSProxy server.
+- **App Proxy Server Address**: Sets the App Proxy (formerly WSProxy) address for the resource group's Agents to use. If you set a URL in this field, App Proxy will relay the traffic of an app like Jupyter directly to the compute session via Agent bypassing Manager (v2 API). By enabling the v2 API, you can lower the Manager's burden when using app services. If a direct connection from App Proxy to the Agent node is not available, leave this field blank to fall back to the v1 API.
+- **App Proxy API Token**: The API token for authenticating with the App Proxy server.
 - **Active**: Toggle the active status of the resource group.
 - **Public**: When enabled, the resource group is visible to all users.
 - **Pending timeout**:
diff --git a/packages/backend.ai-webui-docs/src/en/appendix/appendix.md b/packages/backend.ai-webui-docs/src/en/appendix/appendix.md
@@ -197,7 +197,7 @@ optimal performance, just double the amount of each resources.
 - Manager: 2 cores, 4 GiB memory
 - Agent: 4 cores, 32 GiB memory, NVIDIA GPU (for GPU workload), > 512 GiB SSD
 - Webserver: 2 cores, 4 GiB memory
-- WSProxy: 2 cores, 4 GiB memory
+- App Proxy: 2 cores, 4 GiB memory
 - PostgreSQL DB: 2 cores, 4 GiB memory
 - Redis: 1 core, 2 GiB memory
 - Etcd: 1 core, 2 GiB memory
@@ -211,7 +211,7 @@ each service are:
 - Agent: docker (≥19.03), CUDA/CUDA Toolkit (≥8, 11 recommend),
   nvidia-docker v2, Python (≥3.8), pyenv/pyenv-virtualenv (≥1.2)
 - Webserver: Python (≥3.8), pyenv/pyenv-virtualenv (≥1.2)
-- WSProxy: docker (≥19.03), docker-compose (≥1.24)
+- App Proxy: docker (≥19.03), docker-compose (≥1.24)
 - PostgreSQL DB: docker (≥19.03), docker-compose (≥1.24)
 - Redis: docker (≥19.03), docker-compose (≥1.24)
 - Etcd: docker (≥19.03), docker-compose (≥1.24)
diff --git a/packages/backend.ai-webui-docs/src/en/overview/overview.md b/packages/backend.ai-webui-docs/src/en/overview/overview.md
@@ -77,16 +77,17 @@ achieves more intuitive use.
 - Web-UI: A GUI client that is served as a web or stand-alone app.
   You can use the service after logging in by specifying the address of the
   Backend.AI server and entering the user account information.
-- Local wsproxy: Proxy server built into the Web-UI app. Local wsproxy converts
-  general HTTP requests between the server and Web-UI app to websocket and
-  delivers the messages. If the Web-UI app loses its connection to wsproxy or
-  the wsproxy server is dead, it will not be possible to access services such as
-  Jupyter Notebook and Terminal.
-- Web wsproxy: In the case of the Web-UI provided in a web, the built-in
+- Local `wsproxy`: Proxy server built into the Web-UI app. The local `wsproxy`
+  daemon converts general HTTP requests between the server and Web-UI app to
+  websocket and delivers the messages. If the Web-UI app loses its connection
+  to `wsproxy` or the `wsproxy` server is dead, it will not be possible to
+  access services such as Jupyter Notebook and Terminal. In the WebUI, this
+  component is surfaced as **App Proxy** (formerly WSProxy).
+- Web `wsproxy`: In the case of the Web-UI provided in a web, the built-in
   server cannot be used due to the nature of the browser. In this case, you
   can use services such as Jupyter Notebook, Terminal, etc. in the web
-  environment by making the wsproxy server as a separate web server
-  so that the Web-UI app can see the web wsproxy.
+  environment by making the `wsproxy` server a separate web server
+  so that the Web-UI app can see the web `wsproxy`.
 
 
 <a id="backend-ai-feature-details"></a>
diff --git a/packages/backend.ai-webui-docs/src/en/trouble_shooting/trouble_shooting.md b/packages/backend.ai-webui-docs/src/en/trouble_shooting/trouble_shooting.md
@@ -83,8 +83,9 @@ connection.
 
 ### Users cannot launch apps like Jupyter Notebook
 
-There may be a problem on connecting WSProxy service. Try to stop and restart
-the service by referencing the guide on start/stop/restart WSProxy service.
+There may be a problem on connecting the App Proxy (formerly WSProxy) service.
+Try to stop and restart the service by referencing the guide on
+start/stop/restart App Proxy service.
 
 ### Indicated resources do not match with actual allocation
 
diff --git a/packages/backend.ai-webui-docs/src/ja/admin_menu/admin_menu.md b/packages/backend.ai-webui-docs/src/ja/admin_menu/admin_menu.md
@@ -965,8 +965,8 @@ Terminatedタブでは、一度接続されてから終了または切断され
 リソースグループ編集ダイアログには以下の追加フィールドが含まれています：
 
 - **許可されたセッションタイプ**: ユーザーがセッションタイプを選択できるため、リソースグループで特定のタイプを許可できます。少なくとも1つのセッションタイプを許可する必要があります。許可されるセッションタイプは Interactive、Batch、Inference、System です。
-- **WSProxy サーバアドレス**: リソースグループのエージェントが使用するWSProxyアドレスを設定します。このフィールドにURLを設定すると、WSProxyがJupyterなどのアプリのトラフィックをManagerをバイパスしてエージェント経由でコンピュートセッションに直接中継します（v2 API）。WSProxyからエージェントノードへの直接接続が利用できない場合は、このフィールドを空白のままにしてv1 APIにフォールバックしてください。
-- **WSProxy APIトークン**: WSProxyサーバーとの認証用APIトークンです。
+- **App Proxy サーバアドレス**: リソースグループのエージェントが使用するApp Proxy（旧称 WSProxy）アドレスを設定します。このフィールドにURLを設定すると、App ProxyがJupyterなどのアプリのトラフィックをManagerをバイパスしてエージェント経由でコンピュートセッションに直接中継します（v2 API）。App Proxyからエージェントノードへの直接接続が利用できない場合は、このフィールドを空白のままにしてv1 APIにフォールバックしてください。
+- **App Proxy APIトークン**: App Proxyサーバーとの認証用APIトークンです。
 - **アクティブ**: リソースグループの有効/無効を切り替えます。
 - **公開**: 有効にすると、リソースグループがすべてのユーザーに表示されます。
 - **保留中のタイムアウト**: コンピュートセッションが保留中のタイムアウトより長く `PENDING` 状態を維持すると取り消されます。この値をゼロ（0）に設定すると、この機能は適用されません。
diff --git a/packages/backend.ai-webui-docs/src/ja/appendix/appendix.md b/packages/backend.ai-webui-docs/src/ja/appendix/appendix.md
@@ -123,7 +123,7 @@ Backend.AIサーバーデーモン/サービスには、以下のハードウェ
 - Manager: 2コア、4 GiBメモリ
 - Agent: 4コア、32 GiBメモリ、NVIDIA GPU（GPUワークロード用）、> 512 GiB SSD
 - Webserver: 2コア、4 GiBメモリ
-- WSProxy: 2コア、4 GiBメモリ
+- App Proxy: 2コア、4 GiBメモリ
 - PostgreSQL DB: 2コア、4 GiBメモリ
 - Redis: 1コア、2 GiBメモリ
 - Etcd: 1コア、2 GiBメモリ
@@ -134,7 +134,7 @@ Backend.AIサーバーデーモン/サービスには、以下のハードウェ
 - Manager: Python (≥3.8)、pyenv/pyenv-virtualenv (≥1.2)
 - Agent: docker (≥19.03)、CUDA/CUDA Toolkit (≥8、11推奨)、nvidia-docker v2、Python (≥3.8)、pyenv/pyenv-virtualenv (≥1.2)
 - Webserver: Python (≥3.8)、pyenv/pyenv-virtualenv (≥1.2)
-- WSProxy: docker (≥19.03)、docker-compose (≥1.24)
+- App Proxy: docker (≥19.03)、docker-compose (≥1.24)
 - PostgreSQL DB: docker (≥19.03)、docker-compose (≥1.24)
 - Redis: docker (≥19.03)、docker-compose (≥1.24)
 - Etcd: docker (≥19.03)、docker-compose (≥1.24)
diff --git a/packages/backend.ai-webui-docs/src/ja/overview/overview.md b/packages/backend.ai-webui-docs/src/ja/overview/overview.md
@@ -21,8 +21,8 @@ GUIクライアントパッケージは、Backend.AIサーバーがサポート
 - バーチャルフォルダ（vfolder）：コンテナがどのノードで実行されているかに関わらず、常にアクセス可能でコンテナ内にマウント可能な「クラウド」フォルダ（ユーザごとに個別）。自分のバーチャルフォルダを作成した後、自分のプログラムコードやデータなどを事前にアップロードし、計算セッションを実行する際にフォルダをマウントして、あたかもローカルディスクであるかのように読み書きすることができます。
 - アプリケーションサービス、サービスポート: コンピュートセッション内で実行されているさまざまなユーザーアプリケーション（例: DIGITS、Jupyter Notebook、シェルターミナル、TensorBoardなど）にアクセスする機能です。コンテナのアドレスやポート番号を直接知る必要はなく、提供されたCLIクライアントまたはGUI Web-UIを使用して、セッションの目的のデーモンに直接アクセスできます。
 - Web-UI: Webまたはスタンドアロンアプリとして提供されるGUIクライアントです。Backend.AIサーバーのアドレスを指定し、ユーザーアカウント情報を入力してログインすることでサービスを利用できます。
-- ローカル wsproxy: Web-UI アプリに組み込まれたプロキシサーバー。ローカル wsproxy は、サーバーと Web-UI アプリ間の一般的な HTTP リクエストを WebSocket に変換し、メッセージを送信します。Web-UI アプリが wsproxy への接続を失うか、wsproxy サーバーが停止すると、Jupyter Notebook やターミナルなどのサービスにアクセスすることはできません。
-- Web wsproxy: Web上で提供されるWeb-UIの場合、ブラウザの特性上、組み込みサーバーを使用することはできません。この場合、wsproxyサーバーを別のWebサーバーとして設定し、Web-UIアプリがWeb wsproxyを参照できるようにすることで、Jupyter NotebookやターミナルなどのサービスをWeb環境で使用できます。
+- ローカル `wsproxy`: Web-UI アプリに組み込まれたプロキシサーバー。ローカル `wsproxy` は、サーバーと Web-UI アプリ間の一般的な HTTP リクエストを WebSocket に変換し、メッセージを送信します。Web-UI アプリが `wsproxy` への接続を失うか、`wsproxy` サーバーが停止すると、Jupyter Notebook やターミナルなどのサービスにアクセスすることはできません。WebUI ではこのコンポーネントを **App Proxy**（旧称 WSProxy）として表示します。
+- Web `wsproxy`: Web上で提供されるWeb-UIの場合、ブラウザの特性上、組み込みサーバーを使用することはできません。この場合、`wsproxy` サーバーを別のWebサーバーとして設定し、Web-UIアプリがWeb `wsproxy` を参照できるようにすることで、Jupyter NotebookやターミナルなどのサービスをWeb環境で使用できます。
 
 
 <a id="backend-ai-feature-details"></a>
diff --git a/packages/backend.ai-webui-docs/src/ja/trouble_shooting/trouble_shooting.md b/packages/backend.ai-webui-docs/src/ja/trouble_shooting/trouble_shooting.md
@@ -64,8 +64,8 @@ Web-UIアプリが閉じられ再起動されても、既存のコンピュー
 
 ### ユーザーは Jupyter Notebook のようなアプリを起動できません。
 
-WSProxyサービスの接続に問題がある可能性があります。WSProxyサービスの
-開始・停止・再起動ガイドを参照して、サービスを停止してから再起動してみてください。
+App Proxy（旧称 WSProxy）サービスの接続に問題がある可能性があります。
+App Proxyサービスの開始・停止・再起動ガイドを参照して、サービスを停止してから再起動してみてください。
 
 ### 指定されたリソースが実際の割り当てと一致しません。
 
diff --git a/packages/backend.ai-webui-docs/src/ko/admin_menu/admin_menu.md b/packages/backend.ai-webui-docs/src/ko/admin_menu/admin_menu.md
@@ -841,8 +841,8 @@ Terminated 탭에서는 한번 연결되었다가 종료되거나 연결이 끊
 자원 그룹 편집 대화 상자에는 다음과 같은 추가 필드가 포함되어 있습니다:
 
 - **허용된 세션 타입**: 사용자가 세션 유형을 선택할 수 있으므로, 자원 그룹에서 특정 유형의 세션을 허용할 수 있습니다. 최소 하나의 세션 유형은 허용해야 합니다. 허용되는 세션 유형은 Interactive, Batch, Inference, System입니다.
-- **WSProxy 서버 주소**: 자원 그룹의 에이전트가 사용할 WSProxy 주소를 설정합니다. 이 필드에 URL을 설정하면 WSProxy가 Jupyter와 같은 앱의 트래픽을 Manager를 우회하여 에이전트를 통해 연산 세션으로 직접 중계합니다 (v2 API). WSProxy에서 에이전트 노드로의 직접 연결이 가능하지 않은 경우 이 필드를 비워 두어 v1 API로 폴백하세요.
-- **WSProxy API 토큰**: WSProxy 서버와의 인증을 위한 API 토큰입니다.
+- **App Proxy 서버 주소**: 자원 그룹의 에이전트가 사용할 App Proxy(이전 명칭 WSProxy) 주소를 설정합니다. 이 필드에 URL을 설정하면 App Proxy가 Jupyter와 같은 앱의 트래픽을 Manager를 우회하여 에이전트를 통해 연산 세션으로 직접 중계합니다 (v2 API). App Proxy에서 에이전트 노드로의 직접 연결이 가능하지 않은 경우 이 필드를 비워 두어 v1 API로 폴백하세요.
+- **App Proxy API 토큰**: App Proxy 서버와의 인증을 위한 API 토큰입니다.
 - **활성**: 자원 그룹의 활성 상태를 전환합니다.
 - **공개**: 활성화하면 자원 그룹이 모든 사용자에게 표시됩니다.
 - **대기 세션 유휴 시간**:
diff --git a/packages/backend.ai-webui-docs/src/ko/appendix/appendix.md b/packages/backend.ai-webui-docs/src/ko/appendix/appendix.md
@@ -123,7 +123,7 @@ Backend.AI 서버 데몬/서비스를 설치하려면 다음 하드웨어 사양
 - Manager: 2코어, 4 GiB 메모리
 - Agent: 4코어, 32 GiB 메모리, NVIDIA GPU (GPU 워크로드용), > 512 GiB SSD
 - Webserver: 2코어, 4 GiB 메모리
-- WSProxy: 2코어, 4 GiB 메모리
+- App Proxy: 2코어, 4 GiB 메모리
 - PostgreSQL DB: 2코어, 4 GiB 메모리
 - Redis: 1코어, 2 GiB 메모리
 - Etcd: 1코어, 2 GiB 메모리
@@ -134,7 +134,7 @@ Backend.AI 서버 데몬/서비스를 설치하려면 다음 하드웨어 사양
 - Manager: Python (≥3.8), pyenv/pyenv-virtualenv (≥1.2)
 - Agent: docker (≥19.03), CUDA/CUDA Toolkit (≥8, 11 권장), nvidia-docker v2, Python (≥3.8), pyenv/pyenv-virtualenv (≥1.2)
 - Webserver: Python (≥3.8), pyenv/pyenv-virtualenv (≥1.2)
-- WSProxy: docker (≥19.03), docker-compose (≥1.24)
+- App Proxy: docker (≥19.03), docker-compose (≥1.24)
 - PostgreSQL DB: docker (≥19.03), docker-compose (≥1.24)
 - Redis: docker (≥19.03), docker-compose (≥1.24)
 - Etcd: docker (≥19.03), docker-compose (≥1.24)
diff --git a/packages/backend.ai-webui-docs/src/ko/overview/overview.md b/packages/backend.ai-webui-docs/src/ko/overview/overview.md
@@ -68,13 +68,14 @@ GUI 클라이언트입니다. Backend.AI 서버에 접속하여 연산 자원을
 - Web-UI: 웹 또는 독립 실행형 앱으로 제공되는 GUI 클라이언트입니다. Backend.AI
   서버의 주소를 지정하고 사용자 계정 정보를 입력하여 로그인한 후 서비스를 사용할
   수 있습니다.
-- 로컬 wsproxy: Web-UI 앱에 내장된 프록시 서버입니다. 로컬 wsproxy는 서버와
+- 로컬 `wsproxy`: Web-UI 앱에 내장된 프록시 서버입니다. 로컬 `wsproxy`는 서버와
   Web-UI 앱 간의 일반 HTTP 요청을 websocket으로 변환하여 메시지를 전달합니다.
-  Web-UI 앱과 wsproxy 간의 연결이 끊기거나 wsproxy 서버가 중단되면 Jupyter
-  Notebook, Terminal 등의 서비스에 접속할 수 없습니다.
-- 웹 wsproxy: 웹 형태로 제공되는 Web-UI의 경우, 브라우저의 특성상 내장 서버를
-  사용할 수 없습니다. 이 경우 wsproxy 서버를 별도의 웹 서버로 구성하여 Web-UI
-  앱이 웹 wsproxy를 바라보게 함으로써, 웹 환경에서도 Jupyter Notebook, Terminal
+  Web-UI 앱과 `wsproxy` 간의 연결이 끊기거나 `wsproxy` 서버가 중단되면 Jupyter
+  Notebook, Terminal 등의 서비스에 접속할 수 없습니다. WebUI 화면에서는 이
+  구성 요소를 **App Proxy**(이전 명칭 WSProxy)로 표기합니다.
+- 웹 `wsproxy`: 웹 형태로 제공되는 Web-UI의 경우, 브라우저의 특성상 내장 서버를
+  사용할 수 없습니다. 이 경우 `wsproxy` 서버를 별도의 웹 서버로 구성하여 Web-UI
+  앱이 웹 `wsproxy`를 바라보게 함으로써, 웹 환경에서도 Jupyter Notebook, Terminal
   등의 서비스를 사용할 수 있습니다.
 
 
diff --git a/packages/backend.ai-webui-docs/src/ko/trouble_shooting/trouble_shooting.md b/packages/backend.ai-webui-docs/src/ko/trouble_shooting/trouble_shooting.md
@@ -53,7 +53,7 @@ Web-UI 앱을 통한 SFTP 연결은 Web-UI 앱이 내장하고 있는 로컬 pro
 
 ### 사용자가 Jupyter Notebook 등의 앱을 띄울 수 없는 경우
 
-WSProxy 서비스 연결에 문제가 있을 수 있습니다. WSProxy 서비스 시작/중지/재시작 가이드를 참고하여 서비스를 중지한 후 다시 시작해 보십시오.
+App Proxy(이전 명칭 WSProxy) 서비스 연결에 문제가 있을 수 있습니다. App Proxy 서비스 시작/중지/재시작 가이드를 참고하여 서비스를 중지한 후 다시 시작해 보십시오.
 
 ### 표시되는 자원 양이 실제 할당된 양과 다릅니다
 
diff --git a/packages/backend.ai-webui-docs/src/th/admin_menu/admin_menu.md b/packages/backend.ai-webui-docs/src/th/admin_menu/admin_menu.md
diff --git a/packages/backend.ai-webui-docs/src/th/appendix/appendix.md b/packages/backend.ai-webui-docs/src/th/appendix/appendix.md
diff --git a/packages/backend.ai-webui-docs/src/th/overview/overview.md b/packages/backend.ai-webui-docs/src/th/overview/overview.md
diff --git a/packages/backend.ai-webui-docs/src/th/trouble_shooting/trouble_shooting.md b/packages/backend.ai-webui-docs/src/th/trouble_shooting/trouble_shooting.md
