Skip to content

feat: Add documentation for workspace proxy creation #7377

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 13 commits into from
May 4, 2023
Merged

feat: Add documentation for workspace proxy creation #7377

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
a875b56
feat: Add documentation for workspace proxy creation
Emyrk May 2, 2023
b4fa98f
Update diagram
Emyrk May 2, 2023
027110b
Update manifest
Emyrk May 2, 2023
be540aa
Add vm deployment and status codes
Emyrk May 2, 2023
953ed4f
Add some comments
Emyrk May 2, 2023
72d87f7
Add experimental disclaimer
Emyrk May 2, 2023
e863b30
Add settings note
Emyrk May 2, 2023
c641d63
Format
Emyrk May 2, 2023
2e863ae
Fix spelling mistakes
Emyrk May 3, 2023
273c6aa
Say to use experiment on proxy and coderd
Emyrk May 3, 2023
c700a73
Rename file, address comments
Emyrk May 3, 2023
64f5f06
Drop derp config values
Emyrk May 4, 2023
35151ba
Fmt manifest.json
Emyrk May 4, 2023
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
Prev Previous commit
Next Next commit
Fix spelling mistakes
  • Loading branch information
@Emyrk
Emyrk committed May 3, 2023
commit 2e863ae6f2f0a312cfdfbc6fda51605a65bea2e2
6 changes: 3 additions & 3 deletions docs/admin/workspaceproxies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Workspace Proxies

> Workspace proxies are in an [experimental state](../contributing/feature-stages.md#experimental-features) and the behavior is subject to change. Use [GitHub issues](https://github.com/coder/coder) to leave feedback. This experiment must be specifially enabled with the `--experiments="moons"` option.
> Workspace proxies are in an [experimental state](../contributing/feature-stages.md#experimental-features) and the behavior is subject to change. Use [GitHub issues](https://github.com/coder/coder) to leave feedback. This experiment must be specifically enabled with the `--experiments="moons"` option.

Workspace Proxies are a feature to provide low latency experiences for geo-distributed teams.

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.
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.

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.

Expand All @@ -20,7 +20,7 @@ Workspace proxies can be used in the browser by navigating to the user `Account

## Requirements

- The [Coder CLI](../cli.md) must installed on and authenticated as a user with the Owner role.
- The [Coder CLI](../cli.md) must be installed and authenticated as a user with the Owner role.

## Step 1: Create the proxy

Expand Down