JetBrains Gateway

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 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 or share in our Discord channel.

1. Install Gateway and open the application.

2. Under Install More Providers, find the Coder icon and click Install to install the Coder plugin.

3. After Gateway installs the plugin, it will appear in the Run the IDE Remotely section.

   Click Connect to Coder to launch the plugin:

   

4. Enter your Coder deployment's 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:

   

5. 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.

6. If a workspace already exists but is stopped, select the workspace from the list, then click the green arrow to start the workspace.

7. When the workspace status is Running, click Select IDE and Project:

   

8. 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.

2. 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:

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:

2. In JetBrains, go to Settings > Tools > Coder.

3. 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.

2. Configure the coder CLI.

3. Open Gateway, make sure SSH is selected under Remote Development.

4. Click New Connection:

   

5. In the resulting dialog, click the gear icon to the right of Connection:

   

6. Click + to add a new SSH connection:

   

7. For the Host, enter coder.<workspace name>

8. For the Port, enter 22 (this is ignored by Coder)

9. For the Username, enter your workspace username.

10. For the Authentication Type, select OpenSSH config and authentication agent.

11. Make sure the checkbox for Parse config file ~/.ssh/config is checked.

12. Click Test Connection to validate these settings.

13. Click OK:

    

14. Select the connection you just added:

    

15. Click Check Connection and Continue:

    

16. 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

17. 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 in a template to make JetBrains IDE start faster on first connection.