Skip to content
This repository was archived by the owner on May 15, 2025. It is now read-only.

README.md

Latest commit

 

History

History
133 lines (113 loc) · 4.25 KB

README.md

File metadata and controls

133 lines (113 loc) · 4.25 KB
display_name JetBrains Gateway
description Add a one-click button to launch JetBrains Gateway IDEs in the dashboard.
icon ../.icons/gateway.svg
maintainer_github coder
verified true
tags
ide
jetbrains
helper
parameter

JetBrains Gateway

This module adds a JetBrains Gateway Button to open any workspace with a single click.

JetBrains recommends a minimum of 4 CPU cores and 8GB of RAM. Consult the JetBrains documentation to confirm other system requirements.

module "jetbrains_gateway" {
  count          = data.coder_workspace.me.start_count
  source         = "registry.coder.com/modules/jetbrains-gateway/coder"
  version        = "1.1.0"
  agent_id       = coder_agent.example.id
  folder         = "/home/coder/example"
  jetbrains_ides = ["CL", "GO", "IU", "PY", "WS"]
  default        = "GO"
}

JetBrains Gateway IDes list

Examples

Add GoLand and WebStorm as options with the default set to GoLand

module "jetbrains_gateway" {
  count          = data.coder_workspace.me.start_count
  source         = "registry.coder.com/modules/jetbrains-gateway/coder"
  version        = "1.1.0"
  agent_id       = coder_agent.example.id
  folder         = "/home/coder/example"
  jetbrains_ides = ["GO", "WS"]
  default        = "GO"
}

Use the latest version of each IDE

module "jetbrains_gateway" {
  count          = data.coder_workspace.me.start_count
  source         = "registry.coder.com/modules/jetbrains-gateway/coder"
  version        = "1.1.0"
  agent_id       = coder_agent.example.id
  folder         = "/home/coder/example"
  jetbrains_ides = ["IU", "PY"]
  default        = "IU"
  latest         = true
}

Use fixed versions set by jetbrains_ide_versions

module "jetbrains_gateway" {
  count          = data.coder_workspace.me.start_count
  source         = "registry.coder.com/modules/jetbrains-gateway/coder"
  version        = "1.1.0"
  agent_id       = coder_agent.example.id
  folder         = "/home/coder/example"
  jetbrains_ides = ["IU", "PY"]
  default        = "IU"
  latest         = false
  jetbrains_ide_versions = {
    "IU" = {
      build_number = "243.21565.193"
      version      = "2024.3"
    }
    "PY" = {
      build_number = "243.21565.199"
      version      = "2024.3"
    }
  }
}

Use the latest EAP version

module "jetbrains_gateway" {
  count          = data.coder_workspace.me.start_count
  source         = "registry.coder.com/modules/jetbrains-gateway/coder"
  version        = "1.1.0"
  agent_id       = coder_agent.example.id
  folder         = "/home/coder/example"
  jetbrains_ides = ["GO", "WS"]
  default        = "GO"
  latest         = true
  channel        = "eap"
}

Custom base 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. Therefore, it is necessary to configure the download_base_link parameter for the jetbrains_gateway module to change the value of ide_download_link.

module "jetbrains_gateway" {
  count              = data.coder_workspace.me.start_count
  source             = "registry.coder.com/modules/jetbrains-gateway/coder"
  version            = "1.1.0"
  agent_id           = coder_agent.example.id
  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: