|
| 1 | +--- |
| 2 | +display_name: Windows RDP Desktop |
| 3 | +description: Add a one-click RDP Desktop button using Coder Desktop URI functionality |
| 4 | +icon: ../../../../.icons/desktop.svg |
| 5 | +maintainer_github: coder |
| 6 | +verified: true |
| 7 | +tags: [rdp, windows, desktop] |
| 8 | +--- |
| 9 | + |
| 10 | +# Windows RDP Desktop |
| 11 | + |
| 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. |
| 13 | + |
| 14 | +```tf |
| 15 | +module "rdp_desktop" { |
| 16 | + count = data.coder_workspace.me.start_count |
| 17 | + source = "registry.coder.com/coder/local-windows-rdp/coder" |
| 18 | + version = "1.0.0" |
| 19 | + agent_id = coder_agent.main.id |
| 20 | +} |
| 21 | +``` |
| 22 | + |
| 23 | +## Requirements |
| 24 | + |
| 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 |
| 28 | + |
| 29 | +## Features |
| 30 | + |
| 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 |
| 36 | + |
| 37 | +## Examples |
| 38 | + |
| 39 | +### Basic Usage |
| 40 | + |
| 41 | +```tf |
| 42 | +module "rdp_desktop" { |
| 43 | + count = data.coder_workspace.me.start_count |
| 44 | + source = "registry.coder.com/coder/local-windows-rdp/coder" |
| 45 | + version = "1.0.0" |
| 46 | + agent_id = coder_agent.main.id |
| 47 | +} |
| 48 | +``` |
| 49 | + |
| 50 | +### Custom Credentials |
| 51 | + |
| 52 | +```tf |
| 53 | +module "rdp_desktop" { |
| 54 | + count = data.coder_workspace.me.start_count |
| 55 | + source = "registry.coder.com/coder/local-windows-rdp/coder" |
| 56 | + version = "1.0.0" |
| 57 | + agent_id = coder_agent.main.id |
| 58 | + username = "MyUser" |
| 59 | + password = "MySecurePassword123!" |
| 60 | +} |
| 61 | +``` |
| 62 | + |
| 63 | +### Custom Display and Agent |
| 64 | + |
| 65 | +```tf |
| 66 | +module "rdp_desktop" { |
| 67 | + count = data.coder_workspace.me.start_count |
| 68 | + source = "registry.coder.com/coder/local-windows-rdp/coder" |
| 69 | + version = "1.0.0" |
| 70 | + agent_id = coder_agent.windows.id |
| 71 | + agent_name = "windows" |
| 72 | + display_name = "Windows Desktop" |
| 73 | + order = 1 |
| 74 | +} |
| 75 | +``` |
0 commit comments