Skip to content

docs: add docs for selecting a proxy #7444

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 8, 2023
Merged

docs: add docs for selecting a proxy #7444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions docs/admin/workspace-proxies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<!-- TODO: Might want to modify this diagram? -->

![ProxyDiagram](../images/workspaceproxy/proxydiagram.png)

# Deploy a workspace proxy
Expand Down Expand Up @@ -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
Expand All @@ -61,11 +59,6 @@ Other Status codes:

### Configuration

<!--
I am not sure the best way to present this.
Ideally in the future we can auto sync some of the settings with coderd.
-->

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

```bash
Expand Down Expand Up @@ -97,4 +90,10 @@ CODER_TLS_KEY_FILE="<key_file_location>"
coder proxy server
```

<!-- Additional run options? -->
### 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.
Binary file added docs/images/admin/workspace-proxy-picker.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.