From 76f302df3a1cb69ead42cc425dfec530574f9e68 Mon Sep 17 00:00:00 2001 From: Spike Curtis Date: Fri, 13 Jun 2025 06:42:45 +0000 Subject: [PATCH 1/3] docs: warn about RDP over UDP with Coder Desktop --- .../workspace-access/remote-desktops.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/docs/user-guides/workspace-access/remote-desktops.md b/docs/user-guides/workspace-access/remote-desktops.md index 2fe512b686763..f52ed479f99f9 100644 --- a/docs/user-guides/workspace-access/remote-desktops.md +++ b/docs/user-guides/workspace-access/remote-desktops.md @@ -47,9 +47,21 @@ 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) +### Coder Desktop (Beta) + +[Coder Desktop](../desktop)'s _Coder Connect_ feature creates a connection to your workspaces in the background. There +is no need for port forwarding when enabled. Use your favorite RDP client to connect to `.coder` instead +of `localhost:3399`. + +> [!NOTE] +> We have identified that some versions of Windows, including Windows Server 2022, do not communicate correctly over UDP +> when using Coder Connect as they do not respect the maximum transmission unit (MTU) of the link. When this happens the +> RDP client will appear to connect, but show a blank screen. We recommend you +> [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). +> Coder's [Windows RDP](https://registry.coder.com/modules/windows-rdp) module does this automatically. + +You can also use a URI handler to directly launch an RDP session without setting up port-forwarding. -[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 +93,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. From 57e2743d92504e8054802596754406d405af312c Mon Sep 17 00:00:00 2001 From: Spike Curtis Date: Mon, 16 Jun 2025 10:11:33 +0400 Subject: [PATCH 2/3] Apply suggestions from code review --- .../workspace-access/remote-desktops.md | 26 ++++++++++++------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/docs/user-guides/workspace-access/remote-desktops.md b/docs/user-guides/workspace-access/remote-desktops.md index f52ed479f99f9..3192bbff03fc6 100644 --- a/docs/user-guides/workspace-access/remote-desktops.md +++ b/docs/user-guides/workspace-access/remote-desktops.md @@ -47,18 +47,26 @@ Or use your favorite RDP client to connect to `localhost:3399`. The default username is `Administrator` and password is `coderRDP!`. -### Coder Desktop (Beta) +### RDP with Coder Desktop (Beta) -[Coder Desktop](../desktop)'s _Coder Connect_ feature creates a connection to your workspaces in the background. There -is no need for port forwarding when enabled. Use your favorite RDP client to connect to `.coder` instead -of `localhost:3399`. +[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 `.coder` instead of `localhost:3399`. > [!NOTE] -> We have identified that some versions of Windows, including Windows Server 2022, do not communicate correctly over UDP -> when using Coder Connect as they do not respect the maximum transmission unit (MTU) of the link. When this happens the -> RDP client will appear to connect, but show a blank screen. We recommend you -> [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). -> Coder's [Windows RDP](https://registry.coder.com/modules/windows-rdp) module does this automatically. +> 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 manually 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 +> ``` You can also use a URI handler to directly launch an RDP session without setting up port-forwarding. From 4a2adab0d2dd05ea6b4bf6336a3ecb20d4b5e8f2 Mon Sep 17 00:00:00 2001 From: Spike Curtis Date: Mon, 16 Jun 2025 06:20:30 +0000 Subject: [PATCH 3/3] drop 2nd port-forwarding and run fmt --- .../workspace-access/remote-desktops.md | 31 ++++++++++--------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/docs/user-guides/workspace-access/remote-desktops.md b/docs/user-guides/workspace-access/remote-desktops.md index 3192bbff03fc6..1d5df4e7f8d7f 100644 --- a/docs/user-guides/workspace-access/remote-desktops.md +++ b/docs/user-guides/workspace-access/remote-desktops.md @@ -49,26 +49,27 @@ The default username is `Administrator` and password is `coderRDP!`. ### 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. - +[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 `.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 manually 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 +> 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 without setting up port-forwarding. +You can also use a URI handler to directly launch an RDP session. The URI format is: