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.

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+17 −13
Open

docs: add Coder Desktop to remote desktop docs #18326

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8d91a1d
docs: add Coder Desktop to remote desktop docs
matifali Jun 11, 2025
c73085d
Merge branch 'main' into atof/remote-desktop-docs
matifali 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
30 changes: 17 additions & 13 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 @@ -15,37 +15,41 @@ 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
```
### Coder Desktop
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs to be rebased on #18354 and consolidated.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will wait for the above to merge first.


[Install Coder Desktop](https://coder.com/docs/user-guides/desktop#install-coder-desktop) and connect to you `<workspace-name>.coder:3389` from your favourite RDP client.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[Install Coder Desktop](https://coder.com/docs/user-guides/desktop#install-coder-desktop) and connect to you `<workspace-name>.coder:3389` from your favourite RDP client.
[Install Coder Desktop](https://coder.com/docs/user-guides/desktop#install-coder-desktop) and connect to you `<workspace-name>.coder` 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 <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!`.
</div>

> [!NOTE]
> The default username is `Administrator` and password is `coderRDP!`.

### Coder Desktop URI Handling (Beta)

Expand Down
Loading