10000 docs: add steps to pre-install JetBrains IDE backend by EdwardAngert · Pull Request #15962 · coder/coder · GitHub
[go: up one dir, main page]

Skip to content

docs: add steps to pre-install JetBrains IDE backend #15962

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 25 commits into from
Apr 11, 2025
Merged
Changes from 1 commit
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
754e44b
copy and md
EdwardAngert Dec 18, 2024
10472c8
Merge remote-tracking branch 'origin/main' into 13207-preinstall-jetb…
EdwardAngert Dec 26, 2024
75875f3
jetbrains initial copy and md edit
EdwardAngert Dec 26, 2024
047ca3b
Merge remote-tracking branch 'origin/main' into 13207-preinstall-jetb…
EdwardAngert Jan 2, 2025
74a5624
make fmt
EdwardAngert Jan 2, 2025
b5e8007
move JetBrains offline steps to separate doc; update links
EdwardAngert Jan 3, 2025
8cdbecf
Merge remote-tracking branch 'origin/main' into 13207-preinstall-jetb…
EdwardAngert Jan 3, 2025
5724624
fix relative links
EdwardAngert Jan 3, 2025
e9b1e18
s/offline/airgapped
EdwardAngert Jan 3, 2025
9ead169
copy edit
EdwardAngert Jan 7, 2025
d9062a0
Merge remote-tracking branch 'origin/main' into 13207-preinstall-jetb…
EdwardAngert Jan 7, 2025
302406a
copy edit
EdwardAngert Jan 8, 2025
951efd1
add jetbrains-pre-install
EdwardAngert Jan 8, 2025
c6ac5fa
Merge branch 'main' into 13207-preinstall-jetbrains
matifali Feb 5, 2025
c9c799f
Improve JetBrains Gateway installation documentation
matifali Mar 19, 2025
440dbc0
Update JetBrains Gateway backend setup instructions
matifali Mar 19, 2025
67103b4
Merge remote-tracking branch 'origin/main' into 13207-preinstall-jetb…
EdwardAngert Mar 21, 2025
fd81c47
align with changes from main
EdwardAngert Mar 21, 2025
dca1e38
Merge branch 'main' into 13207-preinstall-jetbrains
matifali Mar 26, 2025
99c1a59
Simplify JetBrains pre-installation guide
matifali Mar 26, 2025
c7e64e4
Simplify JetBrains pre-installation guide
matifali Mar 26, 2025
7a9e5c7
Merge branch 'main' into 13207-preinstall-jetbrains
matifali Apr 7, 2025
db684a5
Merge branch 'main' into 13207-preinstall-jetbrains
EdwardAngert Apr 9, 2025
3e9dd48
Merge branch 'main' into 13207-preinstall-jetbrains
EdwardAngert Apr 11, 2025
37fdb17
move gateway and update pre-install
EdwardAngert Apr 11, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
jetbrains initial copy and md edit
  • Loading branch information
EdwardAngert committed Dec 26, 2024
commit 75875f393f33855589d0d41436ab6b60a13928c7
56 changes: 32 additions & 24 deletions docs/user-guides/workspace-access/jetbrains.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# JetBrains IDEs

We support JetBrains IDEs using
Coder supports JetBrains IDEs using
[Gateway](https://www.jetbrains.com/remote-development/gateway/). The following
IDEs are supported for remote development:

Expand All @@ -16,11 +16,11 @@ IDEs are supported for remote development:
## JetBrains Gateway

JetBrains Gateway is a compact desktop app that allows you to work remotely with
a JetBrains IDE without even downloading one. Visit the
[JetBrains website](https://www.jetbrains.com/remote-development/gateway/) to
a JetBrains IDE without downloading one. Visit the
[JetBrains Gateway website](https://www.jetbrains.com/remote-development/gateway/) to
learn more about Gateway.

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

### How to use the plugin
Expand Down Expand Up @@ -75,8 +75,8 @@ manually setting up an SSH connection.

### Update a Coder plugin version

1. Click the gear icon at the bottom left of the Gateway home screen and then
"Settings"
1. Click the gear icon at the bottom left of the Gateway home screen, then
**Settings**.

1. In the **Marketplace** tab within Plugins, enter Coder and if a newer plugin
release is available, click **Update** then **OK**:
Expand All @@ -93,31 +93,42 @@ Failed to configure connection to https://coder.internal.enterprise/: PKIX path
```

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:
trust store present on your local machine:

```console
# Linux
<div class="tabs">

#### Linux

```none
<Gateway installation directory>/jbr/lib/security/cacerts
```

Use the `keytool` utility that ships with Java:

```shell
keytool -import -alias coder -file <certificate> -keystore /path/to/trust/store
```

#### macOS

# macOS
```none
<Gateway installation directory>/jbr/lib/security/cacerts
/Library/Application Support/JetBrains/Toolbox/apps/JetBrainsGateway/ch-0/<app-id>/JetBrains Gateway.app/Contents/jbr/Contents/Home/lib/security/cacerts # Path for Toolbox installation
```

Use the `keytool` included in the JetBrains Gateway installation:

# Windows
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
```shell
keytool -import -alias coder -file cacert.pem -keystore /Applications/JetBrains\ Gateway.app/Contents/jbr/Contents/Home/lib/security/cacerts
```

To add the certificate to the keystore, you can use the `keytool` utility that
ships with Java:
#### Windows

```console
keytool -import -alias coder -file <certificate> -keystore /path/to/trust/store
```none
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
```

You can use `keytool` that ships with the JetBrains Gateway installation.
Windows example:
Use the `keytool` included in the JetBrains Gateway installation:

```powershell
& '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>
Expand All @@ -126,11 +137,8 @@ Windows example:
& '%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>
```

macOS example:

```shell
keytool -import -alias coder -file cacert.pem -keystore /Applications/JetBrains\ Gateway.app/Contents/jbr/Contents/Home/lib/security/cacerts
```
</div>

## Manually Configuring A JetBrains Gateway Connection

Expand Down
Loading
0