From 0dd834dcd5544ea76beb6c8758dd550d1e3b2995 Mon Sep 17 00:00:00 2001 From: Mark Milligan Date: Sun, 26 Feb 2023 23:12:58 +0000 Subject: [PATCH] docs: fixed broken podman template link and added already-installed ide gateway doc --- docs/ides/gateway.md | 61 +++++++++++++++++++----------- docs/templates/docker-in-docker.md | 2 +- 2 files changed, 40 insertions(+), 23 deletions(-) diff --git a/docs/ides/gateway.md b/docs/ides/gateway.md index e1a80276afaaf..a53ec01212faf 100644 --- a/docs/ides/gateway.md +++ b/docs/ides/gateway.md @@ -4,28 +4,6 @@ JetBrains Gateway is a compact desktop app that allows you to work remotely with 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 1. [Install Gateway](https://www.jetbrains.com/help/idea/jetbrains-gateway.html) @@ -57,3 +35,42 @@ Gateway can connect to a Coder workspace by using Coder's Gateway plugin or manu > Note 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 + +If you would like to use an existing JetBrains IDE in a Coder workspace (or you +are air-gapped, and cannot reach jetbrains.com), run the following script in the +JetBrains IDE directory to point the default Gateway directory to the IDE +directory. This step must be done before configuring Gateway. + +```sh +cd /opt/idea/bin +./remote-dev-server.sh registerBackendLocationForGateway +``` + +> 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. + +## 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` diff --git a/docs/templates/docker-in-docker.md b/docs/templates/docker-in-docker.md index 848aa83619329..21cf469d1c412 100644 --- a/docs/templates/docker-in-docker.md +++ b/docs/templates/docker-in-docker.md @@ -169,7 +169,7 @@ Prior to completing the steps below, please review the following Podman document 3. For systems running SELinux (typically Fedora-, CentOS-, and Red Hat-based systems), you may need to disable SELinux or set it to permissive mode. -4. Import our [kubernetes-podman](https://github.com/coder/coder/tree/main/examples/templates/kubernetes-podman) example template, or make your own. +4. Import our [kubernetes-podman](https://github.com/coder/coder/tree/main/examples/templates/kubernetes-with-podman) example template, or make your own. ```sh echo "kubernetes-podman" | coder templates init