Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 16, 2025
Merged

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

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
76f302d
docs: warn about RDP over UDP with Coder Desktop
spikecurtis Jun 13, 2025
57e2743
Apply suggestions from code review
spikecurtis Jun 16, 2025
4a2adab
drop 2nd port-forwarding and run fmt
spikecurtis Jun 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 24 additions & 3 deletions docs/user-guides/workspace-access/remote-desktops.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down
Loading