docs: add instructions for connecting via RDP (#7510)

2026-09-22 05:05:20 +08:00 · 2023-05-12 11:41:10 -05:00
parent cd38cb8290
commit 8d4a8fde66
2 changed files with 23 additions and 0 deletions
@@ -22,3 +22,26 @@ As a starting point, see the [desktop-container](https://github.com/bpmct/coder-
 - TigerVNC server
 - noVNC client
 - XFCE Desktop
+
+## 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.
+
+As a starting point, see the [gcp-windows-rdp](https://github.com/matifali/coder-templates/tree/main/gcp-windows-rdp) community template. It builds and provisions a Windows Server workspace on GCP.
+
+Use the following command to forward the RDP port to your local machine:
+
+```console
+coder port-forward <workspace-name> --tcp 3399:3389
+```
+
+Then, connect to your workspace via RDP:
+
+```console
+mstsc /v localhost:3399
+```
+
+or use your favorite RDP client to connect to `localhost:3399`.
+![windows-rdp](../images/ides/windows_rdp_client.png)
+
+> Note: Default username is `Administrator` and password is `coderRDP!`.