diff --git a/docs/admin/workspace-proxies.md b/docs/admin/workspace-proxies.md index cd90d315a861b..527378cf4fb46 100644 --- a/docs/admin/workspace-proxies.md +++ b/docs/admin/workspace-proxies.md @@ -8,8 +8,6 @@ Coder's networking does a best effort to make direct connections to a workspace. A workspace proxy is a relay connection a developer can choose to use when connecting with their workspace over ssh, a workspace app, port forwarding, etc. - - ![ProxyDiagram](../images/workspaceproxy/proxydiagram.png) # Deploy a workspace proxy @@ -45,7 +43,7 @@ newyork unregistered Deploying the workspace proxy will also register the proxy with coderd and make the workspace proxy usable. If the proxy deployment is successful, `coder proxy ls` will show an `ok` status code: ``` -$ coder proxy lsPM +$ coder proxy ls NAME URL STATUS STATUS brazil-saopaulo https://brazil.example.com ok europe-frankfurt https://europe.example.com ok @@ -61,11 +59,6 @@ Other Status codes: ### Configuration - - Workspace proxy configuration overlaps with a subset of the coderd configuration. To see the full list of configuration options: `coder proxy server --help` ```bash @@ -97,4 +90,10 @@ CODER_TLS_KEY_FILE="" coder proxy server ``` - +### Selecting a proxy + +Users can navigate to their account settings to select a workspace proxy. Workspace proxy preferences are cached by the web browser. If a proxy goes offline, the session will fall back to the primary proxy. This could take up to 60 seconds. + +![Workspace proxy picker](../images/admin/workspace-proxy-picker.png) + +> In a future release, Coder will automatically pick the closest workspace proxy for each user, based on browser ping. diff --git a/docs/images/admin/workspace-proxy-picker.png b/docs/images/admin/workspace-proxy-picker.png new file mode 100644 index 0000000000000..2c829dd781e54 Binary files /dev/null and b/docs/images/admin/workspace-proxy-picker.png differ