mirror of https://github.com/coder/coder.git
docs: added alpha jetbrains gateway coder plugin | remove code-server version parameter (#5900)
This commit is contained in:
parent
7880b941b8
commit
2312bc4a6e
|
@ -1,7 +1,30 @@
|
||||||
# JetBrains Gateway
|
# JetBrains Gateway
|
||||||
|
|
||||||
The following walkthrough details how to connect JetBrains Gateway to
|
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/)
|
||||||
Coder.
|
|
||||||
|
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
|
## Creating a new JetBrains Gateway Connection
|
||||||
|
|
||||||
|
|
|
@ -50,9 +50,12 @@ resource "coder_agent" "main" {
|
||||||
os = "linux"
|
os = "linux"
|
||||||
startup_script = <<EOF
|
startup_script = <<EOF
|
||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# install and start code-server
|
# install code-server
|
||||||
# remove '-s -- --version 4.8.3' to install the latest version
|
# add '-s -- --version x.x.x' to install a specific code-server version
|
||||||
curl -fsSL https://code-server.dev/install.sh | sh -s -- --version 4.8.3
|
curl -fsSL https://code-server.dev/install.sh | sh
|
||||||
|
|
||||||
|
# start code-server on a specific port
|
||||||
|
# authn is off since the user already authn-ed into the coder deployment
|
||||||
code-server --auth none --port 13337
|
code-server --auth none --port 13337
|
||||||
EOF
|
EOF
|
||||||
}
|
}
|
||||||
|
@ -63,10 +66,10 @@ For advanced use, we recommend installing code-server in your VM snapshot or con
|
||||||
```Dockerfile
|
```Dockerfile
|
||||||
FROM codercom/enterprise-base:ubuntu
|
FROM codercom/enterprise-base:ubuntu
|
||||||
|
|
||||||
# install a specific code-server version
|
# install the latest version
|
||||||
RUN curl -fsSL https://code-server.dev/install.sh | sh -s -- --version=4.8.3
|
RUN curl -fsSL https://code-server.dev/install.sh | sh
|
||||||
|
|
||||||
# pre-install versions
|
# pre-install VS Code extensions
|
||||||
RUN code-server --install-extension eamodio.gitlens
|
RUN code-server --install-extension eamodio.gitlens
|
||||||
|
|
||||||
# directly start code-server with the agent's startup_script (see above),
|
# 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:
|
||||||
|
|
||||||
## JupyterLab
|
## JupyterLab
|
||||||
|
|
||||||
Configure your agent and `coder_app` like so to use Jupyter:
|
Configure your agent and `coder_app` like so to use Jupyter. Notice the
|
||||||
|
`subdomain=true` configuration:
|
||||||
|
|
||||||
```hcl
|
```hcl
|
||||||
data "coder_workspace" "me" {}
|
data "coder_workspace" "me" {}
|
||||||
|
|
Binary file not shown.
After Width: | Height: | Size: 43 KiB |
Binary file not shown.
After Width: | Height: | Size: 90 KiB |
Binary file not shown.
After Width: | Height: | Size: 79 KiB |
Binary file not shown.
After Width: | Height: | Size: 96 KiB |
Binary file not shown.
After Width: | Height: | Size: 214 KiB |
Loading…
Reference in New Issue