opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: warn about RDP over UDP with Coder Desktop (#18354)

Browse Source 
Warns about UDP incompatibility for Coder Connect and RDP over UDP; explains how to disable.

Fixes https://github.com/coder/internal/issues/608

[preview](https://coder.com/docs/@spike%2Finternal-608-rdp-udp-docs/user-guides/workspace-access/remote-desktops#coder-desktop-beta)
This commit is contained in:
Spike Curtis
2025-06-16 19:30:22 +04:00
committed by GitHub
parent 68e9058712
commit 86c29770e8
1 changed files with 24 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/user-guides/workspace-access/remote-desktops.md
+24 -3
View File
@@ -47,9 +47,30 @@ Or use your favorite RDP client to connect to `localhost:3399`.
The default username is `Administrator` and password is `coderRDP!`.
### Coder Desktop URI Handling (Beta)
### RDP with Coder Desktop (Beta)
[Coder Desktop](../desktop/index.md)'s Coder Connect feature creates a connection to your workspaces in the background.
There is no need for port forwarding when it is enabled.
Use your favorite RDP client to connect to `<workspace-name>.coder` instead of `localhost:3399`.
> [!NOTE]
> Some versions of Windows, including Windows Server 2022, do not communicate correctly over UDP
> when using Coder Connect because they do not respect the maximum transmission unit (MTU) of the link.
> When this happens the RDP client will appear to connect, but displays a blank screen.
>
> To avoid this error, Coder's [Windows RDP](https://registry.coder.com/modules/windows-rdp) module
> [disables RDP over UDP automatically](https://github.com/coder/registry/blob/b58bfebcf3bcdcde4f06a183f92eb3e01842d270/registry/coder/modules/windows-rdp/powershell-installation-script.tftpl#L22).
>
> To disable RDP over UDP, run the following in PowerShell:
>
> ```powershell
> New-ItemProperty -Path 'HKLM:\SOFTWARE\Policies\Microsoft\Windows NT\Terminal Services' -Name "SelectTransport" -Value 1 -PropertyType DWORD -Force
> Restart-Service -Name "TermService" -Force
> ```
You can also use a URI handler to directly launch an RDP session.
[Coder Desktop](../desktop) can use a URI handler to directly launch an RDP session without setting up port-forwarding.
The URI format is:
```text
@@ -81,7 +102,7 @@ resource "coder_app" "rdp-coder-desktop" {
## RDP Web
Our [WebRDP](https://registry.coder.com/modules/windows-rdp) module in the Coder
Our [Windows RDP](https://registry.coder.com/modules/windows-rdp) module in the Coder
Registry adds a one-click button to open an RDP session in the browser. This
requires just a few lines of Terraform in your template, see the documentation
on our registry for setup.