Skip to content

Commit 0ef7d0b

Browse files
docs: correct low MTU troubleshooting language (#17468)
Fixes docs troubleshooting language around low MTU. In fact, we see conenctions hanging rather than just showing low performance, since packets are dropped rather than fragmented. --------- Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com> Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
1 parent b15d060 commit 0ef7d0b

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

docs/admin/networking/troubleshooting.md

+18-5
Original file line numberDiff line numberDiff line change
@@ -95,14 +95,27 @@ the NAT configuration, or deploy an internal STUN server.
9595

9696
If a network interface on the side of either the client or agent has an MTU
9797
smaller than 1378, any direct connections form may have degraded quality or
98-
performance, as IP packets are fragmented. `coder ping` will indicate if this is
99-
the case by inspecting network interfaces on both the client and the workspace
100-
agent.
98+
might hang entirely.
10199

102-
If another interface cannot be used, and the MTU cannot be changed, you may need
103-
to disable direct connections, and relay all traffic via DERP instead, which
100+
Use `coder ping` to check for MTU issues, as it inspects
101+
network interfaces on both the client and the workspace agent:
102+
103+
```console
104+
$ coder ping my-workspace
105+
...
106+
Possible client-side issues with direct connection:
107+
108+
- Network interface utun0 has MTU 1280 (less than 1378), which may degrade the quality of direct connections or render them unusable.
109+
```
110+
111+
If another interface cannot be used, and the MTU cannot be changed, you should
112+
disable direct connections and relay all traffic via DERP instead, which
104113
will not be affected by the low MTU.
105114

115+
To disable direct connections, set the
116+
[`--block-direct-connections`](../../reference/cli/server.md#--block-direct-connections)
117+
flag or `CODER_BLOCK_DIRECT` environment variable on the Coder server.
118+
106119
## Throughput
107120

108121
The `coder speedtest <workspace>` command measures the throughput between the

0 commit comments

Comments
 (0)