Skip to content

Commit 5e32468

Browse files
authored
Add JetBrains Gateway doc (coder#3104)
* Add JetBrains Gateway doc Signed-off-by: Spike Curtis <spike@coder.com> * Added GitHub issue to track Gateway failure Signed-off-by: Spike Curtis <spike@coder.com>
1 parent c6016d2 commit 5e32468

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

docs/ides.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,42 @@ Code, connected to your Coder workspace for compute, etc.
5959
1. In VS Code's left-hand nav bar, click **Remote Explorer** and right-click on
6060
a workspace to connect.
6161

62+
## JetBrains Gateway
63+
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.
90+
91+
| Version | Status | Notes |
92+
|-----------|-------------|------------------------------------------------------------|
93+
| 2021.3.2 | Working | |
94+
| 2022.1.1 | Working | Windows clients are unable to connect to Linux workspace |
95+
| 2022.2 RC | Not working | [GitHub Issue](https://github.com/coder/coder/issues/3125) |
96+
97+
6298
## Web IDEs (Jupyter, code-server, Jetbrains Projector)
6399

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

0 commit comments

Comments
 (0)