|
| 1 | +# JetBrains Toolbox Integration |
| 2 | + |
| 3 | +JetBrains Toolbox helps you manage JetBrains products and includes remote development capabilities for connecting to Coder workspaces. |
| 4 | + |
| 5 | +## Install the Coder plugin for Toolbox |
| 6 | + |
| 7 | +1. Install [JetBrains Toolbox](https://www.jetbrains.com/toolbox-app/) version 2.6.0.40632 or later. |
| 8 | + |
| 9 | +1. Open Toolbox and navigate to the **Remote Development** section. |
| 10 | +1. Install the Coder plugin using one of these methods: |
| 11 | + - Search for `Coder` in the **Remote Development** plugins section. |
| 12 | + - Use this URI to install directly: `jetbrains://gateway/com.coder.toolbox`. |
| 13 | + - Download from [JetBrains Marketplace](https://plugins.jetbrains.com/). |
| 14 | + - Download from [GitHub Releases](https://github.com/coder/coder-jetbrains-toolbox/releases). |
| 15 | + |
| 16 | +## Use URI parameters |
| 17 | + |
| 18 | +For direct connections or creating bookmarks, use custom URI links with parameters: |
| 19 | + |
| 20 | +```shell |
| 21 | +jetbrains://gateway/com.coder.toolbox?url=https://coder.example.com&token=<auth-token>&workspace=my-workspace |
| 22 | +``` |
| 23 | + |
| 24 | +Required parameters: |
| 25 | + |
| 26 | +- `url`: Your Coder deployment URL |
| 27 | +- `token`: Coder authentication token |
| 28 | +- `workspace`: Name of your workspace |
| 29 | + |
| 30 | +Optional parameters: |
| 31 | + |
| 32 | +- `agent_id`: ID of the agent (only required if workspace has multiple agents) |
| 33 | +- `folder`: Specific project folder path to open |
| 34 | +- `ide_product_code`: Specific IDE product code (e.g., "IU" for IntelliJ IDEA Ultimate) |
| 35 | +- `ide_build_number`: Specific build number of the JetBrains IDE |
| 36 | + |
| 37 | +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). |
| 38 | + |
| 39 | +## Configure internal certificates |
| 40 | + |
| 41 | +To connect to a Coder deployment that uses internal certificates, configure the certificates directly in JetBrains Toolbox: |
| 42 | + |
| 43 | +1. Click the settings icon (⚙) in the lower left corner of JetBrains Toolbox. |
| 44 | +1. Select **Settings**. |
| 45 | +1. Go to the **Coder** section. |
| 46 | +1. Add your certificate path in the **CA Path** field. |
0 commit comments