From 293287dcd8c0edd383cd923fcfb1d201792e68dc Mon Sep 17 00:00:00 2001 From: Spike Curtis Date: Thu, 21 Jul 2022 16:14:35 -0700 Subject: [PATCH 1/2] Add JetBrains Gateway doc Signed-off-by: Spike Curtis --- docs/ides.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/docs/ides.md b/docs/ides.md index aa1044e002229..f105d7b3c3e62 100644 --- a/docs/ides.md +++ b/docs/ides.md @@ -59,6 +59,42 @@ Code, connected to your Coder workspace for compute, etc. 1. In VS Code's left-hand nav bar, click **Remote Explorer** and right-click on a workspace to connect. +## JetBrains Gateway + +Gateway operates in a client-server model, using an SSH connection to the remote host to install +and start the server. + +Setting up Gateway also involves picking a project directory, so if you have not already done so, +you may wish to open a terminal on your Coder workspace and check out a copy of the project you +intend to work on. + +After installing Gateway on your local system, you may connect to a Coder workspace as follows + +1. Open Gateway, make sure "SSH" is selected under "Remote Development" +2. Click "New Connection" +3. In the resulting dialog, click the gear icon to the right of "Connection:" +4. Hit the "+" button to add a new SSH connection + 1. For the Host, enter `coder.` + 2. For the Port, enter `22` (this is ignored by Coder) + 3. For the Username, enter `coder` + 4. For the Authentication Type, select "OpenSSH config and authentication agent" + 5. Make sure the checkbox for "Parse config file ~/.ssh/config" is checked. + 6. Click "Test Connection" to ensure you setting are ok. + 7. Click "OK" +5. Select the connection you just added. +6. Click "Check Connection and Continue" +7. Select the JetBrains IDE for your project and the project directory + 1. Use an SSH terminal to your workspace to create a directory or check out code if you haven't + already. +8. Click "Download and Start IDE" to connect. + +| Version | Status | Notes | +|-----------|-------------|----------------------------------------------------------| +| 2021.3.2 | Working | | +| 2022.1.1 | Working | Windows clients are unable to connect to Linux workspace | +| 2022.2 RC | Not working | | + + ## Web IDEs (Jupyter, code-server, Jetbrains Projector) Web IDEs (code-server, JetBrains Projector, VNC, etc.) are defined in the template. See [configuring IDEs](./ides/configuring-web-ides.md). From 16a041d27998231987fa2186e7feb9e3876fa23f Mon Sep 17 00:00:00 2001 From: Spike Curtis Date: Fri, 22 Jul 2022 09:09:20 -0700 Subject: [PATCH 2/2] Added GitHub issue to track Gateway failure Signed-off-by: Spike Curtis --- docs/ides.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/ides.md b/docs/ides.md index f105d7b3c3e62..e835aa804a4a0 100644 --- a/docs/ides.md +++ b/docs/ides.md @@ -88,11 +88,11 @@ After installing Gateway on your local system, you may connect to a Coder worksp already. 8. Click "Download and Start IDE" to connect. -| Version | Status | Notes | -|-----------|-------------|----------------------------------------------------------| -| 2021.3.2 | Working | | -| 2022.1.1 | Working | Windows clients are unable to connect to Linux workspace | -| 2022.2 RC | Not working | | +| Version | Status | Notes | +|-----------|-------------|------------------------------------------------------------| +| 2021.3.2 | Working | | +| 2022.1.1 | Working | Windows clients are unable to connect to Linux workspace | +| 2022.2 RC | Not working | [GitHub Issue](https://github.com/coder/coder/issues/3125) | ## Web IDEs (Jupyter, code-server, Jetbrains Projector)