Skip to content

Add JetBrains Gateway doc #3104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 22, 2022
Merged

Add JetBrains Gateway doc #3104

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
293287d
Add JetBrains Gateway doc
spikecurtis Jul 21, 2022
16a041d
Added GitHub issue to track Gateway failure
spikecurtis Jul 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions docs/ides.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.<workspace name>`
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 | [GitHub Issue](https://github.com/coder/coder/issues/3125) |


## 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).