Skip to content

Commit fb0e7a2

Browse files
docs: add Coder Desktop to remote desktop docs (#18326)
Co-authored-by: Spike Curtis <spike@coder.com>
1 parent fdf458e commit fb0e7a2

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

docs/user-guides/workspace-access/remote-desktops.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -15,38 +15,33 @@ Installation instructions vary depending on your workspace's operating system,
1515
platform, and build system.
1616

1717
As a starting point, see the
18-
[desktop-container](https://github.com/bpmct/coder-templates/tree/main/desktop-container)
19-
community template. It builds and provisions a Dockerized workspace with the
18+
[enterprise-desktop](https://github.com/coder/images/tree/main/images/desktop)
19+
image. It can be used to provision a Dockerized workspace with the
2020
following software:
2121

22-
- Ubuntu 20.04
23-
- TigerVNC server
24-
- noVNC client
22+
- Ubuntu 24.04
2523
- XFCE Desktop
24+
- KasmVNC Server and Web Client
2625

2726
## RDP Desktop
2827

2928
To use RDP with Coder, you'll need to install an
3029
[RDP client](https://docs.microsoft.com/en-us/windows-server/remote/remote-desktop-services/clients/remote-desktop-clients)
3130
on your local machine, and enable RDP on your workspace.
3231

33-
Use the following command to forward the RDP port to your local machine:
32+
<div class="tabs">
3433

35-
```console
36-
coder port-forward <workspace-name> --tcp 3399:3389
37-
```
34+
### CLI
3835

39-
Then, connect to your workspace via RDP:
36+
Use the following command to forward the RDP port to your local machine:
4037

4138
```console
42-
mstsc /v localhost:3399
39+
coder port-forward <workspace-name> --tcp 3399:3389
4340
```
4441

45-
Or use your favorite RDP client to connect to `localhost:3399`.
42+
Then, connect to your workspace via RDP at `localhost:3399`.
4643
![windows-rdp](../../images/ides/windows_rdp_client.png)
4744

48-
The default username is `Administrator` and password is `coderRDP!`.
49-
5045
### RDP with Coder Desktop (Beta)
5146

5247
[Coder Desktop](../desktop/index.md)'s Coder Connect feature creates a connection to your workspaces in the background.
@@ -57,7 +52,7 @@ Use your favorite RDP client to connect to `<workspace-name>.coder` instead of `
5752
> [!NOTE]
5853
> Some versions of Windows, including Windows Server 2022, do not communicate correctly over UDP
5954
> when using Coder Connect because they do not respect the maximum transmission unit (MTU) of the link.
60-
> When this happens the RDP client will appear to connect, but displays a blank screen.
55+
> When this happens, the RDP client will appear to connect, but displays a blank screen.
6156
>
6257
> To avoid this error, Coder's [Windows RDP](https://registry.coder.com/modules/windows-rdp) module
6358
> [disables RDP over UDP automatically](https://github.com/coder/registry/blob/b58bfebcf3bcdcde4f06a183f92eb3e01842d270/registry/coder/modules/windows-rdp/powershell-installation-script.tftpl#L22).
@@ -83,7 +78,7 @@ For example:
8378
coder://coder.example.com/v0/open/ws/myworkspace/agent/main/rdp?username=Administrator&password=coderRDP!
8479
```
8580

86-
To include a Coder Desktop button to the workspace dashboard page, add a `coder_app` resource to the template:
81+
To include a Coder Desktop button on the workspace dashboard page, add a `coder_app` resource to the template:
8782

8883
```tf
8984
locals {
@@ -100,14 +95,19 @@ resource "coder_app" "rdp-coder-desktop" {
10095
}
10196
```
10297

98+
</div>
99+
100+
> [!NOTE]
101+
> The default username is `Administrator` and the password is `coderRDP!`.
102+
103103
## RDP Web
104104

105105
Our [Windows RDP](https://registry.coder.com/modules/windows-rdp) module in the Coder
106106
Registry adds a one-click button to open an RDP session in the browser. This
107107
requires just a few lines of Terraform in your template, see the documentation
108108
on our registry for setup.
109109

110-
![Web RDP Module in a Workspace](../../images/user-guides/web-rdp-demo.png)
110+
![Windows RDP Module in a Workspace](../../images/user-guides/web-rdp-demo.png)
111111

112112
## Amazon DCV Windows
113113

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy