Update server_base_path format logic in modules

This change addresses the improvement of readability and consistency by simplifying the `server_base_path` construction logic, thereby enhancing maintainability across the respective Terraform modules.
Refactor devolutions-patch.js for reduced indent size
2024-10-22 11:58:54 +05:00 · 2024-10-22 11:41:32 +05:00 · 2024-10-22 11:30:40 +05:00 · 2024-10-22 10:44:00 +05:00
20 changed files with 378 additions and 325 deletions
--- a/filebrowser/README.md
+++ b/filebrowser/README.md
@@ -45,11 +45,23 @@ module "filebrowser" {
 }
 ```

-### Serve from the same domain (no subdomain)
+### Serve on a subpath (no wildcard subdomain)

 ```tf
 module "filebrowser" {
  source    = "registry.coder.com/modules/filebrowser/coder"
+  version   = "1.0.23"
+  agent_id  = coder_agent.example.id
+  subdomain = false
+}
+```
+
+### Serve on a subpath with a specific agent name (multiple agents)
+
+```tf
+module "filebrowser" {
+  source     = "registry.coder.com/modules/filebrowser/coder"
+  version    = "1.0.23"
  agent_id   = coder_agent.example.id
  agent_name = "main"
  subdomain  = false
--- a/filebrowser/run.sh
+++ b/filebrowser/run.sh
@@ -1,13 +1,9 @@
 #!/usr/bin/env bash

 BOLD='\033[0;1m'
-
 printf "$${BOLD}Installing filebrowser \n\n"

-# Check if filebrowser is installed
-if ! command -v filebrowser &> /dev/null; then
-  curl -fsSL https://raw.githubusercontent.com/filebrowser/get/master/get.sh | bash
-fi
+curl -fsSL https://raw.githubusercontent.com/filebrowser/get/master/get.sh | bash

 printf "🥳 Installation complete! \n\n"

--- a/jetbrains-gateway/README.md
+++ b/jetbrains-gateway/README.md
@@ -14,12 +14,12 @@ This module adds a JetBrains Gateway Button to open any workspace with a single
 ```tf
 module "jetbrains_gateway" {
  source         = "registry.coder.com/modules/jetbrains-gateway/coder"
-  version        = "1.0.24"
+  version        = "1.0.23"
  agent_id       = coder_agent.example.id
  agent_name     = "example"
  folder         = "/home/coder/example"
  jetbrains_ides = ["CL", "GO", "IU", "PY", "WS"]
-  default        = ["GO"]
+  default        = "GO"
 }
 ```

@@ -32,12 +32,12 @@ module "jetbrains_gateway" {
 ```tf
 module "jetbrains_gateway" {
  source         = "registry.coder.com/modules/jetbrains-gateway/coder"
-  version        = "1.0.24"
+  version        = "1.0.23"
  agent_id       = coder_agent.example.id
  agent_name     = "example"
  folder         = "/home/coder/example"
  jetbrains_ides = ["GO", "WS"]
-  default        = ["GO"]
+  default        = "GO"
 }
 ```

@@ -46,12 +46,12 @@ module "jetbrains_gateway" {
 ```tf
 module "jetbrains_gateway" {
  source         = "registry.coder.com/modules/jetbrains-gateway/coder"
-  version        = "1.0.24"
+  version        = "1.0.23"
  agent_id       = coder_agent.example.id
  agent_name     = "example"
  folder         = "/home/coder/example"
  jetbrains_ides = ["GO", "WS"]
-  default        = ["GO"]
+  default        = "GO"
  latest         = true
 }
 ```
@@ -61,49 +61,17 @@ module "jetbrains_gateway" {
 ```tf
 module "jetbrains_gateway" {
  source         = "registry.coder.com/modules/jetbrains-gateway/coder"
-  version        = "1.0.24"
+  version        = "1.0.23"
  agent_id       = coder_agent.example.id
  agent_name     = "example"
  folder         = "/home/coder/example"
  jetbrains_ides = ["GO", "WS"]
-  default        = ["GO"]
+  default        = "GO"
  latest         = true
  channel        = "eap"
 }
 ```

-### Add Multiple IDEs with the default set to GoLand
-
-```tf
-module "jetbrains_gateway" {
-  source         = "registry.coder.com/modules/jetbrains-gateway/coder"
-  version        = "1.0.24"
-  agent_id       = coder_agent.example.id
-  agent_name     = "example"
-  folder         = "/home/coder/example"
-  jetbrains_ides = ["GO", "WS", "RD", "PY"]
-  default        = ["GO", "PY"]
-}
-```
-
-### Custom release download link
-
-Due to the highest priority of the `ide_download_link` parameter in the `(jetbrains-gateway://...` within IDEA, the pre-configured download address will be overridden when using [IDEA's offline mode](https://www.jetbrains.com/help/idea/fully-offline-mode.html). Therefore, it is necessary to configure the `download_base_link` parameter for the `jetbrains_gateway` module to change the value of `ide_download_link`.
-
-```tf
-module "jetbrains_gateway" {
-  source             = "registry.coder.com/modules/jetbrains-gateway/coder"
-  version            = "1.0.24"
-  agent_id           = coder_agent.example.id
-  agent_name         = "example"
-  folder             = "/home/coder/example"
-  jetbrains_ides     = ["GO", "WS"]
-  releases_base_link = "https://releases.internal.site/"
-  download_base_link = "https://download.internal.site/"
-  default            = ["GO"]
-}
-```
-
 ## Supported IDEs

 This module and JetBrains Gateway support the following JetBrains IDEs:
--- a/jetbrains-gateway/main.tf
+++ b/jetbrains-gateway/main.tf
@@ -20,13 +20,13 @@ variable "agent_id" {

 variable "slug" {
  type        = string
-  description = "The slug for the coder_app"
+  description = "The slug for the coder_app resource."
  default     = "gateway"
 }

 variable "agent_name" {
  type        = string
-  description = "Agent name."
+  description = "The name of the coder_agent resource."
 }

 variable "folder" {
@@ -39,9 +39,9 @@ variable "folder" {
 }

 variable "default" {
-  default     = []
-  type        = list(string)
-  description = "Default IDEs to be added to the Workspace page."
+  default     = ""
+  type        = string
+  description = "Default IDE"
 }

 variable "order" {
@@ -146,35 +146,9 @@ variable "jetbrains_ides" {
  }
 }

-variable "releases_base_link" {
-  type        = string
-  description = ""
-  default     = "https://data.services.jetbrains.com"
-  validation {
-    condition     = can(regex("^https?://.+$", var.releases_base_link))
-    error_message = "The releases_base_link must be a valid HTTP/S address."
-  }
-}
-
-variable "download_base_link" {
-  type        = string
-  description = ""
-  default     = "https://download.jetbrains.com"
-  validation {
-    condition     = can(regex("^https?://.+$", var.download_base_link))
-    error_message = "The download_base_link must be a valid HTTP/S address."
-  }
-}
-
-variable "provide_options" {
-  type        = bool
-  description = "Whether to provide coder_parameter options."
-  default     = true
-}
-
 data "http" "jetbrains_ide_versions" {
  for_each = var.latest ? toset(var.jetbrains_ides) : toset([])
-  url      = "${var.releases_base_link}/products/releases?code=${each.key}&latest=true&type=${var.channel}"
+  url      = "https://data.services.jetbrains.com/products/releases?code=${each.key}&latest=true&type=${var.channel}"
 }

 locals {
@@ -184,7 +158,7 @@ locals {
      name          = "GoLand",
      identifier    = "GO",
      build_number  = var.jetbrains_ide_versions["GO"].build_number,
-      download_link = "${var.download_base_link}/go/goland-${var.jetbrains_ide_versions["GO"].version}.tar.gz"
+      download_link = "https://download.jetbrains.com/go/goland-${var.jetbrains_ide_versions["GO"].version}.tar.gz"
      version       = var.jetbrains_ide_versions["GO"].version
    },
    "WS" = {
@@ -192,7 +166,7 @@ locals {
      name          = "WebStorm",
      identifier    = "WS",
      build_number  = var.jetbrains_ide_versions["WS"].build_number,
-      download_link = "${var.download_base_link}/webstorm/WebStorm-${var.jetbrains_ide_versions["WS"].version}.tar.gz"
+      download_link = "https://download.jetbrains.com/webstorm/WebStorm-${var.jetbrains_ide_versions["WS"].version}.tar.gz"
      version       = var.jetbrains_ide_versions["WS"].version
    },
    "IU" = {
@@ -200,7 +174,7 @@ locals {
      name          = "IntelliJ IDEA Ultimate",
      identifier    = "IU",
      build_number  = var.jetbrains_ide_versions["IU"].build_number,
-      download_link = "${var.download_base_link}/idea/ideaIU-${var.jetbrains_ide_versions["IU"].version}.tar.gz"
+      download_link = "https://download.jetbrains.com/idea/ideaIU-${var.jetbrains_ide_versions["IU"].version}.tar.gz"
      version       = var.jetbrains_ide_versions["IU"].version
    },
    "PY" = {
@@ -208,7 +182,7 @@ locals {
      name          = "PyCharm Professional",
      identifier    = "PY",
      build_number  = var.jetbrains_ide_versions["PY"].build_number,
-      download_link = "${var.download_base_link}/python/pycharm-professional-${var.jetbrains_ide_versions["PY"].version}.tar.gz"
+      download_link = "https://download.jetbrains.com/python/pycharm-professional-${var.jetbrains_ide_versions["PY"].version}.tar.gz"
      version       = var.jetbrains_ide_versions["PY"].version
    },
    "CL" = {
@@ -216,7 +190,7 @@ locals {
      name          = "CLion",
      identifier    = "CL",
      build_number  = var.jetbrains_ide_versions["CL"].build_number,
-      download_link = "${var.download_base_link}/cpp/CLion-${var.jetbrains_ide_versions["CL"].version}.tar.gz"
+      download_link = "https://download.jetbrains.com/cpp/CLion-${var.jetbrains_ide_versions["CL"].version}.tar.gz"
      version       = var.jetbrains_ide_versions["CL"].version
    },
    "PS" = {
@@ -224,7 +198,7 @@ locals {
      name          = "PhpStorm",
      identifier    = "PS",
      build_number  = var.jetbrains_ide_versions["PS"].build_number,
-      download_link = "${var.download_base_link}/webide/PhpStorm-${var.jetbrains_ide_versions["PS"].version}.tar.gz"
+      download_link = "https://download.jetbrains.com/webide/PhpStorm-${var.jetbrains_ide_versions["PS"].version}.tar.gz"
      version       = var.jetbrains_ide_versions["PS"].version
    },
    "RM" = {
@@ -232,7 +206,7 @@ locals {
      name          = "RubyMine",
      identifier    = "RM",
      build_number  = var.jetbrains_ide_versions["RM"].build_number,
-      download_link = "${var.download_base_link}/ruby/RubyMine-${var.jetbrains_ide_versions["RM"].version}.tar.gz"
+      download_link = "https://download.jetbrains.com/ruby/RubyMine-${var.jetbrains_ide_versions["RM"].version}.tar.gz"
      version       = var.jetbrains_ide_versions["RM"].version
    }
    "RD" = {
@@ -240,24 +214,28 @@ locals {
      name          = "Rider",
      identifier    = "RD",
      build_number  = var.jetbrains_ide_versions["RD"].build_number,
-      download_link = "${var.download_base_link}/rider/JetBrains.Rider-${var.jetbrains_ide_versions["RD"].version}.tar.gz"
+      download_link = "https://download.jetbrains.com/rider/JetBrains.Rider-${var.jetbrains_ide_versions["RD"].version}.tar.gz"
      version       = var.jetbrains_ide_versions["RD"].version
    }
  }

-  default_ide_map = {
-    for ide in var.default : ide => local.jetbrains_ides[ide]
-  }
+  icon          = local.jetbrains_ides[data.coder_parameter.jetbrains_ide.value].icon
+  json_data     = var.latest ? jsondecode(data.http.jetbrains_ide_versions[data.coder_parameter.jetbrains_ide.value].response_body) : {}
+  key           = var.latest ? keys(local.json_data)[0] : ""
+  display_name  = local.jetbrains_ides[data.coder_parameter.jetbrains_ide.value].name
+  identifier    = data.coder_parameter.jetbrains_ide.value
+  download_link = var.latest ? local.json_data[local.key][0].downloads.linux.link : local.jetbrains_ides[data.coder_parameter.jetbrains_ide.value].download_link
+  build_number  = var.latest ? local.json_data[local.key][0].build : local.jetbrains_ides[data.coder_parameter.jetbrains_ide.value].build_number
+  version       = var.latest ? local.json_data[local.key][0].version : var.jetbrains_ide_versions[data.coder_parameter.jetbrains_ide.value].version
 }

 data "coder_parameter" "jetbrains_ide" {
-  for_each     = local.default_ide_map
  type         = "string"
-  name         = "jetbrains_ide_${each.key}"
-  display_name = "JetBrains IDE ${each.key}"
+  name         = "jetbrains_ide"
+  display_name = "JetBrains IDE"
  icon         = "/icon/gateway.svg"
  mutable      = true
-  default      = each.key
+  default      = var.default == "" ? var.jetbrains_ides[0] : var.default
  order        = var.coder_parameter_order

  dynamic "option" {
@@ -274,44 +252,50 @@ data "coder_workspace" "me" {}
 data "coder_workspace_owner" "me" {}

 resource "coder_app" "gateway" {
-  for_each     = local.default_ide_map
  agent_id     = var.agent_id
-  slug         = "${var.slug}-${lower(each.key)}"
-  display_name = each.value.name
-  icon         = each.value.icon
+  slug         = var.slug
+  display_name = local.display_name
+  icon         = local.icon
  external     = true
  order        = var.order
-  url = join("", [
-    "jetbrains-gateway://connect#type=coder&workspace=",
+  url = format(
+    "jetbrains-gateway://connect#type=coder&workspace=%s&owner=%s&agent=%s&folder=%s&url=%s&token=%s&ide_product_code=%s&ide_build_number=%s&ide_download_link=%s",
    data.coder_workspace.me.name,
-    "&owner=",
    data.coder_workspace_owner.me.name,
-    "&agent=",
    var.agent_name,
-    "&folder=",
    var.folder,
-    "&url=",
    data.coder_workspace.me.access_url,
-    "&token=",
    "$SESSION_TOKEN",
-    "&ide_product_code=",
-    each.key,
-    "&ide_build_number=",
-    each.value.build_number,
-    "&ide_download_link=",
-    each.value.download_link,
-  ])
+    data.coder_parameter.jetbrains_ide.value,
+    local.build_number,
+    local.download_link
+  )
 }

-output "coder_apps" {
-  value = {
-    for key, app in coder_app.gateway : key => {
-      identifier    = key
-      display_name  = app.display_name
-      icon          = local.jetbrains_ides[key].icon
-      download_link = local.jetbrains_ides[key].download_link
-      build_number  = local.jetbrains_ides[key].build_number
-      version       = local.jetbrains_ides[key].version
-    }
-  }
+output "identifier" {
+  value = local.identifier
+}
+
+output "display_name" {
+  value = local.display_name
+}
+
+output "icon" {
+  value = local.icon
+}
+
+output "download_link" {
+  value = local.download_link
+}
+
+output "build_number" {
+  value = local.build_number
+}
+
+output "version" {
+  value = local.version
+}
+
+output "url" {
+  value = coder_app.gateway.url
 }
--- a/jupyter-notebook/README.md
+++ b/jupyter-notebook/README.md
@@ -11,12 +11,36 @@ tags: [jupyter, helper, ide, web]

 A module that adds Jupyter Notebook in your Coder template.

+```tf
+module "jupyter-notebook" {
+  source   = "registry.coder.com/modules/jupyter-notebook/coder"
+  version  = "1.0.23"
+  agent_id = coder_agent.example.id
+}
+```
+
 ![Jupyter Notebook](../.images/jupyter-notebook.png)

+## Examples
+
+### Serve on a subpath (no wildcard subdomain)
+
 ```tf
 module "jupyter-notebook" {
  source    = "registry.coder.com/modules/jupyter-notebook/coder"
-  version  = "1.0.19"
+  version   = "1.0.23"
  agent_id  = coder_agent.example.id
+  subdomain = false
+}
+```
+
+### Serve on a subpath with a specific agent name (multiple agents)
+
+```tf
+module "jupyter-notebook" {
+  source     = "registry.coder.com/modules/jupyter-notebook/coder"
+  version    = "1.0.23"
+  agent_id   = coder_agent.example.id
+  agent_name = "main"
 }
 ```
--- a/jupyter-notebook/main.tf
+++ b/jupyter-notebook/main.tf
@@ -42,9 +42,30 @@ variable "order" {
  default     = null
 }

+variable "agent_name" {
+  type        = string
+  description = "The name of the coder_agent resource. (Only required if subdomain is false and the template uses multiple agents.)"
+  default     = null
+}
+
+variable "slug" {
+  type        = string
+  description = "The slug of the coder_app resource."
+  default     = "jupyter-notebook"
+}
+
+variable "subdomain" {
+  type        = bool
+  description = <<-EOT
+    Determines whether the app will be accessed via it's own subdomain or whether it will be accessed via a path on Coder.
+    If wildcards have not been setup by the administrator then apps with "subdomain" set to true will not be accessible.
+  EOT
+  default     = true
+}
+
 resource "coder_script" "jupyter-notebook" {
  agent_id     = var.agent_id
-  display_name = "jupyter-notebook"
+  display_name = "Jupyter Notebook"
  icon         = "/icon/jupyter.svg"
  script = templatefile("${path.module}/run.sh", {
    LOG_PATH : var.log_path,
@@ -55,11 +76,26 @@ resource "coder_script" "jupyter-notebook" {

 resource "coder_app" "jupyter-notebook" {
  agent_id     = var.agent_id
-  slug         = "jupyter-notebook"
+  slug         = var.slug
  display_name = "Jupyter Notebook"
-  url          = "http://localhost:${var.port}"
+  url          = local.url
  icon         = "/icon/jupyter.svg"
  subdomain    = true
  share        = var.share
  order        = var.order
+
+  healthcheck {
+    url       = local.healthcheck_url
+    interval  = 5
+    threshold = 6
+  }
+}
+
+data "coder_workspace_owner" "me" {}
+data "coder_workspace" "me" {}
+
+locals {
+  server_base_path = var.subdomain ? "" : format("/@%s/%s%s/apps/%s", data.coder_workspace_owner.me.name, data.coder_workspace.me.name, var.agent_name != null ? ".${var.agent_name}" : "", var.slug)
+  url              = "http://localhost:${var.port}${local.server_base_path}"
+  healthcheck_url  = "http://localhost:${var.port}${local.server_base_path}/api"
 }
--- a/jupyterlab/README.md
+++ b/jupyterlab/README.md
@@ -11,8 +11,6 @@ tags: [jupyter, helper, ide, web]

 A module that adds JupyterLab in your Coder template.

-![JupyterLab](../.images/jupyterlab.png)
-
 ```tf
 module "jupyterlab" {
  source   = "registry.coder.com/modules/jupyterlab/coder"
@@ -20,3 +18,29 @@ module "jupyterlab" {
  agent_id = coder_agent.example.id
 }
 ```
+
+![JupyterLab](../.images/jupyterlab.png)
+
+## Examples
+
+### Serve on a subpath (no wildcard subdomain)
+
+```tf
+module "jupyterlab" {
+  source    = "registry.coder.com/modules/jupyterlab/coder"
+  version   = "1.0.23"
+  agent_id  = coder_agent.example.id
+  subdomain = false
+}
+```
+
+### Serve on a subpath with a specific agent name (multiple agents)
+
+```tf
+module "jupyterlab" {
+  source     = "registry.coder.com/modules/jupyterlab/coder"
+  version    = "1.0.23"
+  agent_id   = coder_agent.example.id
+  agent_name = "main"
+}
+```
--- a/jupyterlab/main.tf
+++ b/jupyterlab/main.tf
@@ -41,7 +41,10 @@ variable "share" {

 variable "subdomain" {
  type        = bool
-  description = "Determines whether JupyterLab will be accessed via its own subdomain or whether it will be accessed via a path on Coder."
+  description = <<-EOT
+    Determines whether the app will be accessed via it's own subdomain or whether it will be accessed via a path on Coder.
+    If wildcards have not been setup by the administrator then apps with "subdomain" set to true will not be accessible.
+  EOT
  default     = true
 }

@@ -51,6 +54,18 @@ variable "order" {
  default     = null
 }

+variable "agent_name" {
+  type        = string
+  description = "The name of the coder_agent resource. (Only required if subdomain is false and the template uses multiple agents.)"
+  default     = null
+}
+
+variable "slug" {
+  type        = string
+  description = "The slug of the coder_app resource."
+  default     = "jupyterlab"
+}
+
 resource "coder_script" "jupyterlab" {
  agent_id     = var.agent_id
  display_name = "jupyterlab"
@@ -58,18 +73,24 @@ resource "coder_script" "jupyterlab" {
  script = templatefile("${path.module}/run.sh", {
    LOG_PATH : var.log_path,
    PORT : var.port
-    BASE_URL : var.subdomain ? "" : "/@${data.coder_workspace_owner.me.name}/${data.coder_workspace.me.name}/apps/jupyterlab"
+    BASE_URL : local.server_base_path
  })
  run_on_start = true
 }

 resource "coder_app" "jupyterlab" {
  agent_id     = var.agent_id
-  slug         = "jupyterlab" # sync with the usage in URL
+  slug         = var.slug
  display_name = "JupyterLab"
-  url          = var.subdomain ? "http://localhost:${var.port}" : "http://localhost:${var.port}/@${data.coder_workspace_owner.me.name}/${data.coder_workspace.me.name}/apps/jupyterlab"
+  url          = local.url
  icon         = "/icon/jupyter.svg"
  subdomain    = var.subdomain
  share        = var.share
  order        = var.order
 }
+
+locals {
+  server_base_path = var.subdomain ? "" : format("/@%s/%s%s/apps/%s", data.coder_workspace_owner.me.name, data.coder_workspace.me.name, var.agent_name != null ? ".${var.agent_name}" : "", var.slug)
+  url              = "http://localhost:${var.port}${local.server_base_path}"
+  healthcheck_url  = "http://localhost:${var.port}${local.server_base_path}/api"
+}
--- a/jupyterlab/run.sh
+++ b/jupyterlab/run.sh
@@ -9,7 +9,7 @@ BOLD='\033[0;1m'
 printf "$${BOLD}Installing jupyterlab!\n"

 # check if jupyterlab is installed
-if ! command -v jupyter-lab > /dev/null 2>&1; then
+if ! command -v jupyterlab > /dev/null 2>&1; then
  # install jupyterlab
  # check if pipx is installed
  if ! command -v pipx > /dev/null 2>&1; then
--- a/kasmvnc/README.md
+++ b/kasmvnc/README.md
@@ -14,7 +14,7 @@ Automatically install [KasmVNC](https://kasmweb.com/kasmvnc) in a workspace, and
 ```tf
 module "kasmvnc" {
  source              = "registry.coder.com/modules/kasmvnc/coder"
-  version             = "1.0.23"
+  version             = "1.0.22"
  agent_id            = coder_agent.example.id
  desktop_environment = "xfce"
 }
--- a/kasmvnc/main.tf
+++ b/kasmvnc/main.tf
@@ -42,7 +42,7 @@ resource "coder_script" "kasm_vnc" {
  script = templatefile("${path.module}/run.sh", {
    PORT : var.port,
    DESKTOP_ENVIRONMENT : var.desktop_environment,
-    KASM_VERSION : var.kasm_version
+    VERSION : var.kasm_version
  })
  run_on_start = true
 }
--- a/kasmvnc/run.sh
+++ b/kasmvnc/run.sh
@@ -1,7 +1,6 @@
 #!/usr/bin/env bash

-# Exit on error, undefined variables, and pipe failures
-set -euo pipefail
+#!/bin/bash

 # Function to check if vncserver is already installed
 check_installed() {
@@ -15,167 +14,143 @@ check_installed() {

 # Function to download a file using wget, curl, or busybox as a fallback
 download_file() {
-  local url="$1"
-  local output="$2"
-  local download_tool
-
-  if command -v curl &> /dev/null; then
-    # shellcheck disable=SC2034
-    download_tool=(curl -fsSL)
-  elif command -v wget &> /dev/null; then
-    # shellcheck disable=SC2034
-    download_tool=(wget -q -O-)
+  local url=$1
+  local output=$2
+  if command -v wget &> /dev/null; then
+    wget $url -O $output
+  elif command -v curl &> /dev/null; then
+    curl -fsSL $url -o $output
  elif command -v busybox &> /dev/null; then
-    # shellcheck disable=SC2034
-    download_tool=(busybox wget -O-)
+    busybox wget -O $output $url
  else
-    echo "ERROR: No download tool available (curl, wget, or busybox required)"
+    echo "Neither wget, curl, nor busybox is installed. Please install one of them to proceed."
    exit 1
  fi
-
-  # shellcheck disable=SC2288
-  "$${download_tool[@]}" "$url" > "$output" || {
-    echo "ERROR: Failed to download $url"
-    exit 1
-  }
 }

 # Function to install kasmvncserver for debian-based distros
 install_deb() {
  local url=$1
-  local kasmdeb="/tmp/kasmvncserver.deb"
+  download_file $url /tmp/kasmvncserver.deb
+  sudo apt-get update
+  DEBIAN_FRONTEND=noninteractive sudo apt-get install --yes -qq --no-install-recommends --no-install-suggests /tmp/kasmvncserver.deb
+  sudo adduser $USER ssl-cert
+  rm /tmp/kasmvncserver.deb
+}

-  download_file "$url" "$kasmdeb"
+# Function to install kasmvncserver for Oracle 8
+install_rpm_oracle8() {
+  local url=$1
+  download_file $url /tmp/kasmvncserver.rpm
+  sudo dnf config-manager --set-enabled ol8_codeready_builder
+  sudo dnf install oracle-epel-release-el8 -y
+  sudo dnf localinstall /tmp/kasmvncserver.rpm -y
+  sudo usermod -aG kasmvnc-cert $USER
+  rm /tmp/kasmvncserver.rpm
+}

-  CACHE_DIR="/var/lib/apt/lists/partial"
-  # Check if the directory exists and was modified in the last 60 minutes
-  if [[ ! -d "$CACHE_DIR" ]] || ! find "$CACHE_DIR" -mmin -60 -print -quit &> /dev/null; then
-    echo "Stale package cache, updating..."
-    # Update package cache with a 300-second timeout for dpkg lock
-    sudo apt-get -o DPkg::Lock::Timeout=300 -qq update
-  fi
-
-  DEBIAN_FRONTEND=noninteractive sudo apt-get -o DPkg::Lock::Timeout=300 install --yes -qq --no-install-recommends --no-install-suggests "$kasmdeb"
-  rm "$kasmdeb"
+# Function to install kasmvncserver for CentOS 7
+install_rpm_centos7() {
+  local url=$1
+  download_file $url /tmp/kasmvncserver.rpm
+  sudo yum install epel-release -y
+  sudo yum install /tmp/kasmvncserver.rpm -y
+  sudo usermod -aG kasmvnc-cert $USER
+  rm /tmp/kasmvncserver.rpm
 }

 # Function to install kasmvncserver for rpm-based distros
 install_rpm() {
  local url=$1
-  local kasmrpm="/tmp/kasmvncserver.rpm"
-  local package_manager
-
-  if command -v dnf &> /dev/null; then
-    # shellcheck disable=SC2034
-    package_manager=(dnf localinstall -y)
-  elif command -v zypper &> /dev/null; then
-    # shellcheck disable=SC2034
-    package_manager=(zypper install -y)
-  elif command -v yum &> /dev/null; then
-    # shellcheck disable=SC2034
-    package_manager=(yum localinstall -y)
-  elif command -v rpm &> /dev/null; then
-    # Do we need to manually handle missing dependencies?
-    # shellcheck disable=SC2034
-    package_manager=(rpm -i)
-  else
-    echo "ERROR: No supported package manager available (dnf, zypper, yum, or rpm required)"
-    exit 1
-  fi
-
-  download_file "$url" "$kasmrpm"
-
-  # shellcheck disable=SC2288
-  sudo "$${package_manager[@]}" "$kasmrpm" || {
-    echo "ERROR: Failed to install $kasmrpm"
-    exit 1
-  }
-
-  rm "$kasmrpm"
+  download_file $url /tmp/kasmvncserver.rpm
+  sudo rpm -i /tmp/kasmvncserver.rpm
+  rm /tmp/kasmvncserver.rpm
 }

 # Function to install kasmvncserver for Alpine Linux
 install_alpine() {
  local url=$1
-  local kasmtgz="/tmp/kasmvncserver.tgz"
-
-  download_file "$url" "$kasmtgz"
-
-  tar -xzf "$kasmtgz" -C /usr/local/bin/
-  rm "$kasmtgz"
+  download_file $url /tmp/kasmvncserver.tgz
+  tar -xzf /tmp/kasmvncserver.tgz -C /usr/local/bin/
+  rm /tmp/kasmvncserver.tgz
 }

 # Detect system information
-if [[ ! -f /etc/os-release ]]; then
-  echo "ERROR: Cannot detect OS: /etc/os-release not found"
-  exit 1
-fi
-
-# shellcheck disable=SC1091
-source /etc/os-release
-distro="$ID"
-distro_version="$VERSION_ID"
-codename="$VERSION_CODENAME"
-arch="$(uname -m)"
-if [[ "$ID" == "ol" ]]; then
-  distro="oracle"
-  distro_version="$${distro_version%%.*}"
-elif [[ "$ID" == "fedora" ]]; then
-  distro_version="$(grep -oP '\(\K[\w ]+' /etc/fedora-release | tr '[:upper:]' '[:lower:]' | tr -d ' ')"
-fi
+distro=$(grep "^ID=" /etc/os-release | awk -F= '{print $2}')
+version=$(grep "^VERSION_ID=" /etc/os-release | awk -F= '{print $2}' | tr -d '"')
+arch=$(uname -m)

 echo "Detected Distribution: $distro"
-echo "Detected Version: $distro_version"
-echo "Detected Codename: $codename"
+echo "Detected Version: $version"
 echo "Detected Architecture: $arch"

 # Map arch to package arch
-case "$arch" in
-  x86_64)
-    if [[ "$distro" =~ ^(ubuntu|debian|kali)$ ]]; then
+if [[ "$arch" == "x86_64" ]]; then
+  if [[ "$distro" == "ubuntu" || "$distro" == "debian" || "$distro" == "kali" ]]; then
    arch="amd64"
+  else
+    arch="x86_64"
  fi
-    ;;
-  aarch64)
-    if [[ "$distro" =~ ^(ubuntu|debian|kali)$ ]]; then
+elif [[ "$arch" == "aarch64" || "$arch" == "arm64" ]]; then
+  if [[ "$distro" == "ubuntu" || "$distro" == "debian" || "$distro" == "kali" ]]; then
    arch="arm64"
+  else
+    arch="aarch64"
  fi
-    ;;
-  arm64)
-    : # This is effectively a noop
-    ;;
-  *)
-    echo "ERROR: Unsupported architecture: $arch"
+else
+  echo "Unsupported architecture: $arch"
  exit 1
-    ;;
-esac
+fi

 # Check if vncserver is installed, and install if not
 if ! check_installed; then
-  # Check for NOPASSWD sudo (required)
-  if ! command -v sudo &> /dev/null || ! sudo -n true 2> /dev/null; then
-    echo "ERROR: sudo NOPASSWD access required!"
-    exit 1
-  fi
-
-  base_url="https://github.com/kasmtech/KasmVNC/releases/download/v${KASM_VERSION}"
-
-  echo "Installing KASM version: ${KASM_VERSION}"
+  echo "Installing KASM version: ${VERSION}"
  case $distro in
    ubuntu | debian | kali)
-      bin_name="kasmvncserver_$${codename}_${KASM_VERSION}_$${arch}.deb"
-      install_deb "$base_url/$bin_name"
+      case $version in
+        "20.04")
+          install_deb "https://github.com/kasmtech/KasmVNC/releases/download/v${VERSION}/kasmvncserver_focal_${VERSION}_$${arch}.deb"
          ;;
-    oracle | fedora | opensuse)
-      bin_name="kasmvncserver_$${distro}_$${distro_version}_${KASM_VERSION}_$${arch}.rpm"
-      install_rpm "$base_url/$bin_name"
+        "22.04")
+          install_deb "https://github.com/kasmtech/KasmVNC/releases/download/v${VERSION}/kasmvncserver_jammy_${VERSION}_$${arch}.deb"
          ;;
-    alpine)
-      bin_name="kasmvnc.alpine_$${distro_version//./}_$${arch}.tgz"
-      install_alpine "$base_url/$bin_name"
+        "24.04")
+          install_deb "https://github.com/kasmtech/KasmVNC/releases/download/v${VERSION}/kasmvncserver_noble_${VERSION}_$${arch}.deb"
          ;;
        *)
-      echo "Unsupported distribution: $distro"
+          echo "Unsupported Ubuntu/Debian/Kali version: $${version}"
+          exit 1
+          ;;
+      esac
+      ;;
+    oracle)
+      if [[ "$version" == "8" ]]; then
+        install_rpm_oracle8 "https://github.com/kasmtech/KasmVNC/releases/download/v${VERSION}/kasmvncserver_oracle_8_${VERSION}_$${arch}.rpm"
+      else
+        echo "Unsupported Oracle version: $${version}"
+        exit 1
+      fi
+      ;;
+    centos)
+      if [[ "$version" == "7" ]]; then
+        install_rpm_centos7 "https://github.com/kasmtech/KasmVNC/releases/download/v${VERSION}/kasmvncserver_centos_core_${VERSION}_$${arch}.rpm"
+      else
+        install_rpm "https://github.com/kasmtech/KasmVNC/releases/download/v${VERSION}/kasmvncserver_centos_core_${VERSION}_$${arch}.rpm"
+      fi
+      ;;
+    alpine)
+      if [[ "$version" == "3.17" || "$version" == "3.18" || "$version" == "3.19" || "$version" == "3.20" ]]; then
+        install_alpine "https://github.com/kasmtech/KasmVNC/releases/download/v${VERSION}/kasmvnc.alpine_$${version}_$${arch}.tgz"
+      else
+        echo "Unsupported Alpine version: $${version}"
+        exit 1
+      fi
+      ;;
+    fedora | opensuse)
+      install_rpm "https://github.com/kasmtech/KasmVNC/releases/download/v${VERSION}/kasmvncserver_$${distro}_$${version}_${VERSION}_$${arch}.rpm"
+      ;;
+    *)
+      echo "Unsupported distribution: $${distro}"
      exit 1
      ;;
  esac
@@ -183,53 +158,22 @@ else
  echo "vncserver already installed. Skipping installation."
 fi

-if command -v sudo &> /dev/null && sudo -n true 2> /dev/null; then
-  kasm_config_file="/etc/kasmvnc/kasmvnc.yaml"
-  SUDO=sudo
-else
-  kasm_config_file="$HOME/.vnc/kasmvnc.yaml"
-  SUDO=
-
-  echo "WARNING: Sudo access not available, using user config dir!"
-
-  if [[ -f "$kasm_config_file" ]]; then
-    echo "WARNING: Custom user KasmVNC config exists, not overwriting!"
-    echo "WARNING: Ensure that you manually configure the appropriate settings."
-    kasm_config_file="/dev/stderr"
-  else
-    echo "WARNING: This may prevent custom user KasmVNC settings from applying!"
-    mkdir -p "$HOME/.vnc"
-  fi
-fi
-
-echo "Writing KasmVNC config to $kasm_config_file"
-$SUDO tee "$kasm_config_file" > /dev/null << EOF
+# Coder port-forwarding from dashboard only supports HTTP
+sudo bash -c "cat > /etc/kasmvnc/kasmvnc.yaml <<EOF
 network:
  protocol: http
  websocket_port: ${PORT}
  ssl:
    require_ssl: false
-    pem_certificate:
-    pem_key:
  udp:
    public_ip: 127.0.0.1
-EOF
+EOF"

 # This password is not used since we start the server without auth.
 # The server is protected via the Coder session token / tunnel
 # and does not listen publicly
-echo -e "password\npassword\n" | vncpasswd -wo -u "$USER"
+echo -e "password\npassword\n" | vncpasswd -wo -u $USER

 # Start the server
 printf "🚀 Starting KasmVNC server...\n"
-vncserver -select-de "${DESKTOP_ENVIRONMENT}" -disableBasicAuth > /tmp/kasmvncserver.log 2>&1 &
-pid=$!
-
-# Wait for server to start
-sleep 5
-grep -v '^[[:space:]]*$' /tmp/kasmvncserver.log | tail -n 10
-if ps -p $pid | grep -q "^$pid"; then
-  echo "ERROR: Failed to start KasmVNC server. Check full logs at /tmp/kasmvncserver.log"
-  exit 1
-fi
-printf "🚀 KasmVNC server started successfully!\n"
+sudo -u $USER bash -c "vncserver -select-de ${DESKTOP_ENVIRONMENT} -disableBasicAuth" > /tmp/kasmvncserver.log 2>&1 &
--- a/vscode-desktop/README.md
+++ b/vscode-desktop/README.md
@@ -16,7 +16,7 @@ Uses the [Coder Remote VS Code Extension](https://github.com/coder/vscode-coder)
 ```tf
 module "vscode" {
  source   = "registry.coder.com/modules/vscode-desktop/coder"
-  version  = "1.0.15"
+  version  = "1.0.23"
  agent_id = coder_agent.example.id
 }
 ```
@@ -28,7 +28,7 @@ module "vscode" {
 ```tf
 module "vscode" {
  source   = "registry.coder.com/modules/vscode-desktop/coder"
-  version  = "1.0.15"
+  version  = "1.0.23"
  agent_id = coder_agent.example.id
  folder   = "/home/coder/project"
 }
--- a/vscode-desktop/main.tf
+++ b/vscode-desktop/main.tf
@@ -20,6 +20,12 @@ variable "folder" {
  default     = ""
 }

+variable "slug" {
+  type        = string
+  description = "The slug of the coder_app resource."
+  default     = "vscode-desktop"
+}
+
 variable "open_recent" {
  type        = bool
  description = "Open the most recent workspace or folder. Falls back to the folder if there is no recent workspace or folder to open."
@@ -39,21 +45,17 @@ resource "coder_app" "vscode" {
  agent_id     = var.agent_id
  external     = true
  icon         = "/icon/code.svg"
-  slug         = "vscode"
+  slug         = var.slug
  display_name = "VS Code Desktop"
  order        = var.order
-  url = join("", [
-    "vscode://coder.coder-remote/open",
-    "?owner=",
+  url = format(
+    "vscode://coder.coder-remote/open?owner=%s&workspace=%s%s%s&url=%s&token=$SESSION_TOKEN",
    data.coder_workspace_owner.me.name,
-    "&workspace=",
    data.coder_workspace.me.name,
-    var.folder != "" ? join("", ["&folder=", var.folder]) : "",
+    var.folder != "" ? "&folder=${var.folder}" : "",
    var.open_recent ? "&openRecent" : "",
-    "&url=",
-    data.coder_workspace.me.access_url,
-    "&token=$SESSION_TOKEN",
-  ])
+    data.coder_workspace.me.access_url
+  )
 }

 output "vscode_url" {
--- a/vscode-web/README.md
+++ b/vscode-web/README.md
@@ -14,7 +14,7 @@ Automatically install [Visual Studio Code Server](https://code.visualstudio.com/
 ```tf
 module "vscode-web" {
  source         = "registry.coder.com/modules/vscode-web/coder"
-  version        = "1.0.22"
+  version        = "1.0.23"
  agent_id       = coder_agent.example.id
  accept_license = true
 }
@@ -29,7 +29,7 @@ module "vscode-web" {
 ```tf
 module "vscode-web" {
  source         = "registry.coder.com/modules/vscode-web/coder"
-  version        = "1.0.22"
+  version        = "1.0.23"
  agent_id       = coder_agent.example.id
  install_prefix = "/home/coder/.vscode-web"
  folder         = "/home/coder"
@@ -42,7 +42,7 @@ module "vscode-web" {
 ```tf
 module "vscode-web" {
  source         = "registry.coder.com/modules/vscode-web/coder"
-  version        = "1.0.22"
+  version        = "1.0.23"
  agent_id       = coder_agent.example.id
  extensions     = ["github.copilot", "ms-python.python", "ms-toolsai.jupyter"]
  accept_license = true
@@ -56,7 +56,7 @@ Configure VS Code's [settings.json](https://code.visualstudio.com/docs/getstarte
 ```tf
 module "vscode-web" {
  source     = "registry.coder.com/modules/vscode-web/coder"
-  version    = "1.0.22"
+  version    = "1.0.23"
  agent_id   = coder_agent.example.id
  extensions = ["dracula-theme.theme-dracula"]
  settings = {
@@ -65,3 +65,26 @@ module "vscode-web" {
  accept_license = true
 }
 ```
+
+### Serve on a subpath (no wildcard subdomain)
+
+```tf
+module "vscode-web" {
+  source    = "registry.coder.com/modules/vscode-web/coder"
+  version   = "1.0.23"
+  agent_id  = coder_agent.example.id
+  subdomain = false
+}
+```
+
+### Serve on a subpath with a specific agent name (multiple agents)
+
+```tf
+module "vscode-web" {
+  source     = "registry.coder.com/modules/vscode-web/coder"
+  version    = "1.0.23"
+  agent_id   = coder_agent.example.id
+  agent_name = "main"
+  subdomain  = false
+}
+```
--- a/vscode-web/main.tf
+++ b/vscode-web/main.tf
@@ -130,6 +130,12 @@ variable "subdomain" {
  default     = true
 }

+variable "agent_name" {
+  type        = string
+  description = "The name of the coder_agent resource. (Only required if subdomain is false and the template uses multiple agents.)"
+  default     = null
+}
+
 data "coder_workspace_owner" "me" {}
 data "coder_workspace" "me" {}

@@ -185,7 +191,7 @@ resource "coder_app" "vscode-web" {
 }

 locals {
-  server_base_path = var.subdomain ? "" : format("/@%s/%s/apps/%s/", data.coder_workspace_owner.me.name, data.coder_workspace.me.name, var.slug)
+  server_base_path = var.subdomain ? "" : format("/@%s/%s%s/apps/%s", data.coder_workspace_owner.me.name, data.coder_workspace.me.name, var.agent_name != null ? ".${var.agent_name}" : "", var.slug)
  url              = var.folder == "" ? "http://localhost:${var.port}${local.server_base_path}" : "http://localhost:${var.port}${local.server_base_path}?folder=${var.folder}"
-  healthcheck_url  = var.subdomain ? "http://localhost:${var.port}/healthz" : "http://localhost:${var.port}${local.server_base_path}/healthz"
+  healthcheck_url  = "http://localhost:${var.port}${local.server_base_path}/healthz"
 }
--- a/windows-rdp/README.md
+++ b/windows-rdp/README.md
@@ -15,7 +15,7 @@ Enable Remote Desktop + a web based client on Windows workspaces, powered by [de
 # AWS example. See below for examples of using this module with other providers
 module "windows_rdp" {
  source      = "registry.coder.com/modules/windows-rdp/coder"
-  version     = "1.0.18"
+  version     = "1.0.23"
  count       = data.coder_workspace.me.start_count
  agent_id    = resource.coder_agent.main.id
  resource_id = resource.aws_instance.dev.id
@@ -33,7 +33,7 @@ module "windows_rdp" {
 ```tf
 module "windows_rdp" {
  source      = "registry.coder.com/modules/windows-rdp/coder"
-  version     = "1.0.18"
+  version     = "1.0.23"
  count       = data.coder_workspace.me.start_count
  agent_id    = resource.coder_agent.main.id
  resource_id = resource.aws_instance.dev.id
@@ -45,7 +45,7 @@ module "windows_rdp" {
 ```tf
 module "windows_rdp" {
  source      = "registry.coder.com/modules/windows-rdp/coder"
-  version     = "1.0.18"
+  version     = "1.0.23"
  count       = data.coder_workspace.me.start_count
  agent_id    = resource.coder_agent.main.id
  resource_id = resource.google_compute_instance.dev[0].id
--- a/windows-rdp/main.tf
+++ b/windows-rdp/main.tf
@@ -39,6 +39,18 @@ variable "admin_password" {
  sensitive = true
 }

+variable "port" {
+  type        = number
+  description = "The port to run the Devolutions Gateway on."
+  default     = 7171
+}
+
+variable "slug" {
+  type        = string
+  description = "The slug of the coder_app resource."
+  default     = "web-rdp"
+}
+
 resource "coder_script" "windows-rdp" {
  agent_id     = var.agent_id
  display_name = "windows-rdp"
@@ -47,6 +59,7 @@ resource "coder_script" "windows-rdp" {
  script = templatefile("${path.module}/powershell-installation-script.tftpl", {
    admin_username = var.admin_username
    admin_password = var.admin_password
+    port           = var.port

    # Wanted to have this be in the powershell template file, but Terraform
    # doesn't allow recursive calls to the templatefile function. Have to feed
@@ -63,14 +76,14 @@ resource "coder_script" "windows-rdp" {
 resource "coder_app" "windows-rdp" {
  agent_id     = var.agent_id
  share        = var.share
-  slug         = "web-rdp"
+  slug         = var.slug
  display_name = "Web RDP"
-  url          = "http://localhost:7171"
+  url          = "http://localhost:${var.port}"
  icon         = "/icon/desktop.svg"
  subdomain    = true

  healthcheck {
-    url       = "http://localhost:7171"
+    url       = "http://localhost:${var.port}"
    interval  = 5
    threshold = 15
  }
@@ -80,7 +93,7 @@ resource "coder_app" "rdp-docs" {
  agent_id     = var.agent_id
  display_name = "Local RDP"
  slug         = "rdp-docs"
-  icon         = "https://raw.githubusercontent.com/matifali/logos/main/windows.svg"
-  url          = "https://coder.com/docs/ides/remote-desktops#rdp-desktop"
+  icon         = "/icon/windows.svg"
+  url          = "https://coder.com/docs/user-guides/workspace-access/remote-desktops#rdp-desktop"
  external     = true
 }
--- a/windows-rdp/powershell-installation-script.tftpl
+++ b/windows-rdp/powershell-installation-script.tftpl
@@ -47,7 +47,7 @@ Install-DGatewayPackage

 # Configure Devolutions Gateway
 $Hostname = "localhost"
-$HttpListener = New-DGatewayListener 'http://*:7171' 'http://*:7171'
+$HttpListener = New-DGatewayListener "http://*:${port}" "http://*:${port}"
 $WebApp = New-DGatewayWebAppConfig -Enabled $true -Authentication None
 $ConfigParams = @{
    Hostname = $Hostname
Author	SHA1	Message	Date
Muhammad Atif Ali	8122e3a3fb	Update server_base_path format logic in modules This change addresses the improvement of readability and consistency by simplifying the `server_base_path` construction logic, thereby enhancing maintainability across the respective Terraform modules.	2024-10-22 11:58:54 +05:00
Muhammad Atif Ali	01a25f7182	Refactor devolutions-patch.js for reduced indent size Refactor the `windows-rdp/devolutions-patch.js` script to use a two-space indentation style from a previous four-space style. This change improves code readability and consistency with the project's codebase formatting style. All functional code remains unaffected; only formatting has been adjusted.	2024-10-22 11:41:32 +05:00
Muhammad Atif Ali	5e02fd8056	Add data sources to Jupyter Notebook module Enables dynamic retrieval of workspace owner and details, improving flexibility and accuracy in referencing coder workspace information.	2024-10-22 11:30:40 +05:00
Muhammad Atif Ali	0b2bc1de9e	Refactor multiple modules for improved flexibility - Transition modules to use slug and agent_name variables for custom configurations. - Update Terraform resources to dynamically generate URLs and paths. - Enhance form handling logic in Devolutions patch script.	2024-10-22 10:44:00 +05:00