Skip to content

Commit 9bafbfc

Browse files
ericpaulsenpull[bot]
authored andcommitted
docs: fix proxy cmd ref (coder#7460)
1 parent 4e43f40 commit 9bafbfc

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

docs/admin/workspace-proxies.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,25 +25,25 @@ Workspace proxies can be used in the browser by navigating to the user `Account
2525
Create the workspace proxy and make sure to save the returned authentication token for said proxy. This is the token the workspace proxy will use to authenticate back to primary coderd.
2626

2727
```bash
28-
$ coder proxy create --name=newyork --display-name="USA East" --icon="/emojis/2194.png"
28+
$ coder wsproxy create --name=newyork --display-name="USA East" --icon="/emojis/2194.png"
2929
Workspace Proxy "newyork" created successfully. Save this token, it will not be shown again.
3030
Token: 2fb6500b-bb47-4783-a0db-dedde895b865:05271b4ef9432bac14c02b3c56b5a2d7f05453718a1f85ba7e772c0a096c7175
3131
```
3232

3333
To verify it was created.
3434

3535
```bash
36-
$ coder proxy ls
36+
$ coder wsproxy ls
3737
NAME URL STATUS STATUS
3838
newyork unregistered
3939
```
4040

4141
## Step 2: Deploy the proxy
4242

43-
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:
43+
Deploying the workspace proxy will also register the proxy with coderd and make the workspace proxy usable. If the proxy deployment is successful, `coder wsproxy ls` will show an `ok` status code:
4444

4545
```
46-
$ coder proxy ls
46+
$ coder wsproxy ls
4747
NAME URL STATUS STATUS
4848
brazil-saopaulo https://brazil.example.com ok
4949
europe-frankfurt https://europe.example.com ok
@@ -54,12 +54,12 @@ Other Status codes:
5454

5555
- `unregistered` : The workspace proxy was created, and not yet deployed
5656
- `unreachable` : The workspace proxy was registered, but is not responding. Likely the proxy went offline.
57-
- `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.
57+
- `unhealthy` : The workspace proxy is reachable, but has some issue that is preventing the proxy from being used. `coder wsproxy ls` should show the error message.
5858
- `ok` : The workspace proxy is healthy and working properly!
5959

6060
### Configuration
6161

62-
Workspace proxy configuration overlaps with a subset of the coderd configuration. To see the full list of configuration options: `coder proxy server --help`
62+
Workspace proxy configuration overlaps with a subset of the coderd configuration. To see the full list of configuration options: `coder wsproxy server --help`
6363

6464
```bash
6565
# Proxy specific configuration. These are REQUIRED
@@ -87,7 +87,7 @@ CODER_TLS_KEY_FILE="<key_file_location>"
8787

8888
```bash
8989
# Set configuration options via environment variables, a config file, or cmd flags
90-
coder proxy server
90+
coder wsproxy server
9191
```
9292

9393
### Selecting a proxy

helm/values.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ coder:
1414
#
1515
# Make sure you set CODER_PRIMARY_ACCESS_URL and CODER_PROXY_SESSION_TOKEN in
1616
# the environment below. You can get a proxy token using the CLI:
17-
# coder proxy create \
17+
# coder wsproxy create \
1818
# --name "proxy-name" \
1919
# --display-name "Proxy Name" \
2020
# --icon "/emojis/xyz.png"

0 commit comments

Comments
 (0)