Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit e977a97

Browse files
EdwardAngertEdwardAngert
authored
chore(docs): update JetBrains gateway setup (#14807)
- updates the JetBrains Gateway set up steps - adjusts the relative image urls to the new directory structure --------- Co-authored-by: EdwardAngert <[email protected]>
1 parent d7ecab5 commit e977a97

File tree

2 files changed

+54
-42
lines changed

2 files changed

+54
-42
lines changed

‎docs/images/gateway/plugin-connect-to-coder.png

81.7 KB
Loading

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

Lines changed: 54 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ IDEs are supported for remote development:
1717

1818
JetBrains Gateway is a compact desktop app that allows you to work remotely with
1919
a JetBrains IDE without even downloading one.
20-
[See JetBrains' website to learn about and Gateway.](https://www.jetbrains.com/remote-development/gateway/)
20+
Visit the [JetBrains website](https://www.jetbrains.com/remote-development/gateway/) to learn more about Gateway.]
2121

2222
Gateway can connect to a Coder workspace by using Coder's Gateway plugin or
2323
manually setting up an SSH connection.
@@ -29,45 +29,56 @@ manually setting up an SSH connection.
2929
> [our Discord channel](https://discord.gg/coder).
3030
3131
1. [Install Gateway](https://www.jetbrains.com/help/idea/jetbrains-gateway.html)
32-
1. Open Gateway and click the Coder icon to install the Coder plugin.
33-
1. Click the "Coder" icon under Install More Providers at the bottom of the
34-
Gateway home screen
35-
1. Click "Connect to Coder" at the top of the Gateway home screen to launch the
36-
plugin
32+
and open the application.
33+
1. Under **Install More Providers**, find the Coder icon and click **Install**
34+
to install the Coder plugin.
35+
1. After Gateway installs the plugin, it will appear in the **Run the IDE
36+
Remotely** section.
37+
38+
Click **Connect to Coder** to launch the plugin:
3739

3840
![Gateway Connect to Coder](../../images/gateway/plugin-connect-to-coder.png)
3941

40-
1. Enter your Coder deployment's Access Url and click "Connect" then paste the
41-
Session Token and click "OK"
42+
1. Enter your Coder deployment's
43+
[Access Url](../../admin/configure.md#access-url) and click **Connect**.
44+
45+
Gateway opens your Coder deployment's `cli-auth` page with a session token.
46+
Click the copy button, paste the session token in the Gateway **Session
47+
Token** window, then click **OK**:
4248

4349
![Gateway Session Token](../../images/gateway/plugin-session-token.png)
4450

45-
1. Click the "+" icon to open a browser and go to the templates page in your
46-
Coder deployment to create a workspace
51+
1. To create a new workspace:
4752

48-
1. If a workspace already exists but is stopped, click the green arrow to start
49-
the workspace
53+
Click the <kbd>+</kbd> icon to open a browser and go to the templates page in
54+
your Coder deployment to create a workspace.
5055

51-
1. Once the workspace status says Running, click "Select IDE and Project"
56+
1. If a workspace already exists but is stopped, select the workspace from the
57+
list, then click the green arrow to start the workspace.
58+
59+
1. When the workspace status is **Running**, click **Select IDE and Project**:
5260

5361
![Gateway IDE List](../../images/gateway/plugin-select-ide.png)
5462

5563
1. Select the JetBrains IDE for your project and the project directory then
56-
click "Start IDE and connect"
64+
click **Start IDE and connect**:
65+
5766
![Gateway Select IDE](../../images/gateway/plugin-ide-list.png)
5867

68+
Gateway connects using the IDE you selected:
69+
5970
![Gateway IDE Opened](../../images/gateway/gateway-intellij-opened.png)
6071

61-
> Note the JetBrains IDE is remotely installed into
62-
> `~/.cache/JetBrains/RemoteDev/dist`
72+
> Note the JetBrains IDE is remotely installed into
73+
> `~/.cache/JetBrains/RemoteDev/dist`
6374
6475
### Update a Coder plugin version
6576

6677
1. Click the gear icon at the bottom left of the Gateway home screen and then
6778
"Settings"
6879

69-
1. In the Marketplace tab within Plugins, type Coder and if a newer plugin
70-
release is available, click "Update" and "OK"
80+
1. In the **Marketplace** tab within Plugins, enter Coder and if a newer plugin
81+
release is available, click **Update** then **OK**:
7182

7283
![Gateway Settings and Marketplace](../../images/gateway/plugin-settings-marketplace.png)
7384

@@ -125,59 +136,60 @@ keytool -import -alias coder -file cacert.pem -keystore /Applications/JetBrains\
125136
> This is in lieu of using Coder's Gateway plugin which automatically performs
126137
> these steps.
127138
128-
1. [Install Gateway](https://www.jetbrains.com/help/idea/jetbrains-gateway.html)
139+
1. [Install Gateway](https://www.jetbrains.com/help/idea/jetbrains-gateway.html).
129140

130-
1. [Configure the `coder` CLI](../ides.md#ssh-configuration)
141+
1. [Configure the `coder` CLI](../ides.md#ssh-configuration).
131142

132-
1. Open Gateway, make sure "SSH" is selected under "Remote Development"
143+
1. Open Gateway, make sure **SSH** is selected under **Remote Development**.
133144

134-
1. Click "New Connection"
145+
1. Click **New Connection**:
135146

136-
![Gateway Home](../images/gateway/gateway-home.png)
147+
![Gateway Home](../../images/gateway/gateway-home.png)
137148

138-
1. In the resulting dialog, click the gear icon to the right of "Connection:"
149+
1. In the resulting dialog, click the gear icon to the right of **Connection**:
139150

140-
![Gateway New Connection](../images/gateway/gateway-new-connection.png)
151+
![Gateway New Connection](../../images/gateway/gateway-new-connection.png)
141152

142-
1. Hit the "+" button to add a new SSH connection
153+
1. Click <kbd>+</kbd> to add a new SSH connection:
143154

144-
![Gateway Add Connection](../images/gateway/gateway-add-ssh-configuration.png)
155+
![Gateway Add Connection](../../images/gateway/gateway-add-ssh-configuration.png)
145156

146157
1. For the Host, enter `coder.<workspace name>`
147158

148159
1. For the Port, enter `22` (this is ignored by Coder)
149160

150-
1. For the Username, enter your workspace username
161+
1. For the Username, enter your workspace username.
151162

152-
1. For the Authentication Type, select "OpenSSH config and authentication agent"
163+
1. For the Authentication Type, select **OpenSSH config and authentication
164+
agent**.
153165

154-
1. Make sure the checkbox for "Parse config file ~/.ssh/config" is checked.
166+
1. Make sure the checkbox for **Parse config file ~/.ssh/config** is checked.
155167

156-
1. Click "Test Connection" to validate these settings.
168+
1. Click **Test Connection** to validate these settings.
157169

158-
1. Click "OK"
170+
1. Click **OK**:
159171

160-
![Gateway SSH Configuration](../images/gateway/gateway-create-ssh-configuration.png)
172+
![Gateway SSH Configuration](../../images/gateway/gateway-create-ssh-configuration.png)
161173

162-
1. Select the connection you just added
174+
1. Select the connection you just added:
163175

164-
![Gateway Welcome](../images/gateway/gateway-welcome.png)
176+
![Gateway Welcome](../../images/gateway/gateway-welcome.png)
165177

166-
1. Click "Check Connection and Continue"
178+
1. Click **Check Connection and Continue**:
167179

168-
![Gateway Continue](../images/gateway/gateway-continue.png)
180+
![Gateway Continue](../../images/gateway/gateway-continue.png)
169181

170182
1. Select the JetBrains IDE for your project and the project directory. SSH into
171183
your server to create a directory or check out code if you haven't already.
172184

173-
![Gateway Choose IDE](../images/gateway/gateway-choose-ide.png)
185+
![Gateway Choose IDE](../../images/gateway/gateway-choose-ide.png)
174186

175187
> Note the JetBrains IDE is remotely installed into
176188
> `~/. cache/JetBrains/RemoteDev/dist`
177189
178-
1. Click "Download and Start IDE" to connect.
190+
1. Click **Download and Start IDE** to connect.
179191

180-
![Gateway IDE Opened](../images/gateway/gateway-intellij-opened.png)
192+
![Gateway IDE Opened](../../images/gateway/gateway-intellij-opened.png)
181193

182194
## Using an existing JetBrains installation in the workspace
183195

@@ -335,7 +347,7 @@ HKEY_LOCAL_MACHINE registry
335347
Additionally, create a string for each setting with its appropriate value in
336348
`SOFTWARE\JetBrains\RemoteDev`:
337349

338-
![Alt text](../images/gateway/JetBrains-offline-windows.png)
350+
![Alt text](../../images/gateway/jetbrains-offline-windows.png)
339351

340352
### 5. Setup SSH connection with JetBrains Gateway
341353

@@ -348,7 +360,7 @@ Instead of downloading from jetbrains.com, we will point Gateway to our server
348360
endpoint. Select `Installation options...` and select `Use download link`. Note
349361
that the URL must explicitly reference the archive file:
350362

351-
![Offline Gateway](../images/gateway/offline-gateway.png)
363+
![Offline Gateway](../../images/gateway/offline-gateway.png)
352364

353365
Click `Download IDE and Connect`. Gateway should now download the backend and
354366
clients from the server into your remote workspace and local machine,

0 commit comments

Comments
 (0)