|
| 1 | +--- |
| 2 | +display_name: JetBrains Gateway |
| 3 | +description: Add a one-click button to launch JetBrains Gateway IDEs in the dashboard. |
| 4 | +icon: ../.icons/gateway.svg |
| 5 | +maintainer_github: coder |
| 6 | +verified: true |
| 7 | +tags: [ide, jetbrains, helper, parameter] |
| 8 | +--- |
| 9 | + |
| 10 | +# JetBrains Gateway |
| 11 | + |
| 12 | +This module adds a JetBrains Gateway Button to open any workspace with a single click. |
| 13 | + |
| 14 | +```tf |
| 15 | +module "jetbrains_gateway" { |
| 16 | + count = data.coder_workspace.me.start_count |
| 17 | + source = "registry.coder.com/modules/jetbrains-gateway/coder" |
| 18 | + version = "1.0.28" |
| 19 | + agent_id = coder_agent.example.id |
| 20 | + folder = "/home/coder/example" |
| 21 | + jetbrains_ides = ["CL", "GO", "IU", "PY", "WS"] |
| 22 | + default = "GO" |
| 23 | +} |
| 24 | +``` |
| 25 | + |
| 26 | + |
| 27 | + |
| 28 | +## Examples |
| 29 | + |
| 30 | +### Add GoLand and WebStorm as options with the default set to GoLand |
| 31 | + |
| 32 | +```tf |
| 33 | +module "jetbrains_gateway" { |
| 34 | + count = data.coder_workspace.me.start_count |
| 35 | + source = "registry.coder.com/modules/jetbrains-gateway/coder" |
| 36 | + version = "1.0.28" |
| 37 | + agent_id = coder_agent.example.id |
| 38 | + folder = "/home/coder/example" |
| 39 | + jetbrains_ides = ["GO", "WS"] |
| 40 | + default = "GO" |
| 41 | +} |
| 42 | +``` |
| 43 | + |
| 44 | +### Use the latest version of each IDE |
| 45 | + |
| 46 | +```tf |
| 47 | +module "jetbrains_gateway" { |
| 48 | + count = data.coder_workspace.me.start_count |
| 49 | + source = "registry.coder.com/modules/jetbrains-gateway/coder" |
| 50 | + version = "1.0.28" |
| 51 | + agent_id = coder_agent.example.id |
| 52 | + folder = "/home/coder/example" |
| 53 | + jetbrains_ides = ["IU", "PY"] |
| 54 | + default = "IU" |
| 55 | + latest = true |
| 56 | +} |
| 57 | +``` |
| 58 | + |
| 59 | +### Use fixed versions set by `jetbrains_ide_versions` |
| 60 | + |
| 61 | +```tf |
| 62 | +module "jetbrains_gateway" { |
| 63 | + count = data.coder_workspace.me.start_count |
| 64 | + source = "registry.coder.com/modules/jetbrains-gateway/coder" |
| 65 | + version = "1.0.28" |
| 66 | + agent_id = coder_agent.example.id |
| 67 | + folder = "/home/coder/example" |
| 68 | + jetbrains_ides = ["IU", "PY"] |
| 69 | + default = "IU" |
| 70 | + latest = false |
| 71 | + jetbrains_ide_versions = { |
| 72 | + "IU" = { |
| 73 | + build_number = "243.21565.193" |
| 74 | + version = "2024.3" |
| 75 | + } |
| 76 | + "PY" = { |
| 77 | + build_number = "243.21565.199" |
| 78 | + version = "2024.3" |
| 79 | + } |
| 80 | + } |
| 81 | +} |
| 82 | +``` |
| 83 | + |
| 84 | +### Use the latest EAP version |
| 85 | + |
| 86 | +```tf |
| 87 | +module "jetbrains_gateway" { |
| 88 | + count = data.coder_workspace.me.start_count |
| 89 | + source = "registry.coder.com/modules/jetbrains-gateway/coder" |
| 90 | + version = "1.0.28" |
| 91 | + agent_id = coder_agent.example.id |
| 92 | + folder = "/home/coder/example" |
| 93 | + jetbrains_ides = ["GO", "WS"] |
| 94 | + default = "GO" |
| 95 | + latest = true |
| 96 | + channel = "eap" |
| 97 | +} |
| 98 | +``` |
| 99 | + |
| 100 | +### Custom base link |
| 101 | + |
| 102 | +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`. |
| 103 | + |
| 104 | +```tf |
| 105 | +module "jetbrains_gateway" { |
| 106 | + count = data.coder_workspace.me.start_count |
| 107 | + source = "registry.coder.com/modules/jetbrains-gateway/coder" |
| 108 | + version = "1.0.28" |
| 109 | + agent_id = coder_agent.example.id |
| 110 | + folder = "/home/coder/example" |
| 111 | + jetbrains_ides = ["GO", "WS"] |
| 112 | + releases_base_link = "https://releases.internal.site/" |
| 113 | + download_base_link = "https://download.internal.site/" |
| 114 | + default = "GO" |
| 115 | +} |
| 116 | +``` |
| 117 | + |
| 118 | +## Supported IDEs |
| 119 | + |
| 120 | +This module and JetBrains Gateway support the following JetBrains IDEs: |
| 121 | + |
| 122 | +- [GoLand (`GO`)](https://www.jetbrains.com/go/) |
| 123 | +- [WebStorm (`WS`)](https://www.jetbrains.com/webstorm/) |
| 124 | +- [IntelliJ IDEA Ultimate (`IU`)](https://www.jetbrains.com/idea/) |
| 125 | +- [PyCharm Professional (`PY`)](https://www.jetbrains.com/pycharm/) |
| 126 | +- [PhpStorm (`PS`)](https://www.jetbrains.com/phpstorm/) |
| 127 | +- [CLion (`CL`)](https://www.jetbrains.com/clion/) |
| 128 | +- [RubyMine (`RM`)](https://www.jetbrains.com/ruby/) |
| 129 | +- [Rider (`RD`)](https://www.jetbrains.com/rider/) |
| 130 | +- [RustRover (`RR`)](https://www.jetbrains.com/rust/) |
0 commit comments