Skip to content

Commit d96f93c

Browse files
authored
added JetBrains Gateway documentation in IDE section (coder#720)
1 parent 0b40966 commit d96f93c

10 files changed

+67
-1
lines changed
Loading
101 KB
Loading
147 KB
Loading
146 KB
Loading
445 KB
Loading

assets/workspaces/gateway-opened.png

157 KB
Loading
Loading
193 KB
Loading
89.3 KB
Loading

workspaces/editors.md

Lines changed: 67 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,12 @@ description:
44
Learn how to connect your favorite editors and IDEs to your remote workspace.
55
---
66

7-
There are five primary ways you can connect an IDE to your Coder workspace:
7+
There are several primary ways you can connect an IDE to your Coder workspace:
88

99
1. [VS Code remote SSH](editors.md#vs-code-remote-ssh) with local VS Code
1010
1. [VS Code in the browser](editors.md#vs-code-in-the-browser) with code-server
11+
1. [JetBrains and SSH](editors.md#jetbrains-ides-remote-ssh) with JetBrains
12+
Gateway
1113
1. [JetBrains in the browser](editors.md#jetbrains-ides-in-the-browser) with
1214
JetBrains Projector
1315
1. [JetBrains' Code With Me](editors.md#code-with-me)
@@ -37,6 +39,70 @@ Web_ icon.
3739

3840
![Launch a workspace](../assets/workspaces/launch-workspace.png)
3941

42+
## JetBrains IDEs remote SSH
43+
44+
If your image
45+
[includes a JetBrains IDE](../admin/workspace-management/installing-jetbrains.md)
46+
and you've [set up SSH access to Coder](./ssh.md), you can use JetBrains Gateway
47+
to run a local JetBrains IDE connected to your Coder workspace.
48+
49+
Please note that:
50+
51+
- Your Coder workspace with the JetBrains IDE must be running
52+
- If you use a premium JetBrains IDE (e.g., GoLand, IntelliJ IDEA Ultimate), you
53+
will still need a license to use it remotely with Coder.
54+
55+
1. [Download and install JetBrains Toolbox](https://www.jetbrains.com/toolbox-app/).
56+
Locate JetBrains Gateway in the Toolbox list and click **Install**.
57+
58+
![JetBrains Toolbox](../assets/workspaces/jetbrains-toolbox.png)
59+
60+
1. Open JetBrains Gateway and click **Connect via SSH** within the **Run the IDE
61+
Remotely** section.
62+
63+
![Open JetBrains Gateway](../assets/workspaces/gateway-opened.png)
64+
65+
1. Click the small **gear icon** to the right of the **Connection** field, then
66+
the **+** button on the next screen to create a new configuration.
67+
68+
![Connect Gateway to SSH](../assets/workspaces/gateway-connect-to-ssh.png)
69+
70+
1. Enter your Coder workspace alias target in **Host** (e.g.,
71+
`coder.mark-python`), `22` in **Port**, `coder` in **User name**, and change
72+
**Authentication Type** to **OpenSSH config and authentication agent**. Leave
73+
the local port field blank. Click **Test Connection**.
74+
75+
![Gateway SSH Configurations](../assets/workspaces/gateway-ssh-configurations.png)
76+
77+
1. With your created configuration in the **Connection** chosen in the drop-down
78+
field, click **Test Connection**, then **OK**.
79+
80+
![Test Gateway Connection](../assets/workspaces/gateway-test-connection.png)
81+
82+
1. Select or install a JetBrains IDE from the IDE version drop-down. If one is
83+
auto-installed on your workspace, it should show up here. Next, click the
84+
folder icon and select your `/home/coder` directory in your Coder workspace.
85+
86+
![Select JetBrains IDE and working
87+
directory](../assets/workspaces/gateway-ide-and-project.png)
88+
89+
1. During this installation step, Gateway downloads the IDE and a JetBrains
90+
client. This may take a couple minutes.
91+
92+
![Gateway downloading IDE and
93+
client](../assets/workspaces/gateway-download-client.png)
94+
![Code with Me
95+
starting up](../assets/workspaces/gateway-code-with-me-loading.png)
96+
97+
![A running
98+
JetBrains IDE in Gateway](../assets/workspaces/gateway-ide-running.png)
99+
100+
> If your Coder deployment is configured with ECDSA ssh key algorithm, change
101+
> the Gateway authentication type to **Key pair** and create the Coder public
102+
> ssh key in your local `~/.ssh` directory with `ssh-keygen -y -f`:
103+
>
104+
> `~/.ssh/coder_enterprise | tee ~/.ssh/coder_enterprise.pub`
105+
40106
## JetBrains IDEs in the browser
41107

42108
If your image

0 commit comments

Comments
 (0)