Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit6330b0d

Browse files
docs: add steps to pre-install JetBrains IDE backend (#15962)
closes#13207 [preview](https://coder.com/docs/@13207-preinstall-jetbrains/user-guides/workspace-access/jetbrains)---------Co-authored-by: M Atif Ali <atif@coder.com>Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
1 parent6a6e1ec commit6330b0d

File tree

10 files changed

+671
-418
lines changed

10 files changed

+671
-418
lines changed
Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
#Pre-install JetBrains Gateway in a template
2+
3+
For a faster JetBrains Gateway experience, pre-install the IDEs backend in your template.
4+
5+
>[!NOTE]
6+
>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](../../../user-guides/workspace-access/jetbrains/jetbrains-airgapped.md).
7+
8+
##Install the Client Downloader
9+
10+
Install the JetBrains Client Downloader binary:
11+
12+
```shell
13+
wget https://download.jetbrains.com/idea/code-with-me/backend/jetbrains-clients-downloader-linux-x86_64-1867.tar.gz&& \
14+
tar -xzvf jetbrains-clients-downloader-linux-x86_64-1867.tar.gz
15+
rm jetbrains-clients-downloader-linux-x86_64-1867.tar.gz
16+
```
17+
18+
##Install Gateway backend
19+
20+
```shell
21+
mkdir~/JetBrains
22+
./jetbrains-clients-downloader-linux-x86_64-1867/bin/jetbrains-clients-downloader --products-filter<product-code> --build-filter<build-number> --platforms-filter linux-x64 --download-backends~/JetBrains
23+
```
24+
25+
For example, to install the build`243.26053.27` of IntelliJ IDEA:
26+
27+
```shell
28+
./jetbrains-clients-downloader-linux-x86_64-1867/bin/jetbrains-clients-downloader --products-filter IU --build-filter 243.26053.27 --platforms-filter linux-x64 --download-backends~/JetBrains
29+
tar -xzvf~/JetBrains/backends/IU/*.tar.gz -C~/JetBrains/backends/IU
30+
rm -rf~/JetBrains/backends/IU/*.tar.gz
31+
```
32+
33+
##Register the Gateway backend
34+
35+
Add the following command to your template's`startup_script`:
36+
37+
```shell
38+
~/JetBrains/backends/IU/ideaIU-243.26053.27/bin/remote-dev-server.sh registerBackendLocationForGateway
39+
```
40+
41+
##Configure JetBrains Gateway Module
42+
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:
44+
45+
```tf
46+
module "jetbrains_gateway" {
47+
count = data.coder_workspace.me.start_count
48+
source = "registry.coder.com/modules/jetbrains-gateway/coder"
49+
version = "1.0.28"
50+
agent_id = coder_agent.main.id
51+
folder = "/home/coder/example"
52+
jetbrains_ides = ["IU"]
53+
default = "IU"
54+
latest = false
55+
jetbrains_ide_versions = {
56+
"IU" = {
57+
build_number = "243.26053.27"
58+
version = "2024.3"
59+
}
60+
}
61+
}
62+
63+
resource "coder_agent" "main" {
64+
...
65+
startup_script = <<-EOF
66+
~/JetBrains/backends/IU/ideaIU-243.26053.27/bin/remote-dev-server.sh registerBackendLocationForGateway
67+
EOF
68+
}
69+
```
70+
71+
##Dockerfile example
72+
73+
If you are using Docker based workspaces, you can add the command to your Dockerfile:
74+
75+
```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
103+
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
115+
```
116+
117+
##Next steps
118+
119+
-[Pre-install the Client IDEs](../../../user-guides/workspace-access/jetbrains/jetbrains-airgapped.md#1-deploy-the-server-and-install-the-client-downloader)

‎docs/changelogs/v2.1.5.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656
<!-- markdown-link-check-disable-->
5757

5858
- Add
59-
[JetBrains Gateway Offline Mode](https://coder.com/docs/user-guides/workspace-access/jetbrains.md#jetbrains-gateway-in-an-offline-environment)
59+
[JetBrains Gateway Offline Mode](https://coder.com/docs/user-guides/workspace-access/jetbrains/jetbrains-airgapped.md)
6060
config steps (#9388) (@ericpaulsen)
6161
<!-- markdown-link-check-enable-->
6262
- Describe

‎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.md#jetbrains-gateway-in-an-offline-environment)
256+
[has documented offline deployment steps.](../user-guides/workspace-access/jetbrains/jetbrains-airgapped.md)
257257

258258
##Microsoft VS Code Remote - SSH
259259

‎docs/manifest.json

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,14 @@
137137
{
138138
"title":"JetBrains IDEs",
139139
"description":"Use JetBrains IDEs with Gateway",
140-
"path":"./user-guides/workspace-access/jetbrains.md"
140+
"path":"./user-guides/workspace-access/jetbrains/index.md",
141+
"children": [
142+
{
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"
146+
}
147+
]
141148
},
142149
{
143150
"title":"Remote Desktop",
@@ -449,6 +456,11 @@
449456
"description":"Add and configure Web IDEs in your templates as coder apps",
450457
"path":"./admin/templates/extending-templates/web-ides.md"
451458
},
459+
{
460+
"title":"Pre-install JetBrains Gateway",
461+
"description":"Pre-install JetBrains Gateway in a template for faster IDE startup",
462+
"path":"./admin/templates/extending-templates/jetbrains-gateway.md"
463+
},
452464
{
453465
"title":"Docker in Workspaces",
454466
"description":"Use Docker in your workspaces",

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,10 +105,10 @@ IDEs are supported for remote development:
105105
- Rider
106106
- RubyMine
107107
- WebStorm
108-
-[JetBrains Fleet](./jetbrains.md#jetbrains-fleet)
108+
-[JetBrains Fleet](./jetbrains/index.md#jetbrains-fleet)
109109

110-
Read our[docs on JetBrains Gateway](./jetbrains.md) for more information on
111-
connecting your JetBrains IDEs.
110+
Read our[docs on JetBrains Gateway](./jetbrains/index.md) for more information
111+
onconnecting your JetBrains IDEs.
112112

113113
##code-server
114114

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp