Skip to content

Commit c700a73

Browse files
committed
Rename file, address comments
1 parent 273c6aa commit c700a73

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

docs/admin/workspaceproxies.md renamed to docs/admin/workspace-proxies.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
> 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 on both coderd and the workspace proxy.
44
5-
Workspace Proxies are a feature to provide low latency experiences for geo-distributed teams.
5+
Workspace proxies provide low-latency experiences for geo-distributed teams.
66

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

@@ -14,7 +14,7 @@ A workspace proxy is a relay connection a developer can choose to use when conne
1414

1515
# Deploy a workspace proxy
1616

17-
Each workspace proxy should be a unique instance. At no point should 2 workspace proxy instances share the same authentication token.
17+
Each workspace proxy should be a unique instance. At no point should 2 workspace proxy instances share the same authentication token. They only require port 443 to be open and are expected to have network connectivity to the coderd dashboard. Workspace proxies **do not** make any database connections.
1818

1919
Workspace proxies can be used in the browser by navigating to the user `Account -> Workspace Proxy`
2020

docs/manifest.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
{
2-
"versions": ["main"],
2+
"versions": [
3+
"main"
4+
],
35
"routes": [
46
{
57
"title": "About",
@@ -310,7 +312,7 @@
310312
{
311313
"title": "External Workspace Proxies",
312314
"description": "Run geo distributed workspace proxies",
313-
"path": "./admin/workspaceproxies.md",
315+
"path": "./admin/workspace-proxies.md",
314316
"icon_path": "./images/icons/networking.svg",
315317
"state": "enterprise"
316318
},

0 commit comments

Comments
 (0)