You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/admin/workspaceproxies.md
+9-7
Original file line number
Diff line number
Diff line change
@@ -4,16 +4,17 @@
4
4
5
5
Workspace Proxies are a feature to provide low latency experiences for geo-distributed teams.
6
6
7
-
Coder's networking does a best effort to make direct connections to a workspace. In situtions where this is not possible, such as [dashboard connections](../networking/README.md#dashboard-connections), workspace proxies are able to reduce the amount of distance the network traffic needs to travel.
7
+
Coder's networking does a best effort to make direct connections to a workspace. In situtions where this is not possible, such as [dashboard connections](../networking/README.md#dashboard-connections), workspace proxies are able to reduce the amount of distance the network traffic needs to travel.
8
8
9
9
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.
Each workspace proxy should be a unique instance. At no point should 2 workspace proxy instances share the same authentication token.
17
+
Each workspace proxy should be a unique instance. At no point should 2 workspace proxy instances share the same authentication token.
17
18
18
19
Workspace proxies can be used in the browser by navigating to the user `Account -> Workspace Proxy`
19
20
@@ -35,7 +36,7 @@ To verify it was created.
35
36
36
37
```bash
37
38
$ coder proxy ls
38
-
NAME URL STATUS STATUS
39
+
NAME URL STATUS STATUS
39
40
newyork unregistered
40
41
```
41
42
@@ -45,13 +46,14 @@ Deploying the workspace proxy will also register the proxy with coderd and make
45
46
46
47
```
47
48
$ coder proxy lsPM
48
-
NAME URL STATUS STATUS
49
-
brazil-saopaulo https://brazil.example.com ok
50
-
europe-frankfurt https://europe.example.com ok
49
+
NAME URL STATUS STATUS
50
+
brazil-saopaulo https://brazil.example.com ok
51
+
europe-frankfurt https://europe.example.com ok
51
52
sydney https://sydney.example.com ok
52
53
```
53
54
54
55
Other Status codes:
56
+
55
57
-`unregistered` : The workspace proxy was created, and not yet deployed
56
58
-`unreachable` : The workspace proxy was registered, but is not responding. Likely the proxy went offline.
57
59
-`unhealthy` : The workspace proxy is reachable, but has some issue that is preventing the proxy from being used. `coder proxy ls` should show the error message.
@@ -63,6 +65,7 @@ Other Status codes:
63
65
I am not sure the best way to present this.
64
66
Ideally in the future we can auto sync some of the settings with coderd.
65
67
-->
68
+
66
69
Workspace proxy configuration overlaps with a subset of the coderd configuration. To see the full list of configuration options: `coder proxy server --help`
0 commit comments