mirror of https://github.com/coder/coder.git
chore: add install more providers step in jetbrains docs; update images (#8943)
This commit is contained in:
sharkymark
GitHub
parent
e8627195a2
commit
9f76381fc1
|
|
@ -1,43 +1,62 @@
|
|||
# JetBrains Gateway
|
||||
|
||||
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/)
|
||||
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.
|
||||
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
|
||||
|
||||
> 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).
|
||||
> 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"
|
||||
|
||||
1. Click the new "Coder" icon on the Gateway home screen
|
||||
|
||||
1. Enter your Coder deployment's Access Url and click "Connect" then paste the Session Token and click "OK"
|
||||
|
||||
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. Open Gateway and click the Coder icon to install the Coder plugin.
|
||||
1. Click the "Coder" icon under Install More Providers at the bottom of the
|
||||
Gateway home screen
|
||||
1. Click "Connect to Coder" at the top of the Gateway home screen to launch the
|
||||
plugin 
|
||||
1. Enter your Coder deployment's Access Url and click "Connect" then paste the
|
||||
Session Token and click "OK" 
|
||||
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"
|
||||
|
||||
1. Select the JetBrains IDE for your project and the project directory then click "Start IDE and connect"
|
||||
|
||||
|
||||
1. Select the JetBrains IDE for your project and the project directory then
|
||||
click "Start IDE and connect"  
|
||||
|
||||
> Note the JetBrains IDE is remotely installed into `~/.cache/JetBrains/RemoteDev/dist`
|
||||
> Note 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 and then
|
||||
"Settings"
|
||||
1. In the Marketplace tab within Plugins, type Coder and if a newer plugin
|
||||
release is available, click "Update" and "OK" 
|
||||
|
||||
### Configuring the Gateway plugin to use internal certificates
|
||||
|
||||
When attempting to connect to a Coder deployment that uses internally signed certificates,
|
||||
you may receive the following error in Gateway:
|
||||
When attempting to connect to a Coder deployment that uses internally signed
|
||||
certificates, you may receive the following error in Gateway:
|
||||
|
||||
```console
|
||||
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. Here is the default location of the trust store for
|
||||
each OS:
|
||||
To resolve this issue, you will need to add Coder's certificate to the Java
|
||||
trust store present on your local machine. Here is the default location of the
|
||||
trust store for each OS:
|
||||
|
||||
```console
|
||||
# Linux
|
||||
|
|
@ -52,8 +71,8 @@ C:\Program Files (x86)\<Gateway installation directory>\jre\lib\security\cacerts
|
|||
%USERPROFILE%\AppData\Local\JetBrains\Toolbox\bin\jre\lib\security\cacerts # Path for Toolbox installation
|
||||
```
|
||||
|
||||
To add the certificate to the keystore, you can use the `keytool` utility that ships
|
||||
with Java:
|
||||
To add the certificate to the keystore, you can use the `keytool` utility that
|
||||
ships with Java:
|
||||
|
||||
```console
|
||||
keytool -import -alias coder -file <certificate> -keystore /path/to/trust/store
|
||||
|
|
@ -77,37 +96,37 @@ keytool -import -alias coder -file cacert.pem -keystore /Applications/JetBrains\
|
|||
|
||||
## Manually Configuring A JetBrains Gateway Connection
|
||||
|
||||
> This is in lieu of using Coder's Gateway plugin which automatically performs these steps.
|
||||
> This is in lieu of using Coder's Gateway plugin which automatically performs
|
||||
> these steps.
|
||||
|
||||
1. [Install Gateway](https://www.jetbrains.com/help/idea/jetbrains-gateway.html)
|
||||
1. [Configure the `coder` CLI](../ides.md#ssh-configuration)
|
||||
1. Open Gateway, make sure "SSH" is selected under "Remote Development"
|
||||
1. Click "New Connection"
|
||||
|
||||
1. Click "New Connection" 
|
||||
1. In the resulting dialog, click the gear icon to the right of "Connection:"
|
||||
|
||||
1. Hit the "+" button to add a new SSH connection
|
||||
|
||||
1. Hit the "+" button to add a new SSH connection 
|
||||
|
||||
1. For the Host, enter `coder.<workspace name>`
|
||||
1. For the Port, enter `22` (this is ignored by Coder)
|
||||
1. For the Username, enter your workspace username
|
||||
1. For the Authentication Type, select "OpenSSH config and authentication
|
||||
agent"
|
||||
1. For the Authentication Type, select "OpenSSH config and authentication agent"
|
||||
1. Make sure the checkbox for "Parse config file ~/.ssh/config" is checked.
|
||||
1. Click "Test Connection" to validate these settings.
|
||||
1. Click "OK"
|
||||
|
||||
1. Select the connection you just added
|
||||
|
||||
1. Click "Check Connection and Continue"
|
||||
|
||||
1. 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.
|
||||
1. Click "OK" 
|
||||
1. Select the connection you just added 
|
||||
1. Click "Check Connection and Continue" 
|
||||
1. 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.
|
||||
|
||||
> Note the JetBrains IDE is remotely installed into `~/. cache/JetBrains/RemoteDev/dist`
|
||||
1. Click "Download and Start IDE" to connect.
|
||||
|
||||
> Note the JetBrains IDE is remotely installed into `~/.
|
||||
cache/JetBrains/RemoteDev/dist`
|
||||
1. Click "Download and Start IDE" to connect. 
|
||||
|
||||
## Using an existing JetBrains installation in the workspace
|
||||
|
||||
|
|
@ -121,7 +140,9 @@ 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.
|
||||
> 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)
|
||||
[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.
|
||||
|
|
|
|||
Binary file not shown.
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 43 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 88 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 85 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 132 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 58 KiB After Width: | Height: | Size: 113 KiB |
Loading…
Reference in New Issue