Skip to content

Commit 9f76381

Browse files
sharkymarksharkymark
authored
chore: add install more providers step in jetbrains docs; update images (#8943)
1 parent e862719 commit 9f76381

6 files changed

+64
-43
lines changed

‎docs/ides/gateway.md

+64-43
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,62 @@
11
# JetBrains Gateway
22

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/)
3+
JetBrains Gateway is a compact desktop app that allows you to work remotely with
4+
a JetBrains IDE without even downloading one. [See JetBrains' website to learn
5+
about and Gateway.](https://www.jetbrains.com/remote-development/gateway/)
46

5-
Gateway can connect to a Coder workspace by using Coder's Gateway plugin or manually setting up an SSH connection.
7+
Gateway can connect to a Coder workspace by using Coder's Gateway plugin or
8+
manually setting up an SSH connection.
69

710
## Using Coder's JetBrains Gateway Plugin
811

9-
> 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).
12+
> If you experience problems, please [create a GitHub
13+
> issue](https://github.com/coder/coder/issues) or share in [our Discord
14+
> channel](https://discord.gg/coder).
1015
1116
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
17+
1. Open Gateway and click the Coder icon to install the Coder plugin.
18+
1. Click the "Coder" icon under Install More Providers at the bottom of the
19+
Gateway home screen
20+
1. Click "Connect to Coder" at the top of the Gateway home screen to launch the
21+
plugin ![Gateway Connect to
22+
Coder](../images/gateway/plugin-connect-to-coder.png)
23+
1. Enter your Coder deployment's Access Url and click "Connect" then paste the
24+
Session Token and click "OK" ![Gateway Session
25+
Token](../images/gateway/plugin-session-token.png)
26+
1. Click the "+" icon to open a browser and go to the templates page in your
27+
Coder deployment to create a workspace
28+
1. If a workspace already exists but is stopped, click the green arrow to start
29+
the workspace
2130
1. Once the workspace status says Running, click "Select IDE and Project"
2231
![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)
32+
1. Select the JetBrains IDE for your project and the project directory then
33+
click "Start IDE and connect" ![Gateway Select
34+
IDE](../images/gateway/plugin-ide-list.png) ![Gateway IDE
35+
Opened](../images/gateway/gateway-intellij-opened.png)
2636

27-
> Note the JetBrains IDE is remotely installed into `~/.cache/JetBrains/RemoteDev/dist`
37+
> Note the JetBrains IDE is remotely installed into
38+
> `~/.cache/JetBrains/RemoteDev/dist`
39+
40+
### Update a Coder plugin version
41+
42+
1. Click the gear icon at the bottom left of the Gateway home screen and then
43+
"Settings"
44+
1. In the Marketplace tab within Plugins, type Coder and if a newer plugin
45+
release is available, click "Update" and "OK" ![Gateway Settings and
46+
Marketplace](../images/gateway/plugin-settings-marketplace.png)
2847

2948
### Configuring the Gateway plugin to use internal certificates
3049

31-
When attempting to connect to a Coder deployment that uses internally signed certificates,
32-
you may receive the following error in Gateway:
50+
When attempting to connect to a Coder deployment that uses internally signed
51+
certificates, you may receive the following error in Gateway:
3352

3453
```console
3554
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
3655
```
3756

38-
To resolve this issue, you will need to add Coder's certificate to the Java trust store
39-
present on your local machine. Here is the default location of the trust store for
40-
each OS:
57+
To resolve this issue, you will need to add Coder's certificate to the Java
58+
trust store present on your local machine. Here is the default location of the
59+
trust store for each OS:
4160

4261
```console
4362
# Linux
@@ -52,8 +71,8 @@ C:\Program Files (x86)\<Gateway installation directory>\jre\lib\security\cacerts
5271
%USERPROFILE%\AppData\Local\JetBrains\Toolbox\bin\jre\lib\security\cacerts # Path for Toolbox installation
5372
```
5473

55-
To add the certificate to the keystore, you can use the `keytool` utility that ships
56-
with Java:
74+
To add the certificate to the keystore, you can use the `keytool` utility that
75+
ships with Java:
5776

5877
```console
5978
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\
7796

7897
## Manually Configuring A JetBrains Gateway Connection
7998

80-
> This is in lieu of using Coder's Gateway plugin which automatically performs these steps.
99+
> This is in lieu of using Coder's Gateway plugin which automatically performs
100+
> these steps.
81101
82102
1. [Install Gateway](https://www.jetbrains.com/help/idea/jetbrains-gateway.html)
83103
1. [Configure the `coder` CLI](../ides.md#ssh-configuration)
84104
1. Open Gateway, make sure "SSH" is selected under "Remote Development"
85-
1. Click "New Connection"
86-
![Gateway Home](../images/gateway/gateway-home.png)
105+
1. Click "New Connection" ![Gateway Home](../images/gateway/gateway-home.png)
87106
1. In the resulting dialog, click the gear icon to the right of "Connection:"
88107
![Gateway New Connection](../images/gateway/gateway-new-connection.png)
89-
1. Hit the "+" button to add a new SSH connection
90-
![Gateway Add Connection](../images/gateway/gateway-add-ssh-configuration.png)
108+
1. Hit the "+" button to add a new SSH connection ![Gateway Add
109+
Connection](../images/gateway/gateway-add-ssh-configuration.png)
91110

92111
1. For the Host, enter `coder.<workspace name>`
93112
1. For the Port, enter `22` (this is ignored by Coder)
94113
1. For the Username, enter your workspace username
95-
1. For the Authentication Type, select "OpenSSH config and authentication
96-
agent"
114+
1. For the Authentication Type, select "OpenSSH config and authentication agent"
97115
1. Make sure the checkbox for "Parse config file ~/.ssh/config" is checked.
98116
1. Click "Test Connection" to validate these settings.
99-
1. Click "OK"
100-
![Gateway SSH Configuration](../images/gateway/gateway-create-ssh-configuration.png)
101-
1. Select the connection you just added
102-
![Gateway Welcome](../images/gateway/gateway-welcome.png)
103-
1. Click "Check Connection and Continue"
104-
![Gateway Continue](../images/gateway/gateway-continue.png)
105-
1. Select the JetBrains IDE for your project and the project directory.
106-
SSH into your server to create a directory or check out code if you haven't already.
117+
1. Click "OK" ![Gateway SSH
118+
Configuration](../images/gateway/gateway-create-ssh-configuration.png)
119+
1. Select the connection you just added ![Gateway
120+
Welcome](../images/gateway/gateway-welcome.png)
121+
1. Click "Check Connection and Continue" ![Gateway
122+
Continue](../images/gateway/gateway-continue.png)
123+
1. Select the JetBrains IDE for your project and the project directory. SSH into
124+
your server to create a directory or check out code if you haven't already.
107125
![Gateway Choose IDE](../images/gateway/gateway-choose-ide.png)
108-
> Note the JetBrains IDE is remotely installed into `~/. cache/JetBrains/RemoteDev/dist`
109-
1. Click "Download and Start IDE" to connect.
110-
![Gateway IDE Opened](../images/gateway/gateway-intellij-opened.png)
126+
> Note the JetBrains IDE is remotely installed into `~/.
127+
cache/JetBrains/RemoteDev/dist`
128+
1. Click "Download and Start IDE" to connect. ![Gateway IDE
129+
Opened](../images/gateway/gateway-intellij-opened.png)
111130

112131
## Using an existing JetBrains installation in the workspace
113132

@@ -121,7 +140,9 @@ cd /opt/idea/bin
121140
./remote-dev-server.sh registerBackendLocationForGateway
122141
```
123142

124-
> Gateway only works with paid versions of JetBrains IDEs so the script will not be located in the `bin` directory of JetBrains Community editions.
143+
> Gateway only works with paid versions of JetBrains IDEs so the script will not
144+
> be located in the `bin` directory of JetBrains Community editions.
125145
126-
[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)
146+
[Here is the JetBrains
147+
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)
127148
explaining this IDE specification.

‎docs/images/gateway/plugin-connect-to-coder.png

30.2 KB
Loading

‎docs/images/gateway/plugin-ide-list.png

67.9 KB
Loading

‎docs/images/gateway/plugin-select-ide.png

62.3 KB
Loading

‎docs/images/gateway/plugin-session-token.png

104 KB
Loading

‎docs/images/gateway/plugin-settings-marketplace.png

55.7 KB
Loading

0 commit comments

Comments
 (0)