Skip to content

Commit 8fea7d5

Browse files
committed
Fix issues in #3320
1 parent 9755f5a commit 8fea7d5

File tree

3 files changed

+32
-55
lines changed

3 files changed

+32
-55
lines changed

docs/ides.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@ The following desktop IDEs have been tested with Coder, though any IDE with SSH
44
support should work:
55

66
- [VS Code Remote SSH](#vs-code-remote)
7-
extension)
87
- [JetBrains with Gateway](./ides/configuring-gateway.md)
9-
installed)
108
- IntelliJ IDEA
119
- CLion
1210
- GoLand

docs/ides/configuring-gateway.md

Lines changed: 30 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,36 @@
11
# Configuring JetBrains Gateway
22

3-
The following screenshots outline in more detail how to create a new Connection
4-
for JetBrains Gateway to a Coder workspace.
3+
The following walkthrough details how to connect JetBrains Gateway to
4+
Coder.
55

66
## Creating a new JetBrains Gateway Connection
77

8-
After installing Gateway on your local system, you may connect to a Coder
9-
workspace as follows
10-
8+
1. [Install Gateway](https://www.jetbrains.com/help/idea/jetbrains-gateway.html)
9+
1. [Configure the `coder` CLI](../ides.md#ssh-configuration)
1110
1. Open Gateway, make sure "SSH" is selected under "Remote Development"
12-
2. Click "New Connection"
13-
14-
![Gateway Home](../images/gateway/gateway-home.png)
15-
16-
3. In the resulting dialog, click the gear icon to the right of "Connection:"
17-
18-
![Gateway New Connection](../images/gateway/gateway-new-connection.png)
19-
20-
4. Hit the "+" button to add a new SSH connection
21-
22-
![Gateway Add Connection](../images/gateway/gateway-add-ssh-configuration.png)
23-
24-
1. For the Host, enter `coder.<workspace name>`
25-
2. For the Port, enter `22` (this is ignored by Coder)
26-
3. For the Username, enter `coder`
27-
4. For the Authentication Type, select "OpenSSH config and authentication
28-
agent"
29-
5. Make sure the checkbox for "Parse config file ~/.ssh/config" is checked.
30-
6. Click "Test Connection" to ensure you setting are ok.
31-
7. Click "OK"
32-
33-
![Gateway SSH
34-
Configuration](../images/gateway/gateway-create-ssh-configuration.png)
35-
36-
5. Select the connection you just added.
37-
38-
![Gateway Welcome](../images/gateway/gateway-welcome.png)
39-
40-
6. Click "Check Connection and Continue"
41-
42-
![Gateway Continue](../images/gateway/gateway-continue.png)
43-
44-
7. Select the JetBrains IDE for your project and the project directory
45-
1. Use an SSH terminal to your workspace to create a directory or check out
46-
code if you haven't already.
47-
48-
> Note the JetBrains IDE is installed in the directory `~/.
49-
> cache/JetBrains/RemoteDev/dist`
50-
51-
![Gateway Choose IDE](../images/gateway/gateway-choose-ide.png)
52-
53-
8. Click "Download and Start IDE" to connect.
54-
55-
![Gateway IDE Opened](../images/gateway/gateway-intellij-opened.png)
56-
57-
11+
1. Click "New Connection"
12+
![Gateway Home](../images/gateway/gateway-home.png)
13+
1. In the resulting dialog, click the gear icon to the right of "Connection:"
14+
![Gateway New Connection](../images/gateway/gateway-new-connection.png)
15+
1. Hit the "+" button to add a new SSH connection
16+
![Gateway Add Connection](../images/gateway/gateway-add-ssh-configuration.png)
17+
18+
1. For the Host, enter `coder.<workspace name>`
19+
1. For the Port, enter `22` (this is ignored by Coder)
20+
1. For the Username, enter `coder`
21+
1. For the Authentication Type, select "OpenSSH config and authentication
22+
agent"
23+
1. Make sure the checkbox for "Parse config file ~/.ssh/config" is checked.
24+
1. Click "Test Connection" to validate these settings.
25+
1. Click "OK"
26+
![Gateway SSH Configuration](../images/gateway/gateway-create-ssh-configuration.png)
27+
1. Select the connection you just added
28+
![Gateway Welcome](../images/gateway/gateway-welcome.png)
29+
1. Click "Check Connection and Continue"
30+
![Gateway Continue](../images/gateway/gateway-continue.png)
31+
1. Select the JetBrains IDE for your project and the project directory.
32+
SSH into your server to create a directory or check out code if you haven't already.
33+
![Gateway Choose IDE](../images/gateway/gateway-choose-ide.png)
34+
> Note the JetBrains IDE is remotely installed into `~/. cache/JetBrains/RemoteDev/dist`
35+
1. Click "Download and Start IDE" to connect.
36+
![Gateway IDE Opened](../images/gateway/gateway-intellij-opened.png)

docs/manifest.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,8 @@
8383
"path": "./ides/configuring-web-ides.md"
8484
},
8585
{
86-
"title": "Configuring Jetbrains Gateway",
87-
"description": "Learn how to configure Jetbrains Gateway for your workspaces",
86+
"title": "Configuring JetBrains Gateway",
87+
"description": "Learn how to configure JetBrains Gateway for your workspaces",
8888
"path": "./ides/configuring-gateway.md"
8989
}
9090
]

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy