mirror of
https://github.com/coder/coder.git
synced 2025-07-12 00:14:10 +00:00
25e2146200
This pull request introduces significant updates to documentation and references related to JetBrains IDEs, including rebranding, restructuring, and adding new guides. [Preview](https://coder.com/docs/@atif%2Fjetbrains-reorganization) --------- Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
193 lines
7.0 KiB
Markdown
193 lines
7.0 KiB
Markdown
## JetBrains Gateway
|
|
|
|
JetBrains Gateway is a compact desktop app that allows you to work remotely with
|
|
a JetBrains IDE without downloading one. Visit the
|
|
[JetBrains Gateway website](https://www.jetbrains.com/remote-development/gateway/)
|
|
to learn more about Gateway.
|
|
|
|
Gateway can connect to a Coder workspace using Coder's Gateway plugin or through a
|
|
manually configured SSH connection.
|
|
|
|
### How to use the plugin
|
|
|
|
> If you experience problems, please
|
|
> [create a GitHub issue](https://github.com/coder/coder/issues) or share in
|
|
> [our Discord channel](https://discord.gg/coder).
|
|
|
|
1. [Install Gateway](https://www.jetbrains.com/help/idea/jetbrains-gateway.html)
|
|
and open the application.
|
|
1. Under **Install More Providers**, find the Coder icon and click **Install**
|
|
to install the Coder plugin.
|
|
1. After Gateway installs the plugin, it will appear in the **Run the IDE
|
|
Remotely** section.
|
|
|
|
Click **Connect to Coder** to launch the plugin:
|
|
|
|
|
|
|
|
1. Enter your Coder deployment's
|
|
[Access Url](../../../admin/setup/index.md#access-url) and click **Connect**.
|
|
|
|
Gateway opens your Coder deployment's `cli-auth` page with a session token.
|
|
Click the copy button, paste the session token in the Gateway **Session
|
|
Token** window, then click **OK**:
|
|
|
|
|
|
|
|
1. To create a new workspace:
|
|
|
|
Click the <kbd>+</kbd> icon to open a browser and go to the templates page in
|
|
your Coder deployment to create a workspace.
|
|
|
|
1. If a workspace already exists but is stopped, select the workspace from the
|
|
list, then click the green arrow to start the workspace.
|
|
|
|
1. When the workspace status is **Running**, click **Select IDE and Project**:
|
|
|
|
|
|
|
|
1. Select the JetBrains IDE for your project and the project directory then
|
|
click **Start IDE and connect**:
|
|
|
|
|
|
|
|
Gateway connects using the IDE you selected:
|
|
|
|
|
|
|
|
The JetBrains IDE is remotely installed into `~/.cache/JetBrains/RemoteDev/dist`.
|
|
|
|
### Update a Coder plugin version
|
|
|
|
1. Click the gear icon at the bottom left of the Gateway home screen, then
|
|
**Settings**.
|
|
|
|
1. In the **Marketplace** tab within Plugins, enter Coder and if a newer plugin
|
|
release is available, click **Update** then **OK**:
|
|
|
|
|
|
|
|
### Configuring the Gateway plugin to use internal certificates
|
|
|
|
When you attempt to connect to a Coder deployment that uses internally signed
|
|
certificates, you might receive the following error in Gateway:
|
|
|
|
```console
|
|
Failed to configure connection to https://coder.internal.enterprise/: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target
|
|
```
|
|
|
|
To resolve this issue, you will need to add Coder's certificate to the Java
|
|
trust store present on your local machine as well as to the Coder plugin settings.
|
|
|
|
1. Add the certificate to the Java trust store:
|
|
|
|
<div class="tabs">
|
|
|
|
#### Linux
|
|
|
|
```none
|
|
<Gateway installation directory>/jbr/lib/security/cacerts
|
|
```
|
|
|
|
Use the `keytool` utility that ships with Java:
|
|
|
|
```shell
|
|
keytool -import -alias coder -file <certificate> -keystore /path/to/trust/store
|
|
```
|
|
|
|
#### macOS
|
|
|
|
```none
|
|
<Gateway installation directory>/jbr/lib/security/cacerts
|
|
/Library/Application Support/JetBrains/Toolbox/apps/JetBrainsGateway/ch-0/<app-id>/JetBrains Gateway.app/Contents/jbr/Contents/Home/lib/security/cacerts # Path for Toolbox installation
|
|
```
|
|
|
|
Use the `keytool` included in the JetBrains Gateway installation:
|
|
|
|
```shell
|
|
keytool -import -alias coder -file cacert.pem -keystore /Applications/JetBrains\ Gateway.app/Contents/jbr/Contents/Home/lib/security/cacerts
|
|
```
|
|
|
|
#### Windows
|
|
|
|
```none
|
|
C:\Program Files (x86)\<Gateway installation directory>\jre\lib\security\cacerts\%USERPROFILE%\AppData\Local\JetBrains\Toolbox\bin\jre\lib\security\cacerts # Path for Toolbox installation
|
|
```
|
|
|
|
Use the `keytool` included in the JetBrains Gateway installation:
|
|
|
|
```powershell
|
|
& 'C:\Program Files\JetBrains\JetBrains Gateway <version>/jbr/bin/keytool.exe' 'C:\Program Files\JetBrains\JetBrains Gateway <version>/jre/lib/security/cacerts' -import -alias coder -file <cert>
|
|
|
|
# command for Toolbox installation
|
|
& '%USERPROFILE%\AppData\Local\JetBrains\Toolbox\apps\Gateway\ch-0\<VERSION>\jbr\bin\keytool.exe' '%USERPROFILE%\AppData\Local\JetBrains\Toolbox\bin\jre\lib\security\cacerts' -import -alias coder -file <cert>
|
|
```
|
|
|
|
</div>
|
|
|
|
1. In JetBrains, go to **Settings** > **Tools** > **Coder**.
|
|
|
|
1. Paste the path to the certificate in **CA Path**.
|
|
|
|
## Manually Configuring A JetBrains Gateway Connection
|
|
|
|
This is in lieu of using Coder's Gateway plugin which automatically performs these steps.
|
|
|
|
1. [Install Gateway](https://www.jetbrains.com/help/idea/jetbrains-gateway.html).
|
|
|
|
1. [Configure the `coder` CLI](../index.md#configure-ssh).
|
|
|
|
1. Open Gateway, make sure **SSH** is selected under **Remote Development**.
|
|
|
|
1. Click **New Connection**:
|
|
|
|
|
|
|
|
1. In the resulting dialog, click the gear icon to the right of **Connection**:
|
|
|
|
|
|
|
|
1. Click <kbd>+</kbd> to add a new SSH connection:
|
|
|
|
|
|
|
|
1. For the Host, enter `coder.<workspace name>`
|
|
|
|
1. For the Port, enter `22` (this is ignored by Coder)
|
|
|
|
1. For the Username, enter your workspace username.
|
|
|
|
1. For the Authentication Type, select **OpenSSH config and authentication
|
|
agent**.
|
|
|
|
1. Make sure the checkbox for **Parse config file ~/.ssh/config** is checked.
|
|
|
|
1. Click **Test Connection** to validate these settings.
|
|
|
|
1. Click **OK**:
|
|
|
|
|
|
|
|
1. Select the connection you just added:
|
|
|
|
|
|
|
|
1. Click **Check Connection and Continue**:
|
|
|
|
|
|
|
|
1. Select the JetBrains IDE for your project and the project directory. SSH into
|
|
your server to create a directory or check out code if you haven't already.
|
|
|
|
|
|
|
|
The JetBrains IDE is remotely installed into `~/.cache/JetBrains/RemoteDev/dist`
|
|
|
|
1. Click **Download and Start IDE** to connect.
|
|
|
|
|
|
|
|
## Using an existing JetBrains installation in the workspace
|
|
|
|
You can ask your template administrator to [pre-install the JetBrains IDEs backend](../../../admin/templates/extending-templates/jetbrains-preinstall.md) in a template to make JetBrains IDE start faster on first connection.
|