You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
136 lines
3.9 KiB
Markdown
136 lines
3.9 KiB
Markdown
---
|
|
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.
|
|
|
|
```tf
|
|
module "jetbrains_gateway" {
|
|
count = data.coder_workspace.me.start_count
|
|
source = "registry.coder.com/modules/jetbrains-gateway/coder"
|
|
version = "1.0.25"
|
|
agent_id = coder_agent.example.id
|
|
agent_name = "example"
|
|
folder = "/home/coder/example"
|
|
jetbrains_ides = ["CL", "GO", "IU", "PY", "WS"]
|
|
default = "GO"
|
|
}
|
|
```
|
|
|
|
|
|
|
|
## Examples
|
|
|
|
### Add GoLand and WebStorm as options with the default set to GoLand
|
|
|
|
```tf
|
|
module "jetbrains_gateway" {
|
|
count = data.coder_workspace.me.start_count
|
|
source = "registry.coder.com/modules/jetbrains-gateway/coder"
|
|
version = "1.0.25"
|
|
agent_id = coder_agent.example.id
|
|
agent_name = "example"
|
|
folder = "/home/coder/example"
|
|
jetbrains_ides = ["GO", "WS"]
|
|
default = "GO"
|
|
}
|
|
```
|
|
|
|
### Use the latest version of each IDE
|
|
|
|
```tf
|
|
module "jetbrains_gateway" {
|
|
count = data.coder_workspace.me.start_count
|
|
source = "registry.coder.com/modules/jetbrains-gateway/coder"
|
|
version = "1.0.25"
|
|
agent_id = coder_agent.example.id
|
|
agent_name = "example"
|
|
folder = "/home/coder/example"
|
|
jetbrains_ides = ["IU", "PY"]
|
|
default = "IU"
|
|
latest = true
|
|
}
|
|
```
|
|
|
|
### Use fixed versions set by `jetbrains_ide_versions`
|
|
|
|
```tf
|
|
module "jetbrains_gateway" {
|
|
count = data.coder_workspace.me.start_count
|
|
source = "registry.coder.com/modules/jetbrains-gateway/coder"
|
|
version = "1.0.25"
|
|
agent_id = coder_agent.example.id
|
|
agent_name = "example"
|
|
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
|
|
|
|
```tf
|
|
module "jetbrains_gateway" {
|
|
count = data.coder_workspace.me.start_count
|
|
source = "registry.coder.com/modules/jetbrains-gateway/coder"
|
|
version = "1.0.25"
|
|
agent_id = coder_agent.example.id
|
|
agent_name = "example"
|
|
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](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" {
|
|
count = data.coder_workspace.me.start_count
|
|
source = "registry.coder.com/modules/jetbrains-gateway/coder"
|
|
version = "1.0.25"
|
|
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:
|
|
|
|
- GoLand (`GO`)
|
|
- WebStorm (`WS`)
|
|
- IntelliJ IDEA Ultimate (`IU`)
|
|
- PyCharm Professional (`PY`)
|
|
- PhpStorm (`PS`)
|
|
- CLion (`CL`)
|
|
- RubyMine (`RM`)
|
|
- Rider (`RD`)
|