Skip to content

Commit c8d7b38

Browse files
bpmctbpmct
committed
Merge branch 'main' of github.com:coder/coder into main
2 parents 7806f3b + 7367253 commit c8d7b38

11 files changed

+79
-36
lines changed

‎docs/ides.md

Lines changed: 16 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,9 @@
33
The following desktop IDEs have been tested with Coder, though any IDE with SSH
44
support should work:
55

6-
- VS Code (with [Remote -
7-
SSH](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh)
6+
- [VS Code Remote SSH](#vs-code-remote)
87
extension)
9-
- JetBrains (with
10-
[Gateway](https://www.jetbrains.com/help/idea/remote-development-a.html#launch_gateway)
8+
- [JetBrains with Gateway](./ides/configuring-gateway.md)
119
installed)
1210
- IntelliJ IDEA
1311
- CLion
@@ -17,7 +15,7 @@ support should work:
1715
- RubyMine
1816
- WebStorm
1917
- Web IDEs (code-server, JupyterLab, Jetbrains Projector)
20-
- Note: These are [configured in the template](./ides/configuring-web-ides.md)
18+
- Note: These are [configured in the template](./ides/configuring-web-ides.md)
2119

2220
## SSH configuration
2321

@@ -53,48 +51,31 @@ Code, connected to your Coder workspace for compute, etc.
5351

5452
1. Open VS Code locally.
5553

56-
1. Install the [Remote - SSH](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh)
54+
1. Install the [Remote -
55+
SSH](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh)
5756
extension.
5857

5958
1. In VS Code's left-hand nav bar, click **Remote Explorer** and right-click on
6059
a workspace to connect.
6160

6261
## JetBrains Gateway
6362

64-
Gateway operates in a client-server model, using an SSH connection to the remote host to install
65-
and start the server.
66-
67-
Setting up Gateway also involves picking a project directory, so if you have not already done so,
68-
you may wish to open a terminal on your Coder workspace and check out a copy of the project you
69-
intend to work on.
70-
71-
After installing Gateway on your local system, you may connect to a Coder workspace as follows
72-
73-
1. Open Gateway, make sure "SSH" is selected under "Remote Development"
74-
2. Click "New Connection"
75-
3. In the resulting dialog, click the gear icon to the right of "Connection:"
76-
4. Hit the "+" button to add a new SSH connection
77-
1. For the Host, enter `coder.<workspace name>`
78-
2. For the Port, enter `22` (this is ignored by Coder)
79-
3. For the Username, enter `coder`
80-
4. For the Authentication Type, select "OpenSSH config and authentication agent"
81-
5. Make sure the checkbox for "Parse config file ~/.ssh/config" is checked.
82-
6. Click "Test Connection" to ensure you setting are ok.
83-
7. Click "OK"
84-
5. Select the connection you just added.
85-
6. Click "Check Connection and Continue"
86-
7. Select the JetBrains IDE for your project and the project directory
87-
1. Use an SSH terminal to your workspace to create a directory or check out code if you haven't
88-
already.
89-
8. Click "Download and Start IDE" to connect.
63+
Gateway operates in a client-server model, using an SSH connection to the remote
64+
host to install and start the server.
65+
66+
Setting up Gateway also involves picking a project directory, so if you have not
67+
already done so, you may wish to open a terminal on your Coder workspace and
68+
check out a copy of the project you intend to work on.
69+
70+
After installing Gateway on your local system, [follow these steps to create a
71+
Connection and connect to your Coder workspace.](./ides/configuring-gateway.md)
9072

9173
| Version | Status | Notes |
92-
|-----------|---------|----------------------------------------------------------|
74+
| --------- | ------- | -------------------------------------------------------- |
9375
| 2021.3.2 | Working | |
94-
| 2022.1.1 | Working | Windows clients are unable to connect to Linux workspace |
76+
| 2022.1.4 | Working | Windows clients are unable to connect to Linux workspace |
9577
| 2022.2 RC | Working | Version >= 222.3345.108 |
9678

97-
9879
## Web IDEs (Jupyter, code-server, Jetbrains Projector)
9980

10081
Web IDEs (code-server, JetBrains Projector, VNC, etc.) are defined in the template. See [configuring IDEs](./ides/configuring-web-ides.md).

‎docs/ides/configuring-gateway.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Configuring JetBrains Gateway
2+
3+
The following screenshots outline in more detail how to create a new Connection
4+
for JetBrains Gateway to a Coder workspace.
5+
6+
## Creating a new JetBrains Gateway Connection
7+
8+
After installing Gateway on your local system, you may connect to a Coder
9+
workspace as follows
10+
11+
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+

‎docs/images/gateway/gateway-add-ssh-configuration.png

88.6 KB
Loading

‎docs/images/gateway/gateway-choose-ide.png

139 KB
Loading

‎docs/images/gateway/gateway-continue.png

105 KB
Loading

‎docs/images/gateway/gateway-create-ssh-configuration.png

146 KB
Loading

‎docs/images/gateway/gateway-home.png

111 KB
Loading

‎docs/images/gateway/gateway-intellij-opened.png

377 KB
Loading

‎docs/images/gateway/gateway-new-connection.png

127 KB
Loading

‎docs/images/gateway/gateway-welcome.png

122 KB
Loading

‎docs/manifest.json

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
"title": "GitHub OAuth",
3030
"description": "Learn how to set up OAuth using your GitHub organization.",
3131
"path": "./install/oauth.md"
32-
}
32+
}
3333
]
3434
},
3535
{
@@ -81,6 +81,11 @@
8181
"title": "Configuring Web IDEs",
8282
"description": "Learn how to configure web IDEs in your templates",
8383
"path": "./ides/configuring-web-ides.md"
84+
},
85+
{
86+
"title": "Configuring Jetbrains Gateway",
87+
"description": "Learn how to configure Jetbrains Gateway for your workspaces",
88+
"path": "./ides/configuring-gateway.md"
8489
}
8590
]
8691
},

0 commit comments

Comments
 (0)