Skip to content

hotfix(docs): update workspace proxies #7735

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 31, 2023
Merged

hotfix(docs): update workspace proxies #7735

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
6 changes: 2 additions & 4 deletions docs/admin/workspace-proxies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

Workspace proxies provide low-latency experiences for geo-distributed teams.

Coder's networking does a best effort to make direct connections to a workspace. In situations 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.
Coder's networking does a best effort to make direct connections to a workspace. In situations where this is not possible, such as connections via the web terminal and [web IDEs](../ides/web-ides.md), workspace proxies are able to reduce the amount of distance the network traffic needs to travel.

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.
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. Dashboard connections and API calls (e.g. the workspaces list) are not served over workspace proxies.

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

Expand Down Expand Up @@ -95,5 +95,3 @@ coder wsproxy server
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.
3 changes: 2 additions & 1 deletion docs/enterprise.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ trial](https://coder.com/trial).
| Cost Control | [Max Workspace Autostop](./templates/#configure-max-workspace-autostop) | ❌ | ✅ |
| Deployment | [High Availability](./admin/high-availability.md) | ❌ | ✅ |
| Deployment | [Appearance](./admin/appearance.md) | ❌ | ✅ |
| Deployment | Isolated Terraform Runners | ❌ | ✅ |
| Deployment | [Isolated Terraform Runners](./admin/provisioners.md) | ❌ | ✅ |
| Deployment | [Workspace Proxies](./admin/workspace-proxies.md) | ❌ | ✅ |

> Previous plans to restrict OIDC and Git Auth features in OSS have been removed
> as of 2023-01-11
Expand Down
2 changes: 2 additions & 0 deletions docs/networking/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,8 @@ Some Coder deployments require that all access is through the browser to comply
with security policies. In these cases, pass the `--browser-only` flag to
`coder server` or set `CODER_BROWSER_ONLY=true`.

With browser-only connections, developers can only connect to their workspaces via the web terminal and [web IDEs](../ides/web-ides.md).

## Troubleshooting

The `coder speedtest <workspace>` command measures user <-> workspace throughput.
Expand Down