Michael Smith cde8fe3b30
fix: consolidate template README images into single directory (#193)
## Description

This PR moves all the existing template README images for the Coder
namespace from being defined inline to its `.images` directory. This
makes the image-processing logic in the Registry build step easier to
maintain.

## Type of Change

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

## Testing & Validation

- [x] Tests pass (`bun test`)
- [x] Code formatted (`bun run fmt`)
- [x] Changes tested locally

---

## Related Issues

Related to https://github.com/coder/registry/issues/132
2025-07-07 12:50:34 -04:00

2.7 KiB

display_name description icon maintainer_github verified supported_os tags
RDP Desktop Enable RDP on Windows and add a one-click Coder Desktop button for seamless access ../../../../.icons/rdp.svg coder true
windows
rdp
windows
desktop
local

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

  1. Enables RDP on the Windows workspace
  2. Sets the administrator password for RDP authentication
  3. Configures Windows Firewall to allow RDP connections
  4. Starts RDP services automatically
  5. 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
}