Skip to content

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.

Sign up for GitHub

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 23 commits into from
May 22, 2025
+46 −0
Merged

docs: add jetbrains toolbox steps #17661

Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
b4a0e12
add toolbox steps
EdwardAngert May 2, 2025
00b0249
Merge branch 'main' into 16883-jetbrains-toolbox
EdwardAngert May 8, 2025
40d68ec
fix: persist terraform modules during template import (#17665)
aslilac May 8, 2025
94c9d4c
fix: revert fix: persist terraform modules during template import (#1…
sreya May 9, 2025
c90608d
chore: add prebuild docs (#17580)
dannykopping May 9, 2025
817ec87
fix: fixed flaking VPN tunnel tests & bump coder/quartz to 0.1.3 (#17…
ibetitsmike May 9, 2025
77abfea
chore: extract app access logic for reuse (#17724)
BrunoQuaresma May 9, 2025
705ae40
chore: add keys for each app on workspaces table (#17726)
BrunoQuaresma May 9, 2025
2de22f9
refactor: improve apps.ts readbility (#17741)
BrunoQuaresma May 9, 2025
28a00de
chore: fix :first-child warning (#17727)
BrunoQuaresma May 9, 2025
2a9608c
chore: replace MUI icons - 1 (#17731)
BrunoQuaresma May 9, 2025
2df2161
chore: upgrade `terraform-provider-coder` & `preview` libs (#17738)
dannykopping May 9, 2025
eef1655
docs: clarify parameter autofill documentation (#17728)
EdwardAngert May 9, 2025
e05cafe
refactor: add safe list for external app protocols (#17742)
BrunoQuaresma May 9, 2025
2058980
chore: replace MUI icons - 2 (#17732)
BrunoQuaresma May 9, 2025
576eb8a
chore: replace MUI icons - 3 (#17733)
BrunoQuaresma May 9, 2025
34846f4
move toolbox to separate doc
EdwardAngert May 9, 2025
e178e47
fix parameters; require token
EdwardAngert May 9, 2025
006780c
Merge branch 'main' into 16883-jetbrains-toolbox
EdwardAngert May 12, 2025
f6473dd
fix link
EdwardAngert May 12, 2025
e401225
Merge branch 'main' into 16883-jetbrains-toolbox
matifali May 20, 2025
0bd8bfe
prereqs and internal certs
EdwardAngert May 21, 2025
1c41df3
Merge branch 'main' into 16883-jetbrains-toolbox
EdwardAngert May 21, 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
46 changes: 46 additions & 0 deletions docs/user-guides/workspace-access/jetbrains/jetbrains-toolbox.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# JetBrains Toolbox Integration

JetBrains Toolbox helps you manage JetBrains products and includes remote development capabilities for connecting to Coder workspaces.

## Install the Coder plugin for Toolbox

1. Install [JetBrains Toolbox](https://www.jetbrains.com/toolbox-app/) version 2.6.0.40632 or later.

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
Copy link
Member

Choose a reason for hiding this comment

The 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.

Copy link
Collaborator

Choose a reason for hiding this comment

The 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 :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The 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:

- Download from [GitHub Releases](https://github.com/coder/coder-jetbrains-toolbox/releases).

## 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&token=<auth-token>&workspace=my-workspace
```

Required parameters:

- `url`: Your Coder deployment URL
- `token`: Coder authentication token
- `workspace`: Name of your workspace

Optional parameters:

- `agent_id`: ID of the agent (only required if workspace has multiple agents)
- `folder`: Specific project folder path to open
- `ide_product_code`: Specific IDE product code (e.g., "IU" for IntelliJ IDEA Ultimate)
- `ide_build_number`: Specific build number of the JetBrains IDE

For more details, see the [coder-jetbrains-toolbox repository](https://github.com/coder/coder-jetbrains-toolbox#connect-to-a-coder-workspace-via-jetbrains-toolbox-uri).

## Configure internal certificates

To connect to a Coder deployment that uses internal certificates, configure the certificates directly in JetBrains Toolbox:

1. Click the settings icon (⚙) in the lower left corner of JetBrains Toolbox.
1. Select **Settings**.
1. Go to the **Coder** section.
1. Add your certificate path in the **CA Path** field.
Loading