blink-so[bot] b427fe3f6a docs: Standardize module examples to use coder_agent.main

Update all module README files to use coder_agent.main instead of
coder_agent.example for consistency with existing template conventions.

Changes:
- Updated 50+ module README.md files
- Updated root README.md and CONTRIBUTING.md
- Updated examples/templates/main.tf

This ensures copy-paste examples from module docs work seamlessly
with the majority of templates that use "main" as the agent name.

2025-11-26 18:56:30 +00:00

1.9 KiB

Raw Blame History

display_name

description

icon

verified

RustDesk

Launches RustDesk within your workspace with a virtual display to provide remote desktop access. The module outputs the RustDesk ID and password needed to connect from external RustDesk clients.

module "rustdesk" {
  count    = data.coder_workspace.me.start_count
  source   = "registry.coder.com/BenraouaneSoufiane/rustdesk/coder"
  version  = "1.0.0"
  agent_id = coder_agent.main.id
}

Features

Automatically sets up virtual display (Xvfb)
Downloads and configures RustDesk
Outputs RustDesk ID and password for easy connection
Provides external app link to RustDesk web client for browser-based access
Starts virtual display (Xvfb) with customizable resolution
Customizable screen resolution and RustDesk version

Requirements

Coder v2.5 or higher
Linux workspace with apt, dnf, or yum package manager

Examples

Custom configuration with specific version

module "rustdesk" {
  count             = data.coder_workspace.me.start_count
  source            = "registry.coder.com/BenraouaneSoufiane/rustdesk/coder"
  version           = "1.0.0"
  agent_id          = coder_agent.main.id
  rustdesk_password = "mycustompass"
  xvfb_resolution   = "1920x1080x24"
  rustdesk_version  = "1.4.1"
}

Docker container configuration

It requires coder' server to be run as root, when using with Docker, add the following to your docker_container resource:

resource "docker_container" "workspace" {

  # ... other configuration ...

  user         = "root"
  privileged   = true
  network_mode = "host"

  ports {
    internal = 21115
    external = 21115
  }
  ports {
    internal = 21116
    external = 21116
  }
  ports {
    internal = 21118
    external = 21118
  }
  ports {
    internal = 21119
    external = 21119
  }
}

1.9 KiB Raw Blame History