8000 docs: add Coder Desktop to remote desktop docs by matifali · Pull Request #18326 · coder/coder · GitHub
[go: up one dir, main page]

Skip to content

docs: add Coder Desktop to remote desktop docs #18326

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.

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 7 commits into from
Jun 26, 2025
Merged
Changes from all commits
Commits
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
34 changes: 17 additions & 17 deletions docs/user-guides/workspace-access/remote-desktops.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,38 +15,33 @@ 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

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:
<div class="tabs">

```console
coder port-forward <workspace-name> --tcp 3399:3389
```
### CLI

Then, connect to your workspace via RDP:
Use the following command to forward the RDP port to your local machine:

```console
mstsc /v localhost:3399
coder port-forward <workspace-name> --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!`.

### RDP with Coder Desktop (Beta)

[Coder Desktop](../desktop/index.md)'s Coder Connect feature creates a connection to your workspaces in the background.
Expand All @@ -57,7 +52,7 @@ Use your favorite RDP client to connect to `< 8000 workspace-name>.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 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).
Expand All @@ -83,7 +78,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 {
Expand All @@ -100,14 +95,19 @@ resource "coder_app" "rdp-coder-desktop" {
}
```

</div>

> [!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
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

Expand Down
Loading
0