@@ -29,28 +29,28 @@ In order for clients to be able to establish direct connections:
29
29
> ** Note:** Direct connections via the web browser are not supported. To improve
30
30
> latency for browser-based applications running inside Coder workspaces in
31
31
> regions far from the Coder control plane, consider deploying one or more
32
- > [ workspace proxies] ( ../admin /workspace-proxies.md ) .
32
+ > [ workspace proxies] ( ./workspace-proxies.md ) .
33
33
34
34
- The client is connecting using the CLI (e.g. ` coder ssh ` or
35
35
` coder port-forward ` ). Note that the
36
36
[ VSCode extension] ( https://marketplace.visualstudio.com/items?itemName=coder.coder-remote )
37
37
and [ JetBrains Plugin] ( https://plugins.jetbrains.com/plugin/19620-coder/ ) , and
38
- [ ` ssh coder.<workspace> ` ] ( ../cli/config-ssh.md ) all utilize the CLI to
38
+ [ ` ssh coder.<workspace> ` ] ( ../../reference/ cli/config-ssh.md ) all utilize the CLI to
39
39
establish a workspace connection.
40
40
- Either the client or workspace agent are able to discover a reachable
41
41
` ip:port ` of their counterpart. If the agent and client are able to
42
42
communicate with each other using their locally assigned IP addresses, then a
43
43
direct connection can be established immediately. Otherwise, the client and
44
44
agent will contact
45
- [ the configured STUN servers] ( ../cli/server.md#derp-server-stun-addresses ) to
45
+ [ the configured STUN servers] ( ../../reference/ cli/server.md#derp-server-stun-addresses ) to
46
46
try and determine which ` ip:port ` can be used to communicate with their
47
47
counterpart. See [ STUN and NAT] ( ./stun.md ) for more details on how this
48
48
process works.
49
49
- All outbound UDP traffic must be allowed for both the client and the agent on
50
50
** all ports** to each others' respective networks.
51
51
- To establish a direct connection, both agent and client use STUN. This
52
52
involves sending UDP packets outbound on ` udp/3478 ` to the configured
53
- [ STUN server] ( ../cli/server.md#--derp-server-stun-addresses ) . If either the
53
+ [ STUN server] ( ../../reference/ cli/server.md#--derp-server-stun-addresses ) . If either the
54
54
agent or the client are unable to send and receive UDP packets to a STUN
55
55
server, then direct connections will not be possible.
56
56
- Both agents and clients will then establish a
@@ -61,7 +61,7 @@ In order for clients to be able to establish direct connections:
61
61
## coder server
62
62
63
63
Workspaces connect to the coder server via the server's external address, set
64
- via [ ` ACCESS_URL ` ] ( ../admin/configure.md#access-url ) . There must not be a NAT
64
+ via [ ` ACCESS_URL ` ] ( ../../ admin/configure.md#access-url ) . There must not be a NAT
65
65
between workspaces and coder server.
66
66
67
67
Users connect to the coder server's dashboard and API through its ` ACCESS_URL `
@@ -105,14 +105,14 @@ for more information on how this process works.
105
105
106
106
If a direct connection is not available (e.g. client or server is behind NAT),
107
107
Coder will use a relayed connection. By default,
108
- [ Coder uses Google's public STUN server] ( ../cli/server.md#--derp-server-stun-addresses ) ,
108
+ [ Coder uses Google's public STUN server] ( ../../reference/ cli/server.md#--derp-server-stun-addresses ) ,
109
109
but this can be disabled or changed for
110
- [ offline deployments] ( ../install/offline.md ) .
110
+ [ offline deployments] ( ../../ install/offline.md ) .
111
111
112
112
### Relayed connections
113
113
114
114
By default, your Coder server also runs a built-in DERP relay which can be used
115
- for both public and [ offline deployments] ( ../install/offline.md ) .
115
+ for both public and [ offline deployments] ( ../../ install/offline.md ) .
116
116
117
117
However, Tailscale has graciously allowed us to use
118
118
[ their global DERP relays] ( https://tailscale.com/kb/1118/custom-derp-servers/#what-are-derp-servers ) .
@@ -169,7 +169,7 @@ with security policies. In these cases, pass the `--browser-only` flag to
169
169
` coder server ` or set ` CODER_BROWSER_ONLY=true ` .
170
170
171
171
With browser-only connections, developers can only connect to their workspaces
172
- via the web terminal and [ web IDEs] ( ../ides /web-ides.md ) .
172
+ via the web terminal and [ web IDEs] ( ../../user-guides/workspace-access /web-ides.md ) .
173
173
174
174
## Troubleshooting
175
175
0 commit comments