Skip to content

Commit ab077d1

Browse files
docs: fixed broken podman template link and added already-installed ide gateway doc (#6352)
Co-authored-by: Eric Paulsen <ericpaulsen@coder.com>
1 parent 712098f commit ab077d1

File tree

1 file changed

+39
-22
lines changed

1 file changed

+39
-22
lines changed

docs/ides/gateway.md

+39-22
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,6 @@ JetBrains Gateway is a compact desktop app that allows you to work remotely with
44

55
Gateway can connect to a Coder workspace by using Coder's Gateway plugin or manually setting up an SSH connection.
66

7-
## Using Coder's JetBrains Gateway Plugin
8-
9-
> The Coder plugin is an alpha state. If you experience problems, please [create a GitHub issue](https://github.com/coder/coder/issues) or share in [our Discord channel](https://discord.gg/coder).
10-
11-
1. [Install Gateway](https://www.jetbrains.com/help/idea/jetbrains-gateway.html)
12-
1. Open Gateway and click the gear icon at the bottom left and then "Settings"
13-
1. In the Marketplace tab within Plugins, type Coder and then click "Install" and "OK"
14-
![Gateway Settings and Marketplace](../images/gateway/plugin-settings-marketplace.png)
15-
1. Click the new "Coder" icon on the Gateway home screen
16-
![Gateway Connect to Coder](../images/gateway/plugin-connect-to-coder.png)
17-
1. Enter your Coder deployment's Access Url and click "Connect" then paste the Session Token and click "OK"
18-
![Gateway Session Token](../images/gateway/plugin-session-token.png)
19-
1. Click the "+" icon to open a browser and go to the templates page in your Coder deployment to create a workspace
20-
1. If a workspace already exists but is stopped, click the green arrow to start the workspace
21-
1. Once the workspace status says Running, click "Select IDE and Project"
22-
![Gateway IDE List](../images/gateway/plugin-select-ide.png)
23-
1. Select the JetBrains IDE for your project and the project directory then click "Start IDE and connect"
24-
![Gateway Select IDE](../images/gateway/plugin-ide-list.png)
25-
![Gateway IDE Opened](../images/gateway/gateway-intellij-opened.png)
26-
27-
> Note the JetBrains IDE is remotely installed into `~/. cache/JetBrains/RemoteDev/dist`
28-
297
## Creating a new JetBrains Gateway Connection
308

319
1. [Install Gateway](https://www.jetbrains.com/help/idea/jetbrains-gateway.html)
@@ -57,3 +35,42 @@ Gateway can connect to a Coder workspace by using Coder's Gateway plugin or manu
5735
> Note the JetBrains IDE is remotely installed into `~/. cache/JetBrains/RemoteDev/dist`
5836
1. Click "Download and Start IDE" to connect.
5937
![Gateway IDE Opened](../images/gateway/gateway-intellij-opened.png)
38+
39+
## Using an existing JetBrains installation in the workspace
40+
41+
If you would like to use an existing JetBrains IDE in a Coder workspace (or you
42+
are air-gapped, and cannot reach jetbrains.com), run the following script in the
43+
JetBrains IDE directory to point the default Gateway directory to the IDE
44+
directory. This step must be done before configuring Gateway.
45+
46+
```sh
47+
cd /opt/idea/bin
48+
./remote-dev-server.sh registerBackendLocationForGateway
49+
```
50+
51+
> Gateway only works with paid versions of JetBrains IDEs so the script will not be located in the `bin` directory of JetBrains Community editions.
52+
53+
[Here is the JetBrains article](https://www.jetbrains.com/help/idea/remote-development-troubleshooting.html#setup:~:text=Can%20I%20point%20Remote%20Development%20to%20an%20existing%20IDE%20on%20my%20remote%20server%3F%20Is%20it%20possible%20to%20install%20IDE%20manually%3F)
54+
explaining this IDE specification.
55+
56+
## Using Coder's JetBrains Gateway Plugin
57+
58+
> The Coder plugin is an alpha state. If you experience problems, please [create a GitHub issue](https://github.com/coder/coder/issues) or share in [our Discord channel](https://discord.gg/coder).
59+
60+
1. [Install Gateway](https://www.jetbrains.com/help/idea/jetbrains-gateway.html)
61+
1. Open Gateway and click the gear icon at the bottom left and then "Settings"
62+
1. In the Marketplace tab within Plugins, type Coder and then click "Install" and "OK"
63+
![Gateway Settings and Marketplace](../images/gateway/plugin-settings-marketplace.png)
64+
1. Click the new "Coder" icon on the Gateway home screen
65+
![Gateway Connect to Coder](../images/gateway/plugin-connect-to-coder.png)
66+
1. Enter your Coder deployment's Access Url and click "Connect" then paste the Session Token and click "OK"
67+
![Gateway Session Token](../images/gateway/plugin-session-token.png)
68+
1. Click the "+" icon to open a browser and go to the templates page in your Coder deployment to create a workspace
69+
1. If a workspace already exists but is stopped, click the green arrow to start the workspace
70+
1. Once the workspace status says Running, click "Select IDE and Project"
71+
![Gateway IDE List](../images/gateway/plugin-select-ide.png)
72+
1. Select the JetBrains IDE for your project and the project directory then click "Start IDE and connect"
73+
![Gateway Select IDE](../images/gateway/plugin-ide-list.png)
74+
![Gateway IDE Opened](../images/gateway/gateway-intellij-opened.png)
75+
76+
> Note the JetBrains IDE is remotely installed into `~/.cache/JetBrains/RemoteDev/dist`

0 commit comments

Comments
 (0)