Add Rustdesk module

registry/BenraouaneSoufiane/README.md

@@ -0,0 +1,14 @@
+---
+display_name: "Benraouane Soufiane"
+bio: "Full stack developer creating awesome things."
+avatar_url: "./.images/avatar.png"
+github: "benraouanesoufiane"
+linkedin: "https://www.linkedin.com/in/benraouane-soufiane" # Optional
+website: "https://benraouanesoufiane.com" # Optional
+support_email: "[email protected]" # Optional
+status: "community"
+---
+
+# Benraouane Soufiane
+
+Full stack developer creating awesome things.

registry/BenraouaneSoufiane/modules/rustdesk/README.md

@@ -0,0 +1,68 @@
+---
+display_name: Rustdesk
+description: Create desktop environmetn & run rustdesk in your workspace
+icon: ../../../../.icons/rustdesk.svg
+verified: false
+tags: [rustdesk, rdp, vm]
+---
+
+# RustDesk Coder Module
+
+This is the basic Coder's rustdesk module that install minimal desktop environment (xfce) & launches the rustdesk within your workspace
+
+---
+
+## Features
+
+- Installs RustDesk & launches it in GUI not with black screen
+- Outputs the RustDesk ID and password
+- Automatically launches RustDesk on workspace start
+- Provides an external app link to the [RustDesk web client](https://rustdesk.com/web)
+
+---
+
+## Usage
+
+### Prerequisites
+
+- Coder v2.5 or higher
+- A workspace agent compatible with Linux and `apt` package manager
+- Root scope (to install desktop environment, rustdesk & execute rustdesk --password "somepassword", because rustdesk cli does not provide a way to get the password else setup in advance, the command rustdesk --password "somepassword" only for root users)
+
+
+---
+
+### Quickstart
+
+1. Add the module to your [Coder Terraform workspace](https://registry.coder.com)
+2. Include it in your `main.tf`:
+
+```tf
+module "rustdesk" {
+  source    = "registry.coder.com/BenraouaneSoufiane/rustdesk/BenraouaneSoufiane"
+  agent_id  = var.agent_id
+}
+```
+Also add this within resource "docker_container" "workspace":
+
+```tf
+privileged = true
+  user       = "root"
+  network_mode = "host"
+  ports {
+  internal = 21115
+  external = 21115
+}
+ports {
+  internal = 21116
+  external = 21116
+}
+ports {
+  internal = 21118
+  external = 21118
+}
+ports {
+  internal = 21119
+  external = 21119
+}
+```

registry/BenraouaneSoufiane/modules/rustdesk/main.tf

@@ -0,0 +1,76 @@
+terraform {
+  required_version = ">= 1.0"
+
+  required_providers {
+    coder = {
+      source  = "coder/coder"
+      version = ">= 2.5"
+    }
+  }
+}
+
+variable "log_path" {
+  type        = string
+  description = "The path to log rustdesk to."
+  default     = "/tmp/rustdesk.log"
+}
+
+variable "agent_id" {
+  description = "Attach RustDesk setup to this agent"
+  type        = string
+}
+
+variable "order" {
+  description = "Run order among scripts/apps"
+  type        = number
+  default     = 1
+}
+
+# Optional knobs passed as env (you can expose these as variables too)
+variable "rustdesk_password" {
+  description = "If empty, the script will generate one"
+  type        = string
+  default     = ""
+  sensitive   = true
+}
+
+variable "xvfb_resolution" {
+  description = "Xvfb screen size/depth"
+  type        = string
+  default     = "1024x768x16"
+}
+
+variable "rustdesk_version" {
+  description = "RustDesk version to install"
+  type        = string
+  default     = "1.4.0"
+}
+
+resource "coder_script" "rustdesk" {
+  agent_id     = var.agent_id
+  display_name = "RustDesk"
+  run_on_start = true
+
+  # Prepend env as bash exports, then append the script file literally.
+  script = <<-EOT
+    # --- module-provided env knobs ---
+    export RUSTDESK_PASSWORD="${var.rustdesk_password}"
+    export XVFB_RESOLUTION="${var.xvfb_resolution}"
+    export RUSTDESK_VERSION="${var.rustdesk_version}"
+    # ---------------------------------
+
+${file("${path.module}/run.sh")}
+  EOT
+}
+
+resource "coder_app" "rustdesk" {
+  count = 1
+  agent_id     = var.agent_id
+  slug         = "rustdesk"
+  display_name = "Rustdesk"
+  url          = "https://rustdesk.com/web"
+  icon         = "/icon/rustdesk.svg"
+  order        = var.order
+  external     = true
+}
+

registry/BenraouaneSoufiane/modules/rustdesk/run.sh

@@ -0,0 +1,83 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# ---- configurable knobs (env overrides) ----
+RUSTDESK_VERSION="${RUSTDESK_VERSION:-1.4.0}"
+XVFB_RESOLUTION="${XVFB_RESOLUTION:-1024x768x16}"
+RUSTDESK_PASSWORD="${RUSTDESK_PASSWORD:-}"
+
+# ---- detect package manager & arch ----
+ARCH="$(uname -m)"
+case "$ARCH" in
+  x86_64|amd64)   PKG_ARCH="x86_64" ;;
+  aarch64|arm64)  PKG_ARCH="aarch64" ;;
+  *)              echo "Unsupported arch: $ARCH"; exit 1 ;;
+esac
+
+if command -v apt-get >/dev/null 2>&1; then
+  PKG_SYS="deb"
+  PKG_NAME="rustdesk-${RUSTDESK_VERSION}-${PKG_ARCH}.deb"
+  INSTALL_DEPS='apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -y wget ca-certificates xvfb dbus-x11'
+  INSTALL_CMD="apt-get install -y ./${PKG_NAME}"
+  CLEAN_CMD="rm -f \"${PKG_NAME}\""
+elif command -v dnf >/dev/null 2>&1; then
+  PKG_SYS="rpm"
+  PKG_NAME="rustdesk-${RUSTDESK_VERSION}-${PKG_ARCH}.rpm"
+  INSTALL_DEPS='dnf install -y wget ca-certificates xorg-x11-server-Xvfb dbus-x11 || true'
+  INSTALL_CMD="dnf install -y ./${PKG_NAME}"
+  CLEAN_CMD="rm -f \"${PKG_NAME}\""
+elif command -v yum >/dev/null 2>&1; then
+  PKG_SYS="rpm"
+  PKG_NAME="rustdesk-${RUSTDESK_VERSION}-${PKG_ARCH}.rpm"
+  INSTALL_DEPS='yum install -y wget ca-certificates xorg-x11-server-Xvfb dbus-x11 || true'
+  INSTALL_CMD="yum install -y ./${PKG_NAME}"
+  CLEAN_CMD="rm -f \"${PKG_NAME}\""
+else
+  echo "Unsupported distro: need apt, dnf, or yum."
+  exit 1
+fi
+
+# ---- install rustdesk if missing ----
+if ! command -v rustdesk >/dev/null 2>&1; then
+  echo "Installing dependencies…"
+  bash -lc "$INSTALL_DEPS"
+
+  echo "Downloading RustDesk ${RUSTDESK_VERSION} (${PKG_SYS}, ${PKG_ARCH})…"
+  URL="https://github.com/rustdesk/rustdesk/releases/download/${RUSTDESK_VERSION}/${PKG_NAME}"
+  wget -q "$URL"
+
+  echo "Installing RustDesk…"
+  bash -lc "$INSTALL_CMD"
+
+  echo "Cleaning up…"
+  bash -lc "$CLEAN_CMD"
+fi
+
+# ---- start virtual display ----
+echo "Starting Xvfb with resolution ${XVFB_RESOLUTION}…"
+Xvfb :99 -screen 0 "${XVFB_RESOLUTION}" &
+export DISPLAY=:99
+
+# ---- create (or accept) password and start rustdesk ----
+if [[ -z "${RUSTDESK_PASSWORD}" ]]; then
+  RUSTDESK_PASSWORD="$(tr -dc 'a-zA-Z0-9' </dev/urandom | head -c 6)"
+fi
+
+# give the desktop a moment to come up if you launch XFCE/etc elsewhere
+sleep 3
+
+# set password (daemonless; rustdesk CLI handles it)
+rustdesk --password "${RUSTDESK_PASSWORD}" >/dev/null 2>&1 || true
+rustdesk &
+
+sleep 3
+RID="$(rustdesk --get-id || true)"
+
+echo "-----------------------------"
+echo " RustDesk ID:        ${RID}"
+echo " RustDesk Password:  ${RUSTDESK_PASSWORD}"
+echo " Display (Xvfb):     ${DISPLAY} (${XVFB_RESOLUTION})"
+echo "-----------------------------"
+
+# keep the script alive if needed (helpful in some runners)
+wait -n || true