-
Notifications
You must be signed in to change notification settings - Fork 943
docs: add jetbrains toolbox steps #17661
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
Changes from 1 commit
b4a0e12
00b0249
40d68ec
94c9d4c
c90608d
817ec87
77abfea
705ae40
2de22f9
28a00de
2a9608c
2df2161
eef1655
e05cafe
2058980
576eb8a
34846f4
e178e47
006780c
f6473dd
e401225
0bd8bfe
1c41df3
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
# JetBrains Toolbox Integration | ||
|
||
JetBrains Toolbox helps you manage JetBrains products and includes remote development capabilities for connecting to Coder workspaces. | ||
|
||
## Before you begin | ||
|
||
- Install [JetBrains Toolbox](https://www.jetbrains.com/toolbox-app/) version 2.6.0.40284 or later | ||
- Ensure your Coder workspace [has the necessary IDE backends installed](../../../admin/templates/extending-templates/jetbrains-gateway.md) | ||
EdwardAngert marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Install the Coder plugin for Toolbox | ||
|
||
1. Open Toolbox and navigate to the **Remote Development** section. | ||
1. Install the Coder plugin using one of these methods: | ||
- Search for `Coder` in the **Remote Development** plugins section. | ||
- Use this URI to install directly: `jetbrains://gateway/com.coder.toolbox`. | ||
- Download from [JetBrains Marketplace](https://plugins.jetbrains.com/). | ||
Comment on lines
+11
to
+13
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can we add screenshots here? I think the best flow would be to show the screenshot and remove all these sub points. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is it worth mentioning our GH release page as well? Users can also download the plugin artifact from https://github.com/coder/coder-jetbrains-toolbox/releases. Would be nice for the project to receive some love :) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I added a link to the GH releases pages we should keep the text and generally only use screenshots when we really need to. sources: |
||
|
||
## Use URI parameters | ||
|
||
For direct connections or creating bookmarks, use custom URI links with parameters: | ||
|
||
```shell | ||
jetbrains://gateway/com.coder.toolbox?url=https://coder.example.com&workspace=my-workspace | ||
``` | ||
|
||
Required parameters: | ||
|
||
- `url`: Your Coder deployment URL | ||
- `workspace`: Name of your workspace | ||
|
||
Optional parameters: | ||
|
||
- `token`: Authentication token (use only in secure environments) | ||
- `folder`: Specific project folder path to open | ||
- `product`: Specific IDE product code (e.g., "IU" for IntelliJ IDEA Ultimate) | ||
|
||
## Configure internal certificates | ||
|
||
When connecting to a Coder deployment with internal certificates, follow the same procedure described in the [JetBrains Gateway](#configuring-the-gateway-plugin-to-use-internal-certificates) section above, but use the Toolbox installation paths: | ||
|
||
<div class="tabs"> | ||
|
||
### Linux | ||
|
||
```shell | ||
keytool -import -alias coder -file <path-to-certificate> -keystore "<toolbox-installation>/jbr/lib/security/cacerts" | ||
``` | ||
|
||
### macOS | ||
|
||
```shell | ||
keytool -import -alias coder -file <path-to-certificate> -keystore "$HOME/Library/Application Support/JetBrains/Toolbox/jbr/Contents/Home/lib/security/cacerts" | ||
``` | ||
|
||
### Windows | ||
|
||
```shell | ||
keytool -import -alias coder -file <path-to-certificate> -keystore "%USERPROFILE%\AppData\Local\JetBrains\Toolbox\jbr\lib\security\cacerts" | ||
``` | ||
|
||
</div> | ||
EdwardAngert marked this conversation as resolved.
Show resolved
Hide resolved
|
Uh oh!
There was an error while loading. Please reload this page.