Skip to content

Commit 2312bc4

Browse files
authored
docs: added alpha jetbrains gateway coder plugin | remove code-server version parameter (#5900)
1 parent 7880b94 commit 2312bc4

7 files changed

+36
-9
lines changed

docs/ides/gateway.md

+25-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,30 @@
11
# JetBrains Gateway
22

3-
The following walkthrough details how to connect JetBrains Gateway to
4-
Coder.
3+
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/)
4+
5+
Gateway can connect to a Coder workspace by using Coder's Gateway plugin or manually setting up an SSH connection.
6+
7+
## Using Coder's JetBrains Gateway Plugin
8+
9+
> 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).
10+
11+
1. [Install Gateway](https://www.jetbrains.com/help/idea/jetbrains-gateway.html)
12+
1. Open Gateway and click the gear icon at the bottom left and then "Settings"
13+
1. In the Marketplace tab within Plugins, type Coder and then click "Install" and "OK"
14+
![Gateway Settings and Marketplace](../images/gateway/plugin-settings-marketplace.png)
15+
1. Click the new "Coder" icon on the Gateway home screen
16+
![Gateway Connect to Coder](../images/gateway/plugin-connect-to-coder.png)
17+
1. Enter your Coder deployment's Access Url and click "Connect" then paste the Session Token and click "OK"
18+
![Gateway Session Token](../images/gateway/plugin-session-token.png)
19+
1. Click the "+" icon to open a browser and go to the templates page in your Coder deployment to create a workspace
20+
1. If a workspace already exists but is stopped, click the green arrow to start the workspace
21+
1. Once the workspace status says Running, click "Select IDE and Project"
22+
![Gateway IDE List](../images/gateway/plugin-select-ide.png)
23+
1. Select the JetBrains IDE for your project and the project directory then click "Start IDE and connect"
24+
![Gateway Select IDE](../images/gateway/plugin-ide-list.png)
25+
![Gateway IDE Opened](../images/gateway/gateway-intellij-opened.png)
26+
27+
> Note the JetBrains IDE is remotely installed into `~/. cache/JetBrains/RemoteDev/dist`
528
629
## Creating a new JetBrains Gateway Connection
730

docs/ides/web-ides.md

+11-7
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,12 @@ resource "coder_agent" "main" {
5050
os = "linux"
5151
startup_script = <<EOF
5252
#!/bin/sh
53-
# install and start code-server
54-
# remove '-s -- --version 4.8.3' to install the latest version
55-
curl -fsSL https://code-server.dev/install.sh | sh -s -- --version 4.8.3
53+
# install code-server
54+
# add '-s -- --version x.x.x' to install a specific code-server version
55+
curl -fsSL https://code-server.dev/install.sh | sh
56+
57+
# start code-server on a specific port
58+
# authn is off since the user already authn-ed into the coder deployment
5659
code-server --auth none --port 13337
5760
EOF
5861
}
@@ -63,10 +66,10 @@ For advanced use, we recommend installing code-server in your VM snapshot or con
6366
```Dockerfile
6467
FROM codercom/enterprise-base:ubuntu
6568

66-
# install a specific code-server version
67-
RUN curl -fsSL https://code-server.dev/install.sh | sh -s -- --version=4.8.3
69+
# install the latest version
70+
RUN curl -fsSL https://code-server.dev/install.sh | sh
6871

69-
# pre-install versions
72+
# pre-install VS Code extensions
7073
RUN code-server --install-extension eamodio.gitlens
7174

7275
# directly start code-server with the agent's startup_script (see above),
@@ -135,7 +138,8 @@ You can reference/use these pre-built templates with JetBrains projector:
135138

136139
## JupyterLab
137140

138-
Configure your agent and `coder_app` like so to use Jupyter:
141+
Configure your agent and `coder_app` like so to use Jupyter. Notice the
142+
`subdomain=true` configuration:
139143

140144
```hcl
141145
data "coder_workspace" "me" {}
42.6 KB
Loading
90.2 KB
Loading
79.3 KB
Loading
96.2 KB
Loading
Loading

0 commit comments

Comments
 (0)