Skip to content

Commit 3bb1491

Browse files
committed
docs: warn about RDP over UDP with Coder Desktop
1 parent dd15026 commit 3bb1491

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

docs/user-guides/workspace-access/remote-desktops.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,21 @@ Or use your favorite RDP client to connect to `localhost:3399`.
4747

4848
The default username is `Administrator` and password is `coderRDP!`.
4949

50-
### Coder Desktop URI Handling (Beta)
50+
### Coder Desktop (Beta)
51+
52+
[Coder Desktop](../desktop)'s _Coder Connect_ feature creates a connection to your workspaces in the background. There
53+
is no need for port forwarding when enabled. Use your favorite RDP client to connect to `<workspace-name>.coder` instead
54+
of `localhost:3399`.
55+
56+
> [!NOTE]
57+
> We have identified that some versions of Windows, including Windows Server 2022, do not communicate correctly over UDP
58+
> when using Coder Connect as they do not respect the maximum transmission unit (MTU) of the link. When this happens the
59+
> RDP client will appear to connect, but show a blank screen. We recommend you
60+
> [disable RDP over UDP on your Windows workspaces](https://github.com/coder/registry/blob/b58bfebcf3bcdcde4f06a183f92eb3e01842d270/registry/coder/modules/windows-rdp/powershell-installation-script.tftpl#L22).
61+
> Coder's [Windows RDP](https://registry.coder.com/modules/windows-rdp) module does this automatically.
62+
63+
You can also use a URI handler to directly launch an RDP session without setting up port-forwarding.
5164

52-
[Coder Desktop](../desktop) can use a URI handler to directly launch an RDP session without setting up port-forwarding.
5365
The URI format is:
5466

5567
```text
@@ -81,7 +93,7 @@ resource "coder_app" "rdp-coder-desktop" {
8193

8294
## RDP Web
8395

84-
Our [WebRDP](https://registry.coder.com/modules/windows-rdp) module in the Coder
96+
Our [Windows RDP](https://registry.coder.com/modules/windows-rdp) module in the Coder
8597
Registry adds a one-click button to open an RDP session in the browser. This
8698
requires just a few lines of Terraform in your template, see the documentation
8799
on our registry for setup.

0 commit comments

Comments
 (0)