Skip to content

Commit 8f9a3ea

Browse files
authored
docs: add docs for selecting a proxy (#7444)
1 parent 8899dd8 commit 8f9a3ea

File tree

2 files changed

+8
-9
lines changed

2 files changed

+8
-9
lines changed

docs/admin/workspace-proxies.md

+8-9
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ Coder's networking does a best effort to make direct connections to a workspace.
88

99
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.
1010

11-
<!-- TODO: Might want to modify this diagram? -->
12-
1311
![ProxyDiagram](../images/workspaceproxy/proxydiagram.png)
1412

1513
# Deploy a workspace proxy
@@ -45,7 +43,7 @@ newyork unregistered
4543
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:
4644

4745
```
48-
$ coder proxy lsPM
46+
$ coder proxy ls
4947
NAME URL STATUS STATUS
5048
brazil-saopaulo https://brazil.example.com ok
5149
europe-frankfurt https://europe.example.com ok
@@ -61,11 +59,6 @@ Other Status codes:
6159

6260
### Configuration
6361

64-
<!--
65-
I am not sure the best way to present this.
66-
Ideally in the future we can auto sync some of the settings with coderd.
67-
-->
68-
6962
Workspace proxy configuration overlaps with a subset of the coderd configuration. To see the full list of configuration options: `coder proxy server --help`
7063

7164
```bash
@@ -97,4 +90,10 @@ CODER_TLS_KEY_FILE="<key_file_location>"
9790
coder proxy server
9891
```
9992

100-
<!-- Additional run options? -->
93+
### Selecting a proxy
94+
95+
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.
96+
97+
![Workspace proxy picker](../images/admin/workspace-proxy-picker.png)
98+
99+
> In a future release, Coder will automatically pick the closest workspace proxy for each user, based on browser ping.
375 KB
Loading

0 commit comments

Comments
 (0)