Skip to content

Commit 86c2977

Browse files
authored
docs: warn about RDP over UDP with Coder Desktop (#18354)
Warns about UDP incompatibility for Coder Connect and RDP over UDP; explains how to disable. Fixes coder/internal#608 [preview](https://coder.com/docs/@spike%2Finternal-608-rdp-udp-docs/user-guides/workspace-access/remote-desktops#coder-desktop-beta)
1 parent 68e9058 commit 86c2977

File tree

1 file changed

+24
-3
lines changed

1 file changed

+24
-3
lines changed

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

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,30 @@ 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+
### RDP with Coder Desktop (Beta)
51+
52+
[Coder Desktop](../desktop/index.md)'s Coder Connect feature creates a connection to your workspaces in the background.
53+
There is no need for port forwarding when it is enabled.
54+
55+
Use your favorite RDP client to connect to `<workspace-name>.coder` instead of `localhost:3399`.
56+
57+
> [!NOTE]
58+
> Some versions of Windows, including Windows Server 2022, do not communicate correctly over UDP
59+
> when using Coder Connect because they do not respect the maximum transmission unit (MTU) of the link.
60+
> When this happens the RDP client will appear to connect, but displays a blank screen.
61+
>
62+
> To avoid this error, Coder's [Windows RDP](https://registry.coder.com/modules/windows-rdp) module
63+
> [disables RDP over UDP automatically](https://github.com/coder/registry/blob/b58bfebcf3bcdcde4f06a183f92eb3e01842d270/registry/coder/modules/windows-rdp/powershell-installation-script.tftpl#L22).
64+
>
65+
> To disable RDP over UDP, run the following in PowerShell:
66+
>
67+
> ```powershell
68+
> New-ItemProperty -Path 'HKLM:\SOFTWARE\Policies\Microsoft\Windows NT\Terminal Services' -Name "SelectTransport" -Value 1 -PropertyType DWORD -Force
69+
> Restart-Service -Name "TermService" -Force
70+
> ```
71+
72+
You can also use a URI handler to directly launch an RDP session.
5173
52-
[Coder Desktop](../desktop) can use a URI handler to directly launch an RDP session without setting up port-forwarding.
5374
The URI format is:
5475
5576
```text
@@ -81,7 +102,7 @@ resource "coder_app" "rdp-coder-desktop" {
81102

82103
## RDP Web
83104

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

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy