# JetBrains IDEs Coder supports JetBrains IDEs using [Gateway](https://www.jetbrains.com/remote-development/gateway/). The following IDEs are supported for remote development: - IntelliJ IDEA - CLion - GoLand - PyCharm - Rider - RubyMine - WebStorm - PhpStorm - RustRover - [JetBrains Fleet](#jetbrains-fleet) ## 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. You can [pre-install the JetBrains Gateway backend](../../../admin/templates/extending-templates/jetbrains-gateway.md) in a template to help JetBrains load faster in workspaces. ### 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: ![Gateway Connect to Coder](../../../images/gateway/plugin-connect-to-coder.png) 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**: ![Gateway Session Token](../../../images/gateway/plugin-session-token.png) 1. To create a new workspace: Click the + 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**: ![Gateway IDE List](../../../images/gateway/plugin-select-ide.png) 1. Select the JetBrains IDE for your project and the project directory then click **Start IDE and connect**: ![Gateway Select IDE](../../../images/gateway/plugin-ide-list.png) Gateway connects using the IDE you selected: ![Gateway IDE Opened](../../../images/gateway/gateway-intellij-opened.png) 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**: ![Gateway Settings and Marketplace](../../../images/gateway/plugin-settings-marketplace.png) ### 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:
#### Linux ```none /jbr/lib/security/cacerts ``` Use the `keytool` utility that ships with Java: ```shell keytool -import -alias coder -file -keystore /path/to/trust/store ``` #### macOS ```none /jbr/lib/security/cacerts /Library/Application Support/JetBrains/Toolbox/apps/JetBrainsGateway/ch-0//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)\\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 /jbr/bin/keytool.exe' 'C:\Program Files\JetBrains\JetBrains Gateway /jre/lib/security/cacerts' -import -alias coder -file # command for Toolbox installation & '%USERPROFILE%\AppData\Local\JetBrains\Toolbox\apps\Gateway\ch-0\\jbr\bin\keytool.exe' '%USERPROFILE%\AppData\Local\JetBrains\Toolbox\bin\jre\lib\security\cacerts' -import -alias coder -file ```
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](../../../user-guides/workspace-access/index.md#configure-ssh). 1. Open Gateway, make sure **SSH** is selected under **Remote Development**. 1. Click **New Connection**: ![Gateway Home](../../../images/gateway/gateway-home.png) 1. In the resulting dialog, click the gear icon to the right of **Connection**: ![Gateway New Connection](../../../images/gateway/gateway-new-connection.png) 1. Click + to add a new SSH connection: ![Gateway Add Connection](../../../images/gateway/gateway-add-ssh-configuration.png) 1. For the Host, enter `coder.` 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**: ![Gateway SSH Configuration](../../../images/gateway/gateway-create-ssh-configuration.png) 1. Select the connection you just added: ![Gateway Welcome](../../../images/gateway/gateway-welcome.png) 1. Click **Check Connection and Continue**: ![Gateway Continue](../../../images/gateway/gateway-continue.png) 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. ![Gateway Choose IDE](../../../images/gateway/gateway-choose-ide.png) The JetBrains IDE is remotely installed into `~/.cache/JetBrains/RemoteDev/dist` 1. Click **Download and Start IDE** to connect. ![Gateway IDE Opened](../../../images/gateway/gateway-intellij-opened.png) ## Using an existing JetBrains installation in the workspace For JetBrains IDEs, you can use an existing installation in the workspace. Please ask your administrator to install the JetBrains Gateway backend in the workspace by following the [pre-install guide](../../../admin/templates/extending-templates/jetbrains-gateway.md). > [!NOTE] > Gateway only works with paid versions of JetBrains IDEs so the script will not > be located in the `bin` directory of JetBrains Community editions. [Here is the JetBrains article](https://www.jetbrains.com/help/idea/remote-development-troubleshooting.html#setup:~:text=Can%20I%20point%20Remote%20Development%20to%20an%20existing%20IDE%20on%20my%20remote%20server%3F%20Is%20it%20possible%20to%20install%20IDE%20manually%3F) explaining this IDE specification. ## JetBrains Fleet JetBrains Fleet is a code editor and lightweight IDE designed to support various programming languages and development environments. [See JetBrains's website](https://www.jetbrains.com/fleet/) to learn more about Fleet. To connect Fleet to a Coder workspace: 1. [Install Fleet](https://www.jetbrains.com/fleet/download) 1. Install Coder CLI ```shell curl -L https://coder.com/install.sh | sh ``` 1. Login and configure Coder SSH. ```shell coder login coder.example.com coder config-ssh ``` 1. Connect via SSH with the Host set to `coder.workspace-name` ![Fleet Connect to Coder](../../../images/fleet/ssh-connect-to-coder.png) If you experience any issues, please [create a GitHub issue](https://github.com/coder/coder/issues) or share in [our Discord channel](https://discord.gg/coder).