Skip to content

Commit a875b56

Browse files
committed
feat: Add documentation for workspace proxy creation
1 parent a1db825 commit a875b56

File tree

2 files changed

+42
-0
lines changed

2 files changed

+42
-0
lines changed

docs/admin/workspaceproxies.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Workspace Proxies
2+
3+
Workspace Proxies are a feature to provide low latency experiences for geo-distributed teams.
4+
5+
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.
6+
7+
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.
8+
9+
<!-- TODO: Might want to modify this diagram? -->
10+
![ProxyDiagram](../images/workspaceproxy/proxydiagram.png)
11+
12+
# Deploy a workspace proxy
13+
14+
Workspace deployment and management must be done by a user with the `owner` role. You must logged into the `coder` cli to create a proxy.
15+
16+
```bash
17+
coder login <deployment_url>
18+
```
19+
20+
# Step 1: Create the proxy
21+
22+
Create the workspace proxy and make sure to save the returned authentication token for said proxy.
23+
24+
```bash
25+
$ coder proxy create --name=newyork --display-name="USA East" --icon="/emojis/2194.png"
26+
Workspace Proxy "newyork" created successfully. Save this token, it will not be shown again.
27+
Token: 2fb6500b-bb47-4783-a0db-dedde895b865:05271b4ef9432bac14c02b3c56b5a2d7f05453718a1f85ba7e772c0a096c7175
28+
```
29+
30+
To verify it was created.
31+
32+
```bash
33+
$ coder proxy ls
34+
NAME URL STATUS STATUS
35+
newyork unregistered
36+
```
37+
38+
# Step 2: Deploy the proxy
39+
40+
Deploying the workspace proxy will also register the proxy and make the workspace proxy usable.
41+
42+
// TODO: Docs to deploy a workspace proxy. Helm chart? Manually? Config sync?
918 KB
Loading

0 commit comments

Comments
 (0)