chore: update RDP modules display names, icon and docs (#169 )

## Description

Use more descriptive names

Depends on coder/coder#https://github.com/coder/coder/pull/18716

---

## Type of Change

- [ ] New module
- [ ] Bug fix
- [ ] Feature/enhancement
- [x] Documentation
- [ ] Other

2025-07-03 06:17:12 +02:00

2.5 KiB

Raw Blame History

display_name

description

icon

maintainer_github

verified

supported_os

Windows RDP Desktop

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, eliminating the need for manual configuration or port forwarding through the Coder CLI.

[!NOTE] > Coder Desktop is required on client devices to use the Local Windows RDP access feature.

module "rdp_desktop" {
  count      = data.coder_workspace.me.start_count
  source     = "registry.coder.com/coder/local-windows-rdp/coder"
  version    = "1.0.1"
  agent_id   = coder_agent.main.id
  agent_name = coder_agent.main.name
}

Features

✅ Standalone Solution: Automatically configures RDP on Windows workspaces
✅ One-click Access: Launch RDP sessions directly through Coder Desktop
✅ No Port Forwarding: Uses Coder Desktop URI handling
✅ Auto-configuration: Sets up Windows firewall, services, and authentication
✅ Secure: Configurable credentials with sensitive variable handling
✅ Customizable: Display name, credentials, and UI ordering options

What This Module Does

Enables RDP on the Windows workspace
Sets the administrator password for RDP authentication
Configures Windows Firewall to allow RDP connections
Starts RDP services automatically
Creates a Coder Desktop button for one-click access

Examples

Basic Usage

Uses default credentials (Username: Administrator, Password: coderRDP!):

module "rdp_desktop" {
  count      = data.coder_workspace.me.start_count
  source     = "registry.coder.com/coder/local-windows-rdp/coder"
  version    = "1.0.1"
  agent_id   = coder_agent.main.id
  agent_name = coder_agent.main.name
}

Custom display name

Specify a custom display name for the coder_app button:

module "rdp_desktop" {
  count        = data.coder_workspace.me.start_count
  source       = "registry.coder.com/coder/local-windows-rdp/coder"
  version      = "1.0.1"
  agent_id     = coder_agent.windows.id
  agent_name   = "windows"
  display_name = "Windows Desktop"
  order        = 1
}

2.5 KiB Raw Blame History