8000 docs: reorganize remote desktop docs (#18716) · coder/coder@ca13b58 · GitHub
[go: up one dir, main page]
Skip to content

Commit ca13b58

Browse files
matifalimatifali
authored
docs: reorganize remote desktop docs (#18716)
- Reorganize each option in two sections: Web and Desktop Client - Moves the warning about UDP connections to the bottom - Move Coder Desktop as the first option - Links the Coder Desktop RDP module Preview: https://coder.com/docs/@remote-desktop-module/user-guides/workspace-access/remote-desktops
1 parent 02372ca commit ca13b58

File tree

6 files changed

+111
-64
lines changed

6 files changed

+111
-64
lines changed

‎docs/images/user-guides/amazon-dcv-windows-demo.png renamed to ‎docs/images/user-guides/remote-desktops/amazon-dcv-windows-demo.png

File renamed without changes.

‎docs/images/user-guides/remote-desktops/rdp-button-and-window.png

1.95 MB
Loading

‎docs/images/vnc-desktop.png renamed to ‎docs/images/user-guides/remote-desktops/vnc-desktop.png

File renamed without changes.

‎docs/images/user-guides/web-rdp-demo.png renamed to ‎docs/images/user-guides/remote-desktops/web-rdp-demo.png

File renamed without changes.

‎docs/images/ides/windows_rdp_client.png renamed to ‎docs/images/user-guides/remote-desktops/windows_rdp_client.png

File renamed without changes.

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

Lines changed: 111 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,28 @@
11
# Remote Desktops
22

3-
## VNC Desktop
3+
## RDP
44

5-
The common way to use remote desktops with Coder is through VNC.
5+
The most common way to get a GUI-based connection to a Windows workspace is by using Remote Desktop Protocol (RDP).
66

7-
![VNC Desktop in Coder](../../images/vnc-desktop.png)
8-
9-
Workspace requirements:
10-
11-
- VNC server (e.g. [tigervnc](https://tigervnc.org/))
12-
- VNC client (e.g. [novnc](https://novnc.com/info.html))
13-
14-
Installation instructions vary depending on your workspace's operating system,
15-
platform, and build system.
16-
17-
As a starting point, see 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
20-
following software:
21-
22-
- Ubuntu 24.04
23-
- XFCE Desktop
24-
- KasmVNC Server and Web Client
7+
<div class="tabs">
258

26-
## RDP Desktop
9+
### Desktop Client
2710

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

3215
<div class="tabs">
3316

34-
### CLI
17+
#### Coder Desktop
3518

36-
Use the following command to forward the RDP port to your local machine:
19+
[Coder Desktop](../desktop/index.md)'s **Coder Connect** feature creates a connection to your workspaces in the background. Use your favorite RDP client to connect to `<workspace-name>.coder`.
3720

38-
```console
39-
coder port-forward <workspace-name> --tcp 3399:3389
40-
```
41-
42-
Then, connect to your workspace via RDP at `localhost:3399`.
43-
![windows-rdp](../../images/ides/windows_rdp_client.png)
21+
You can use the [RDP Desktop](https://registry.coder.com/modules/coder/local-windows-rdp) module to add a single-click button to open an RDP session in the browser.
4422

45-
### RDP with Coder Desktop
23+
![RDP Desktop Button](../../images/user-guides/remote-desktops/rdp-button-and-window.png)
4624

47-
[Coder Desktop](../desktop/index.md)'s Coder Connect feature creates a connection to your workspaces in the background.
48-
There is no need for port forwarding when it is enabled.
49-
50-
Use your favorite RDP client to connect to `<workspace-name>.coder` instead of `localhost:3399`.
51-
52-
> [!NOTE]
53-
> Some versions of Windows, including Windows Server 2022, do not communicate correctly over UDP
54-
> when using Coder Connect because they do not respect the maximum transmission unit (MTU) of the link.
55-
> When this happens, the RDP client will appear to connect, but displays a blank screen.
56-
>
57-
> To avoid this error, Coder's [Windows RDP](https://registry.coder.com/modules/windows-rdp) module
58-
> [disables RDP over UDP automatically](https://github.com/coder/registry/blob/b58bfebcf3bcdcde4f06a183f92eb3e01842d270/registry/coder/modules/windows-rdp/powershell-installation-script.tftpl#L22).
59-
>
60-
> To disable RDP over UDP, run the following in PowerShell:
61-
>
62-
> ```powershell
63-
> New-ItemProperty -Path 'HKLM:\SOFTWARE\Policies\Microsoft\Windows NT\Terminal Services' -Name "SelectTransport" -Value 1 -PropertyType DWORD -Force
64-
> Restart-Service -Name "TermService" -Force
65-
> ```
66-
67-
You can also use a URI handler to directly launch an RDP session.
25+
You can also use a URI handler to launch an RDP session directly.
6826

6927
The URI format is:
7028

@@ -88,32 +46,121 @@ locals {
8846
resource "coder_app" "rdp-coder-desktop" {
8947
agent_id = resource.coder_agent.main.id
9048
slug = "rdp-desktop"
91-
display_name = "RDP with Coder Desktop"
49+
display_name = "RDP Desktop"
9250
url = "coder://${local.server_name}/v0/open/ws/${data.coder_workspace.me.name}/agent/main/rdp?username=Administrator&password=coderRDP!"
9351
icon = "/icon/desktop.svg"
9452
external = true
9553
}
9654
```
9755

56+
#### CLI
57+
58+
Use the following command to forward the RDP port to your local machine:
59+
60+
```console
61+
coder port-forward <workspace-name> --tcp 3399:3389
62+
```
63+
64+
Then, connect to your workspace via RDP at `localhost:3399`.
65+
![windows-rdp](../../images/user-guides/remote-desktops/windows_rdp_client.png)
66+
67+
</div>s
68+
69+
> [!NOTE]
70+
> 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.
71+
>
72+
> 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).
73+
>
74+
> To disable RDP over UDP manually, run the following in PowerShell:
75+
>
76+
> ```powershell
77+
> New-ItemProperty -Path 'HKLM:\SOFTWARE\Policies\Microsoft\Windows NT\Terminal Services' -Name "SelectTransport" -Value 1 -PropertyType DWORD -Force
78+
> Restart-Service -Name "TermService" -Force
79+
> ```
80+
81+
### Browser
82+
83+
Our [RDP Web](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.
84+
85+
![Windows RDP Web](../../images/user-guides/remote-desktops/web-rdp-demo.png)
86+
9887
</div>
9988
10089
> [!NOTE]
10190
> The default username is `Administrator` and the password is `coderRDP!`.
10291
103-
## RDP Web
92+
## Amazon DCV
93+
94+
Our [Amazon DCV Windows](https://registry.coder.com/modules/amazon-dcv-windows) installs and configures the Amazon DCV server for seamless remote desktop access. It allows connecting through the both the [Amazon DCV desktop clients](https://docs.aws.amazon.com/dcv/latest/userguide/using-connecting.html) and a [web browser](https://docs.aws.amazon.com/dcv/latest/userguide/using-connecting-browser-connect.html).
95+
96+
<div class="tabs">
97+
98+
### Desktop Client
99+
100+
Connect using the [Amazon DCV Desktop client](https://docs.aws.amazon.com/dcv/latest/userguide/using-connecting.html) by forwarding the DCV port to your local machine:
101+
102+
<div class="tabs">
103+
104+
#### Coder Desktop
105+
106+
[Coder Desktop](../desktop/index.md)'s **Coder Connect** feature creates a connection to your workspaces in the background. Use DCV client to connect to `<workspace-name>.coder:8443`.
107+
108+
#### CLI
109+
110+
Use the following command to forward the DCV port to your local machine:
111+
112+
```console
113+
coder port-forward <workspace-name> --tcp 8443:8443
114+
```
115+
116+
</div>
117+
118+
### Browser
119+
120+
Our [Amazon DCV Windows](https://registry.coder.com/modules/amazon-dcv-windows) module adds a one-click button to open an Amazon DCV session in the browser. This requires just a few lines of Terraform in your template, see the documentation on our registry for setup.
121+
122+
</div>
104123

105-
Our [Windows RDP](https://registry.coder.com/modules/windows-rdp) module in the Coder
106-
Registry adds a one-click button to open an RDP session in the browser. This
107-
requires just a few lines of Terraform in your template, see the documentation
108-
on our registry for setup.
124+
![Amazon DCV](../../images/user-guides/remote-desktops/amazon-dcv-windows-demo.png)
109125

110-
![Windows RDP Module in a Workspace](../../images/user-guides/web-rdp-demo.png)
126+
## VNC
111127

112-
## Amazon DCV Windows
128+
The common way to connect to a desktop session of a Linux workspace is to use a VNC client. The VNC client can be installed on your local machine or accessed through a web browser. There is an additional requirement to install the VNC server on the workspace.
113129

114-
Our [Amazon DCV Windows](https://registry.coder.com/modules/amazon-dcv-windows)
115-
module adds a one-click button to open an Amazon DCV session in the browser.
116-
This requires just a few lines of Terraform in your template, see the
117-
documentation on our registry for setup.
130+
Installation instructions vary depending on your workspace's operating system, platform, and build system. Refer to the [enterprise-desktop](https://github.com/coder/images/tree/main/images/desktop) image for a starting point which can be used to provision a Dockerized workspace with the following software:
131+
132+
- Ubuntu 24.04
133+
- XFCE Desktop
134+
- KasmVNC Server and Web Client
135+
136+
<div class="tabs">
137+
138+
### Desktop Client
139+
140+
Use a VNC client (e.g., [TigerVNC](https://tigervnc.org/)) by forwarding the VNC port to your local machine.
141+
142+
<div class="tab">
143+
144+
#### Coder Desktop
145+
146+
[Coder Desktop](../desktop/index.md)'s **Coder Connect** feature allows you to connect to your workspace's VNC server at `<workspace-name>.coder:5900`.
147+
148+
#### CLI
149+
150+
Use the following command to forward the VNC port to your local machine:
151+
152+
```bash
153+
coder port-forward <workspace-name> --tcp 5900:5900
154+
```
155+
156+
Now you can connect to your workspace's VNC server using a VNC client at `localhost:5900`.
157+
158+
</div>
159+
160+
### Browser
161+
162+
The [KasmVNC module](https://registry.coder.com/modules/coder/kasmvnc) allows browser-based access to your workspace by installing and configuring the [KasmVNC](https://github.com/kasmtech/KasmVNC) server and web client.
163+
164+
</div>
118165

119-
![Amazon DCV Windows Module in a Workspace](../../images/user-guides/amazon-dcv-windows-demo.png)
166+
![VNC Desktop in Coder](../../images/user-guides/remote-desktops/vnc-desktop.png)

0 commit comments

Comments
 (0)
0