Skip to content

Commit d42de1d

Browse files
feat(local-windows-rdp): update README to enhance module description, features, and requirements for RDP access
1 parent 3bea8a7 commit d42de1d

File tree

1 file changed

+30
-15
lines changed
  • registry/coder/modules/local-windows-rdp

1 file changed

+30
-15
lines changed

registry/coder/modules/local-windows-rdp/README.md

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22
display_name: Windows RDP Desktop
3-
description: Add a one-click RDP Desktop button using Coder Desktop URI functionality
3+
description: Enable RDP on Windows and add a one-click Coder Desktop button for seamless access
44
icon: ../../../../.icons/desktop.svg
55
maintainer_github: coder
6-
verified: true
7-
tags: [rdp, windows, desktop]
6+
verified: false
7+
tags: [rdp, windows, desktop, remote]
88
---
99

1010
# Windows RDP Desktop
1111

12-
This module adds a one-click button to launch Remote Desktop Protocol (RDP) sessions directly through Coder Desktop using URI handling. This provides seamless RDP access without requiring manual port forwarding.
12+
This module enables Remote Desktop Protocol (RDP) on Windows workspaces and adds a one-click button to launch RDP sessions directly through Coder Desktop. It provides a complete, standalone solution for RDP access without requiring manual configuration or port forwarding.
1313

1414
```tf
1515
module "rdp_desktop" {
@@ -20,24 +20,35 @@ module "rdp_desktop" {
2020
}
2121
```
2222

23-
## Requirements
23+
## Features
2424

25-
- **Coder Desktop**: This module requires [Coder Desktop](https://github.com/coder/coder/releases) to be installed on the client machine
26-
- **Windows Workspace**: The target workspace must be running Windows with RDP enabled
27-
- **Agent**: A Coder agent must be running on the Windows workspace
25+
-**Standalone Solution**: Automatically configures RDP on Windows workspaces
26+
-**One-click Access**: Launch RDP sessions directly through Coder Desktop
27+
-**No Port Forwarding**: Uses Coder Desktop URI handling
28+
-**Auto-configuration**: Sets up Windows firewall, services, and authentication
29+
-**Secure**: Configurable credentials with sensitive variable handling
30+
-**Customizable**: Display name, credentials, and UI ordering options
2831

29-
## Features
32+
## What This Module Does
3033

31-
- ✅ One-click RDP access through Coder Desktop
32-
- ✅ No manual port forwarding required
33-
- ✅ Configurable authentication credentials
34-
- ✅ Customizable display name and ordering
35-
- ✅ Secure credential handling
34+
1. **Enables RDP** on the Windows workspace
35+
2. **Sets the administrator password** for RDP authentication
36+
3. **Configures Windows Firewall** to allow RDP connections
37+
4. **Starts RDP services** automatically
38+
5. **Creates a Coder Desktop button** for one-click access
39+
40+
## Requirements
41+
42+
- **Coder Desktop**: Must be installed on the client machine ([Download here](https://github.com/coder/coder/releases))
43+
- **Windows Workspace**: The target workspace must be running Windows
44+
- **Coder Agent**: Must be running on the Windows workspace
3645

3746
## Examples
3847

3948
### Basic Usage
4049

50+
Uses default credentials (Username: `Administrator`, Password: `coderRDP!`):
51+
4152
```tf
4253
module "rdp_desktop" {
4354
count = data.coder_workspace.me.start_count
@@ -49,19 +60,23 @@ module "rdp_desktop" {
4960

5061
### Custom Credentials
5162

63+
Set your own username and password:
64+
5265
```tf
5366
module "rdp_desktop" {
5467
count = data.coder_workspace.me.start_count
5568
source = "registry.coder.com/coder/local-windows-rdp/coder"
5669
version = "1.0.0"
5770
agent_id = coder_agent.main.id
58-
username = "MyUser"
71+
username = "MyAdmin"
5972
password = "MySecurePassword123!"
6073
}
6174
```
6275

6376
### Custom Display and Agent
6477

78+
Configure display name and specify a different agent:
79+
6580
```tf
6681
module "rdp_desktop" {
6782
count = data.coder_workspace.me.start_count

0 commit comments

Comments
 (0)