diff --git a/docs/ides/gateway.md b/docs/ides/gateway.md index 290c2bd456..e1a80276af 100644 --- a/docs/ides/gateway.md +++ b/docs/ides/gateway.md @@ -1,7 +1,30 @@ # JetBrains Gateway -The following walkthrough details how to connect JetBrains Gateway to -Coder. +JetBrains Gateway is a compact desktop app that allows you to work remotely with a JetBrains IDE without even downloading one. [See JetBrains' website to learn about and Gateway.](https://www.jetbrains.com/remote-development/gateway/) + +Gateway can connect to a Coder workspace by using Coder's Gateway plugin or manually setting up an SSH connection. + +## Using Coder's JetBrains Gateway Plugin + +> The Coder plugin is an alpha state. 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) +1. Open Gateway and click the gear icon at the bottom left and then "Settings" +1. In the Marketplace tab within Plugins, type Coder and then click "Install" and "OK" + ![Gateway Settings and Marketplace](../images/gateway/plugin-settings-marketplace.png) +1. Click the new "Coder" icon on the Gateway home screen + ![Gateway Connect to Coder](../images/gateway/plugin-connect-to-coder.png) +1. Enter your Coder deployment's Access Url and click "Connect" then paste the Session Token and click "OK" + ![Gateway Session Token](../images/gateway/plugin-session-token.png) +1. 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, click the green arrow to start the workspace +1. Once the workspace status says 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 IDE Opened](../images/gateway/gateway-intellij-opened.png) + +> Note the JetBrains IDE is remotely installed into `~/. cache/JetBrains/RemoteDev/dist` ## Creating a new JetBrains Gateway Connection diff --git a/docs/ides/web-ides.md b/docs/ides/web-ides.md index a436b5fa87..4dbce7f955 100644 --- a/docs/ides/web-ides.md +++ b/docs/ides/web-ides.md @@ -50,9 +50,12 @@ resource "coder_agent" "main" { os = "linux" startup_script = <