From 8d91a1d2e01b70db71673745fe204ad6d32585e3 Mon Sep 17 00:00:00 2001 From: Atif Ali Date: Wed, 11 Jun 2025 19:30:10 +0500 Subject: [PATCH 1/5] docs: add Coder Desktop to remote desktop docs --- .../workspace-access/remote-desktops.md | 30 +++++++++++-------- 1 file changed, 17 insertions(+), 13 deletions(-) diff --git a/docs/user-guides/workspace-access/remote-desktops.md b/docs/user-guides/workspace-access/remote-desktops.md index 2fe512b686763..0ac893cb5115d 100644 --- a/docs/user-guides/workspace-access/remote-desktops.md +++ b/docs/user-guides/workspace-access/remote-desktops.md @@ -15,14 +15,13 @@ Installation instructions vary depending on your workspace's operating system, platform, and build system. As a starting point, see the -[desktop-container](https://github.com/bpmct/coder-templates/tree/main/desktop-container) -community template. It builds and provisions a Dockerized workspace with the +[enterprise-desktop](https://github.com/coder/images/tree/main/images/desktop) +image. It can be used to provision a Dockerized workspace with the following software: -- Ubuntu 20.04 -- TigerVNC server -- noVNC client +- Ubuntu 24.04 - XFCE Desktop +- KasmVNC Server and Web Client ## RDP Desktop @@ -30,22 +29,27 @@ To use RDP with Coder, you'll need to install an [RDP client](https://docs.microsoft.com/en-us/windows-server/remote/remote-desktop-services/clients/remote-desktop-clients) on your local machine, and enable RDP on your workspace. -Use the following command to forward the RDP port to your local machine: +
-```console -coder port-forward --tcp 3399:3389 -``` +### Coder Desktop + +[Install Coder Desktop](https://coder.com/docs/user-guides/desktop#install-coder-desktop) and connect to you `.coder:3389` from your favourite RDP client. -Then, connect to your workspace via RDP: +### CLI + +Use the following command to forward the RDP port to your local machine: ```console -mstsc /v localhost:3399 +coder port-forward --tcp 3399:3389 ``` -Or use your favorite RDP client to connect to `localhost:3399`. +Then, connect to your workspace via RDP at `localhost:3399`. ![windows-rdp](../../images/ides/windows_rdp_client.png) -The default username is `Administrator` and password is `coderRDP!`. +
+ +> [!NOTE] +> The default username is `Administrator` and password is `coderRDP!`. ### Coder Desktop URI Handling (Beta) From 71a90b8c7408ea2ccebd1ff22ca09114c1be21b8 Mon Sep 17 00:00:00 2001 From: Atif Ali Date: Wed, 18 Jun 2025 11:59:14 +0500 Subject: [PATCH 2/5] Apply suggestions from code review Co-authored-by: Spike Curtis --- docs/user-guides/workspace-access/remote-desktops.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guides/workspace-access/remote-desktops.md b/docs/user-guides/workspace-access/remote-desktops.md index dc011b97e2333..4ed10b5506010 100644 --- a/docs/user-guides/workspace-access/remote-desktops.md +++ b/docs/user-guides/workspace-access/remote-desktops.md @@ -33,7 +33,7 @@ on your local machine, and enable RDP on your workspace. ### Coder Desktop -[Install Coder Desktop](https://coder.com/docs/user-guides/desktop#install-coder-desktop) and connect to you `.coder:3389` from your favourite RDP client. +[Install Coder Desktop](https://coder.com/docs/user-guides/desktop#install-coder-desktop) and connect to you `.coder` from your favourite RDP client. ### CLI From 2df01ec4d839b3fe915965f1fca107878a49723a Mon Sep 17 00:00:00 2001 From: Atif Ali Date: Wed, 18 Jun 2025 12:42:33 +0500 Subject: [PATCH 3/5] Update remote-desktops.md --- docs/user-guides/workspace-access/remote-desktops.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/user-guides/workspace-access/remote-desktops.md b/docs/user-guides/workspace-access/remote-desktops.md index 4ed10b5506010..3f3875e1239fe 100644 --- a/docs/user-guides/workspace-access/remote-desktops.md +++ b/docs/user-guides/workspace-access/remote-desktops.md @@ -33,7 +33,7 @@ on your local machine, and enable RDP on your workspace. ### Coder Desktop -[Install Coder Desktop](https://coder.com/docs/user-guides/desktop#install-coder-desktop) and connect to you `.coder` from your favourite RDP client. +[Install Coder Desktop](https://coder.com/docs/user-guides/desktop#install-coder-desktop) and connect to `.coder` from your favourite RDP client. ### CLI @@ -49,7 +49,7 @@ Then, connect to your workspace via RDP at `localhost:3399`. > [!NOTE] -> The default username is `Administrator` and password is `coderRDP!`. +> The default username is `Administrator` and the password is `coderRDP!`. ### RDP with Coder Desktop (Beta) @@ -61,7 +61,7 @@ Use your favorite RDP client to connect to `.coder` instead of ` > [!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. +> When this happens, the RDP client will appear to connect, but display 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). From b9fb5d630c2016c1c55d21d0bb262103a95e0919 Mon Sep 17 00:00:00 2001 From: Atif Ali Date: Wed, 18 Jun 2025 12:44:11 +0500 Subject: [PATCH 4/5] Update remote-desktops.md --- docs/user-guides/workspace-access/remote-desktops.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/user-guides/workspace-access/remote-desktops.md b/docs/user-guides/workspace-access/remote-desktops.md index 3f3875e1239fe..68314d91a7cce 100644 --- a/docs/user-guides/workspace-access/remote-desktops.md +++ b/docs/user-guides/workspace-access/remote-desktops.md @@ -61,7 +61,7 @@ Use your favorite RDP client to connect to `.coder` instead of ` > [!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 display a blank screen. +> 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). @@ -87,7 +87,7 @@ For example: coder://coder.example.com/v0/open/ws/myworkspace/agent/main/rdp?username=Administrator&password=coderRDP! ``` -To include a Coder Desktop button to the workspace dashboard page, add a `coder_app` resource to the template: +To include a Coder Desktop button on the workspace dashboard page, add a `coder_app` resource to the template: ```tf locals { @@ -111,7 +111,7 @@ 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. -![Web RDP Module in a Workspace](../../images/user-guides/web-rdp-demo.png) +![Windows RDP Module in a Workspace](../../images/user-guides/web-rdp-demo.png) ## Amazon DCV Windows From 170b41a04ccb9363b68ef507db964f091345328a Mon Sep 17 00:00:00 2001 From: Muhammad Atif Ali Date: Wed, 25 Jun 2025 12:26:04 +0000 Subject: [PATCH 5/5] address PR comments --- .../workspace-access/remote-desktops.md | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/docs/user-guides/workspace-access/remote-desktops.md b/docs/user-guides/workspace-access/remote-desktops.md index 68314d91a7cce..a60e943cea86a 100644 --- a/docs/user-guides/workspace-access/remote-desktops.md +++ b/docs/user-guides/workspace-access/remote-desktops.md @@ -31,10 +31,6 @@ on your local machine, and enable RDP on your workspace.
-### Coder Desktop - -[Install Coder Desktop](https://coder.com/docs/user-guides/desktop#install-coder-desktop) and connect to `.coder` from your favourite RDP client. - ### CLI Use the following command to forward the RDP port to your local machine: @@ -46,11 +42,6 @@ coder port-forward --tcp 3399:3389 Then, connect to your workspace via RDP at `localhost:3399`. ![windows-rdp](../../images/ides/windows_rdp_client.png) -
- -> [!NOTE] -> The default username is `Administrator` and the 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. @@ -104,6 +95,11 @@ resource "coder_app" "rdp-coder-desktop" { } ``` + + +> [!NOTE] +> The default username is `Administrator` and the password is `coderRDP!`. + ## RDP Web Our [Windows RDP](https://registry.coder.com/modules/windows-rdp) module in the Coder