Skip to content

Commit 8e655b4

Browse files
sharkymarksharkymark
authored
chore(docs): Added macOS self-signed cert add step and moved plugin docs to top (#7859)
1 parent fa8f50a commit 8e655b4

File tree

1 file changed

+61
-53
lines changed

1 file changed

+61
-53
lines changed

‎docs/ides/gateway.md

+61-53
Original file line numberDiff line numberDiff line change
@@ -4,58 +4,9 @@ JetBrains Gateway is a compact desktop app that allows you to work remotely with
44

55
Gateway can connect to a Coder workspace by using Coder's Gateway plugin or manually setting up an SSH connection.
66

7-
## Creating a new JetBrains Gateway Connection
8-
9-
1. [Install Gateway](https://www.jetbrains.com/help/idea/jetbrains-gateway.html)
10-
1. [Configure the `coder` CLI](../ides.md#ssh-configuration)
11-
1. Open Gateway, make sure "SSH" is selected under "Remote Development"
12-
1. Click "New Connection"
13-
![Gateway Home](../images/gateway/gateway-home.png)
14-
1. In the resulting dialog, click the gear icon to the right of "Connection:"
15-
![Gateway New Connection](../images/gateway/gateway-new-connection.png)
16-
1. Hit the "+" button to add a new SSH connection
17-
![Gateway Add Connection](../images/gateway/gateway-add-ssh-configuration.png)
18-
19-
1. For the Host, enter `coder.<workspace name>`
20-
1. For the Port, enter `22` (this is ignored by Coder)
21-
1. For the Username, enter your workspace username
22-
1. For the Authentication Type, select "OpenSSH config and authentication
23-
agent"
24-
1. Make sure the checkbox for "Parse config file ~/.ssh/config" is checked.
25-
1. Click "Test Connection" to validate these settings.
26-
1. Click "OK"
27-
![Gateway SSH Configuration](../images/gateway/gateway-create-ssh-configuration.png)
28-
1. Select the connection you just added
29-
![Gateway Welcome](../images/gateway/gateway-welcome.png)
30-
1. Click "Check Connection and Continue"
31-
![Gateway Continue](../images/gateway/gateway-continue.png)
32-
1. Select the JetBrains IDE for your project and the project directory.
33-
SSH into your server to create a directory or check out code if you haven't already.
34-
![Gateway Choose IDE](../images/gateway/gateway-choose-ide.png)
35-
> Note the JetBrains IDE is remotely installed into `~/. cache/JetBrains/RemoteDev/dist`
36-
1. Click "Download and Start IDE" to connect.
37-
![Gateway IDE Opened](../images/gateway/gateway-intellij-opened.png)
38-
39-
## Using an existing JetBrains installation in the workspace
40-
41-
If you would like to use an existing JetBrains IDE in a Coder workspace (or you
42-
are air-gapped, and cannot reach jetbrains.com), run the following script in the
43-
JetBrains IDE directory to point the default Gateway directory to the IDE
44-
directory. This step must be done before configuring Gateway.
45-
46-
```sh
47-
cd /opt/idea/bin
48-
./remote-dev-server.sh registerBackendLocationForGateway
49-
```
50-
51-
> Gateway only works with paid versions of JetBrains IDEs so the script will not be located in the `bin` directory of JetBrains Community editions.
52-
53-
[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)
54-
explaining this IDE specification.
55-
567
## Using Coder's JetBrains Gateway Plugin
578

58-
> 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).
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).
5910
6011
1. [Install Gateway](https://www.jetbrains.com/help/idea/jetbrains-gateway.html)
6112
1. Open Gateway and click the gear icon at the bottom left and then "Settings"
@@ -75,7 +26,7 @@ explaining this IDE specification.
7526

7627
> Note the JetBrains IDE is remotely installed into `~/.cache/JetBrains/RemoteDev/dist`
7728
78-
## Configuring Gateway to use internal certificates
29+
### Configuring the Gateway plugin to use internal certificates
7930

8031
When attempting to connect to a Coder deployment that uses internally signed certificates,
8132
you may receive the following error in Gateway:
@@ -108,12 +59,69 @@ with Java:
10859
keytool -import -alias coder -file <certificate> -keystore /path/to/trust/store
10960
```
11061

111-
On Windows, you can use `keytool` that ships with the JetBrains Gateway installation.
112-
For example:
62+
You can use `keytool` that ships with the JetBrains Gateway installation.
63+
Windows example:
11364

11465
```powershell
11566
& 'C:\Program Files\JetBrains\JetBrains Gateway <version>/jbr/bin/keytool.exe' 'C:\Program Files\JetBrains\JetBrains Gateway <version>/jre/lib/security/cacerts' -import -alias coder -file <cert>
11667
11768
# command for Toolbox installation
11869
& '%USERPROFILE%\AppData\Local\JetBrains\Toolbox\apps\Gateway\ch-0\<VERSION>\jbr\bin\keytool.exe' '%USERPROFILE%\AppData\Local\JetBrains\Toolbox\bin\jre\lib\security\cacerts' -import -alias coder -file <cert>
11970
```
71+
72+
macOS example:
73+
74+
```sh
75+
keytool -import -alias coder -file cacert.pem -keystore /Applications/JetBrains\ Gateway.app/Contents/jbr/Contents/Home/lib/security/cacerts
76+
```
77+
78+
## Manually Configuring A JetBrains Gateway Connection
79+
80+
> This is in lieu of using Coder's Gateway plugin which automatically performs these steps.
81+
82+
1. [Install Gateway](https://www.jetbrains.com/help/idea/jetbrains-gateway.html)
83+
1. [Configure the `coder` CLI](../ides.md#ssh-configuration)
84+
1. Open Gateway, make sure "SSH" is selected under "Remote Development"
85+
1. Click "New Connection"
86+
![Gateway Home](../images/gateway/gateway-home.png)
87+
1. In the resulting dialog, click the gear icon to the right of "Connection:"
88+
![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)
91+
92+
1. For the Host, enter `coder.<workspace name>`
93+
1. For the Port, enter `22` (this is ignored by Coder)
94+
1. For the Username, enter your workspace username
95+
1. For the Authentication Type, select "OpenSSH config and authentication
96+
agent"
97+
1. Make sure the checkbox for "Parse config file ~/.ssh/config" is checked.
98+
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.
107+
![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)
111+
112+
## Using an existing JetBrains installation in the workspace
113+
114+
If you would like to use an existing JetBrains IDE in a Coder workspace (or you
115+
are air-gapped, and cannot reach jetbrains.com), run the following script in the
116+
JetBrains IDE directory to point the default Gateway directory to the IDE
117+
directory. This step must be done before configuring Gateway.
118+
119+
```sh
120+
cd /opt/idea/bin
121+
./remote-dev-server.sh registerBackendLocationForGateway
122+
```
123+
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.
125+
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)
127+
explaining this IDE specification.

0 commit comments

Comments
 (0)