Skip to content

Commit 25e2146

Browse files
matifaliEdwardAngert
matifali
and
EdwardAngert
authored
docs: reorganize JetBrains docs (#17995)
This pull request introduces significant updates to documentation and references related to JetBrains IDEs, including rebranding, restructuring, and adding new guides. [Preview](https://coder.com/docs/@atif%2Fjetbrains-reorganization) --------- Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
1 parent bedeb47 commit 25e2146

File tree

12 files changed

+289
-418
lines changed

12 files changed

+289
-418
lines changed

‎README.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,10 @@ We are always working on new integrations. Please feel free to open an issue and
109109
### Official
110110

111111
- [**VS Code Extension**](https://marketplace.visualstudio.com/items?itemName=coder.coder-remote): Open any Coder workspace in VS Code with a single click
112-
- [**JetBrains Gateway Extension**](https://plugins.jetbrains.com/plugin/19620-coder): Open any Coder workspace in JetBrains Gateway with a single click
112+
- [**JetBrains Toolbox Plugin**](https://plugins.jetbrains.com/plugin/26968-coder): Open any Coder workspace from JetBrains Toolbox with a single click
113+
- [**JetBrains Gateway Plugin**](https://plugins.jetbrains.com/plugin/19620-coder): Open any Coder workspace in JetBrains Gateway with a single click
113114
- [**Dev Container Builder**](https://github.com/coder/envbuilder): Build development environments using `devcontainer.json` on Docker, Kubernetes, and OpenShift
114-
- [**Module Registry**](https://registry.coder.com): Extend development environments with common use-cases
115+
- [**Coder Registry**](https://registry.coder.com): Build and extend development environments with common use-cases
115116
- [**Kubernetes Log Stream**](https://github.com/coder/coder-logstream-kube): Stream Kubernetes Pod events to the Coder startup logs
116117
- [**Self-Hosted VS Code Extension Marketplace**](https://github.com/coder/code-marketplace): A private extension marketplace that works in restricted or airgapped networks integrating with [code-server](https://github.com/coder/code-server).
117118
- [**Setup Coder**](https://github.com/marketplace/actions/setup-coder): An action to setup coder CLI in GitHub workflows.

docs/user-guides/workspace-access/jetbrains/jetbrains-airgapped.md renamed to docs/admin/templates/extending-templates/jetbrains-airgapped.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# JetBrains Gateway in an air-gapped environment
1+
# JetBrains IDEs in an air-gapped environment
22

33
In networks that restrict access to the internet, you will need to leverage the
44
JetBrains Client Installer to download and save the IDE clients locally. Please
@@ -161,4 +161,4 @@ respectively.
161161

162162
## Next steps
163163

164-
- [Pre-install the JetBrains IDEs backend in your workspace](../../../admin/templates/extending-templates/jetbrains-gateway.md)
164+
- [Pre-install the JetBrains IDEs backend in your workspace](./jetbrains-preinstall.md)

‎docs/admin/templates/extending-templates/jetbrains-gateway.md‎

Lines changed: 0 additions & 119 deletions
This file was deleted.

docs/user-guides/workspace-access/jetbrains/jetbrains-pre-install.md renamed to docs/admin/templates/extending-templates/jetbrains-preinstall.md

Lines changed: 23 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Pre-install JetBrains Gateway in a template
1+
# Pre-install JetBrains IDEs in your template
22

3-
For a faster JetBrains Gateway experience, pre-install the IDEs backend in your template.
3+
For a faster first time connection with JetBrains IDEs, pre-install the IDEs backend in your template.
44

55
> [!NOTE]
66
> This guide only talks about installing the IDEs backend. For a complete guide on setting up JetBrains Gateway with client IDEs, refer to the [JetBrains Gateway air-gapped guide](./jetbrains-airgapped.md).
@@ -35,35 +35,35 @@ rm -rf ~/JetBrains/backends/IU/*.tar.gz
3535
Add the following command to your template's `startup_script`:
3636

3737
```shell
38-
~/JetBrains/backends/IU/ideaIU-243.26053.27/bin/remote-dev-server.sh registerBackendLocationForGateway
38+
~/JetBrains/*/bin/remote-dev-server.sh registerBackendLocationForGateway
3939
```
4040

4141
## Configure JetBrains Gateway Module
4242

43-
If you are using our [jetbrains-gateway](https://registry.coder.com/modules/jetbrains-gateway) module, you can configure it by adding the following snippet to your template:
43+
If you are using our [jetbrains-gateway](https://registry.coder.com/modules/coder/jetbrains-gateway) module, you can configure it by adding the following snippet to your template:
4444

4545
```tf
4646
module "jetbrains_gateway" {
4747
count = data.coder_workspace.me.start_count
4848
source = "registry.coder.com/modules/jetbrains-gateway/coder"
49-
version = "1.0.28"
49+
version = "1.0.29"
5050
agent_id = coder_agent.main.id
5151
folder = "/home/coder/example"
5252
jetbrains_ides = ["IU"]
5353
default = "IU"
5454
latest = false
5555
jetbrains_ide_versions = {
5656
"IU" = {
57-
build_number = "243.26053.27"
58-
version = "2024.3"
57+
build_number = "251.25410.129"
58+
version = "2025.1"
5959
}
6060
}
6161
}
6262
6363
resource "coder_agent" "main" {
6464
...
6565
startup_script = <<-EOF
66-
~/JetBrains/backends/IU/ideaIU-243.26053.27/bin/remote-dev-server.sh registerBackendLocationForGateway
66+
~/JetBrains/*/bin/remote-dev-server.sh registerBackendLocationForGateway
6767
EOF
6868
}
6969
```
@@ -73,47 +73,23 @@ resource "coder_agent" "main" {
7373
If you are using Docker based workspaces, you can add the command to your Dockerfile:
7474

7575
```dockerfile
76-
FROM ubuntu
77-
78-
# Combine all apt operations in a single RUN command
79-
# Install only necessary packages
80-
# Clean up apt cache in the same layer
81-
RUN apt-get update \
82-
&& apt-get install -y --no-install-recommends \
83-
curl \
84-
git \
85-
golang \
86-
sudo \
87-
vim \
88-
wget \
89-
&& apt-get clean \
90-
&& rm -rf /var/lib/apt/lists/*
91-
92-
# Create user in a single layer
93-
ARG USER=coder
94-
RUN useradd --groups sudo --no-create-home --shell /bin/bash ${USER} \
95-
&& echo "${USER} ALL=(ALL) NOPASSWD:ALL" >/etc/sudoers.d/${USER} \
96-
&& chmod 0440 /etc/sudoers.d/${USER}
97-
98-
USER ${USER}
99-
WORKDIR /home/${USER}
100-
101-
# Install JetBrains Gateway in a single RUN command to reduce layers
102-
# Download, extract, use, and clean up in the same layer
76+
FROM codercom/enterprise-base:ubuntu
77+
78+
# JetBrains IDE installation (configurable)
79+
ARG IDE_CODE=IU
80+
ARG IDE_VERSION=2025.1
81+
82+
# Fetch and install IDE dynamically
10383
RUN mkdir -p ~/JetBrains \
104-
&& wget -q https://download.jetbrains.com/idea/code-with-me/backend/jetbrains-clients-downloader-linux-x86_64-1867.tar.gz -P /tmp \
105-
&& tar -xzf /tmp/jetbrains-clients-downloader-linux-x86_64-1867.tar.gz -C /tmp \
106-
&& /tmp/jetbrains-clients-downloader-linux-x86_64-1867/bin/jetbrains-clients-downloader \
107-
--products-filter IU \
108-
--build-filter 243.26053.27 \
109-
--platforms-filter linux-x64 \
110-
--download-backends ~/JetBrains \
111-
&& tar -xzf ~/JetBrains/backends/IU/*.tar.gz -C ~/JetBrains/backends/IU \
112-
&& rm -f ~/JetBrains/backends/IU/*.tar.gz \
113-
&& rm -rf /tmp/jetbrains-clients-downloader-linux-x86_64-1867* \
114-
&& rm -rf /tmp/*.tar.gz
84+
&& IDE_URL=$(curl -s "https://data.services.jetbrains.com/products/releases?code=${IDE_CODE}&majorVersion=${IDE_VERSION}&latest=true" | jq -r ".${IDE_CODE}[0].downloads.linux.link") \
85+
&& IDE_NAME=$(curl -s "https://data.services.jetbrains.com/products/releases?code=${IDE_CODE}&majorVersion=${IDE_VERSION}&latest=true" | jq -r ".${IDE_CODE}[0].name") \
86+
&& echo "Installing ${IDE_NAME}..." \
87+
&& wget -q ${IDE_URL} -P /tmp \
88+
&& tar -xzf /tmp/$(basename ${IDE_URL}) -C ~/JetBrains \
89+
&& rm -f /tmp/$(basename ${IDE_URL}) \
90+
&& echo "${IDE_NAME} installed successfully"
11591
```
11692

11793
## Next steps
11894

119-
- [Pre install the Client IDEs](./jetbrains-airgapped.md#1-deploy-the-server-and-install-the-client-downloader)
95+
- [Pre-install the Client IDEs](./jetbrains-airgapped.md#1-deploy-the-server-and-install-the-client-downloader)

‎docs/install/offline.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ Coder is installed.
253253
## JetBrains IDEs
254254

255255
Gateway, JetBrains' remote development product that works with Coder,
256-
[has documented offline deployment steps.](../user-guides/workspace-access/jetbrains/jetbrains-airgapped.md)
256+
[has documented offline deployment steps.](../admin/templates/extending-templates/jetbrains-airgapped.md)
257257

258258
## Microsoft VS Code Remote - SSH
259259

‎docs/manifest.json‎

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -136,18 +136,24 @@
136136
},
137137
{
138138
"title": "JetBrains IDEs",
139-
"description": "Use JetBrains IDEs with Gateway",
139+
"description": "Use JetBrains IDEs with Coder",
140140
"path": "./user-guides/workspace-access/jetbrains/index.md",
141141
"children": [
142142
{
143-
"title": "JetBrains Gateway in an air-gapped environment",
144-
"description": "Use JetBrains Gateway in an air-gapped offline environment",
145-
"path": "./user-guides/workspace-access/jetbrains/jetbrains-airgapped.md"
143+
"title": "JetBrains Fleet",
144+
"description": "Connect JetBrains Fleet to a Coder workspace",
145+
"path": "./user-guides/workspace-access/jetbrains/fleet.md"
146+
},
147+
{
148+
"title": "JetBrains Gateway",
149+
"description": "Use JetBrains Gateway to connect to Coder workspaces",
150+
"path": "./user-guides/workspace-access/jetbrains/gateway.md"
146151
},
147152
{
148153
"title": "JetBrains Toolbox",
149-
"description": "Access Coder workspaces through JetBrains Toolbox",
150-
"path": "./user-guides/workspace-access/jetbrains/jetbrains-toolbox.md"
154+
"description": "Access Coder workspaces from JetBrains Toolbox",
155+
"path": "./user-guides/workspace-access/jetbrains/toolbox.md",
156+
"state": ["beta"]
151157
}
152158
]
153159
},
@@ -497,9 +503,14 @@
497503
"path": "./admin/templates/extending-templates/web-ides.md"
498504
},
499505
{
500-
"title": "Pre-install JetBrains Gateway",
501-
"description": "Pre-install JetBrains Gateway in a template for faster IDE startup",
502-
"path": "./admin/templates/extending-templates/jetbrains-gateway.md"
506+
"title": "Pre-install JetBrains IDEs",
507+
"description": "Pre-install JetBrains IDEs in a template for faster IDE startup",
508+
"path": "./admin/templates/extending-templates/jetbrains-preinstall.md"
509+
},
510+
{
511+
"title": "JetBrains IDEs in Air-Gapped Deployments",
512+
"description": "Configure JetBrains IDEs for air-gapped deployments",
513+
"path": "./admin/templates/extending-templates/jetbrains-airgapped.md"
503514
},
504515
{
505516
"title": "Docker in Workspaces",
@@ -920,6 +931,16 @@
920931
"description": "Learn how to use NGINX as a reverse proxy",
921932
"path": "./tutorials/reverse-proxy-nginx.md"
922933
},
934+
{
935+
"title": "Pre-install JetBrains IDEs in Workspaces",
936+
"description": "Pre-install JetBrains IDEs in workspaces",
937+
"path": "./admin/templates/extending-templates/jetbrains-preinstall.md"
938+
},
939+
{
940+
"title": "Use JetBrains IDEs in Air-Gapped Deployments",
941+
"description": "Configure JetBrains IDEs for air-gapped deployments",
942+
"path": "./admin/templates/extending-templates/jetbrains-airgapped.md"
943+
},
923944
{
924945
"title": "FAQs",
925946
"description": "Miscellaneous FAQs from our community",

‎docs/user-guides/workspace-access/index.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ successful, you'll see the following message:
6868
```console
6969
You should now be able to ssh into your workspace.
7070
For example, try running:
71-
71+
7272
$ ssh coder.<workspaceName>
7373
```
7474

@@ -110,9 +110,9 @@ IDEs are supported for remote development:
110110
- Rider
111111
- RubyMine
112112
- WebStorm
113-
- [JetBrains Fleet](./jetbrains/index.md#jetbrains-fleet)
113+
- [JetBrains Fleet](./jetbrains/fleet.md)
114114

115-
Read our [docs on JetBrains Gateway](./jetbrains/index.md) for more information
115+
Read our [docs on JetBrains](./jetbrains/index.md) for more information
116116
on connecting your JetBrains IDEs.
117117

118118
## code-server

‎docs/user-guides/workspace-access/jetbrains/fleet.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# JetBrains Fleet
2+
3+
JetBrains Fleet is a code editor and lightweight IDE designed to support various
4+
programming languages and development environments.
5+
6+
[See JetBrains's website](https://www.jetbrains.com/fleet/) to learn more about Fleet.
7+
8+
To connect Fleet to a Coder workspace:
9+
10+
1. [Install Fleet](https://www.jetbrains.com/fleet/download)
11+
12+
1. Install Coder CLI
13+
14+
```shell
15+
curl -L https://coder.com/install.sh | sh
16+
```
17+
18+
1. Login and configure Coder SSH.
19+
20+
```shell
21+
coder login coder.example.com
22+
coder config-ssh
23+
```
24+
25+
1. Connect via SSH with the Host set to `coder.workspace-name`
26+
![Fleet Connect to Coder](../../../images/fleet/ssh-connect-to-coder.png)

0 commit comments

Comments
 (0)