Skip to content

Commit 7047349

Browse files
committed
Merge branch 'main' into impl-support-for-tbx-2.7
2 parents 1a9dc8c + dbf40e6 commit 7047349

File tree

2 files changed

+27
-26
lines changed

2 files changed

+27
-26
lines changed

README.md

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -97,10 +97,11 @@ jetbrains://gateway/coder?url=http(s)://<your-coder-deployment>
9797
| ide_build_number | Specific build number of the JetBrains IDE to install on the workspace | No |
9898
| folder | Absolute path to the project folder to open in the remote IDE (URL-encoded) | No |
9999

100-
If only a single agent is available, specifying an agent ID is optional. However, if multiple agents exist,
101-
you must provide either the ID to target a specific one. Note that this version of the Coder Toolbox plugin
102-
does not automatically start agents if they are offline, so please ensure the selected agent is running before
103-
proceeding.
100+
> [!NOTE]
101+
> If only a single agent is available, specifying an agent ID is optional. However, if multiple agents exist,
102+
> you must provide either the ID to target a specific one. Note that this version of the Coder Toolbox plugin
103+
> does not automatically start agents if they are offline, so please ensure the selected agent is running before
104+
> proceeding.
104105
105106
If `ide_product_code` and `ide_build_number` is missing, Toolbox will only open and highlight the workspace environment
106107
page. Coder Toolbox will attempt to start the workspace if it’s not already running; however, for the most reliable
@@ -120,7 +121,6 @@ interception.
120121
2. Start the proxy:
121122

122123
```bash
123-
124124
mitmweb --ssl-insecure --set stream_large_bodies="10m"
125125
```
126126

@@ -179,7 +179,8 @@ Steps to enable debug logging:
179179

180180
There is no need to restart Toolbox, as it will begin logging at the __DEBUG__ level right away.
181181

182-
> ⚠️ **Attention:** Toolbox does not persist log level configuration between restarts.
182+
> [!WARNING]
183+
> Toolbox does not persist log level configuration between restarts.
183184
184185
#### Viewing the Logs
185186

@@ -196,67 +197,67 @@ storage paths. The options can be configured from the plugin's main Workspaces p
196197

197198
### CLI related settings
198199

199-
```Binary source``` specifies the source URL or relative path from which the Coder CLI should be downloaded.
200+
- `Binary source` specifies the source URL or relative path from which the Coder CLI should be downloaded.
200201
If a relative path is provided, it is resolved against the deployment domain.
201202

202-
```Enable downloads``` allows automatic downloading of the CLI if the current version is missing or outdated.
203+
- `Enable downloads` allows automatic downloading of the CLI if the current version is missing or outdated.
203204

204-
```Binary directory``` specifies the directory where CLI binaries are stored. If omitted, it defaults to the data
205+
- `Binary directory` specifies the directory where CLI binaries are stored. If omitted, it defaults to the data
205206
directory.
206207

207-
```Enable binary directory fallback``` if enabled, falls back to the data directory when the specified binary
208+
- `Enable binary directory fallback` if enabled, falls back to the data directory when the specified binary
208209
directory is not writable.
209210

210-
```Data directory``` directory where plugin-specific data such as session tokens and binaries are stored if not
211+
- `Data directory` directory where plugin-specific data such as session tokens and binaries are stored if not
211212
overridden by the binary directory setting.
212213

213-
```Header command``` command that outputs additional HTTP headers. Each line of output must be in the format key=value.
214+
- `Header command` command that outputs additional HTTP headers. Each line of output must be in the format key=value.
214215
The environment variable CODER_URL will be available to the command process.
215216

216217
### TLS settings
217218

218219
The following options control the secure communication behavior of the plugin with Coder deployment and its available
219220
API.
220221

221-
```TLS cert path``` path to a client certificate file for TLS authentication with Coder deployment.
222+
- `TLS cert path` path to a client certificate file for TLS authentication with Coder deployment.
222223
The certificate should be in X.509 PEM format.
223224

224-
```TLS key path``` path to the private key corresponding to the TLS certificate from above.
225+
- `TLS key path` path to the private key corresponding to the TLS certificate from above.
225226
The certificate should be in X.509 PEM format.
226227

227-
```TLS CA path``` the path of a file containing certificates for an alternate certificate authority used to verify TLS
228+
- `TLS CA path` the path of a file containing certificates for an alternate certificate authority used to verify TLS
228229
certs returned by the Coder deployment. The file should be in X.509 PEM format. This option can also be used to verify
229230
proxy certificates.
230231

231-
```TLS alternate hostname``` overrides the hostname used in TLS verification. This is useful when the hostname
232+
- `TLS alternate hostname` overrides the hostname used in TLS verification. This is useful when the hostname
232233
used to connect to the Coder deployment does not match the hostname in the TLS certificate.
233234

234235
### SSH settings
235236

236237
The following options control the SSH behavior of the Coder CLI.
237238

238-
```Disable autostart``` adds the --disable-autostart flag to the SSH proxy command, preventing the CLI from keeping
239+
- `Disable autostart` adds the --disable-autostart flag to the SSH proxy command, preventing the CLI from keeping
239240
workspaces constantly active.
240241

241-
```Enable SSH wildcard config``` enables or disables wildcard entries in the SSH configuration, which allow generic
242+
- `Enable SSH wildcard config` enables or disables wildcard entries in the SSH configuration, which allow generic
242243
rules for matching multiple workspaces.
243244

244-
```SSH proxy log directory``` directory where SSH proxy logs are written. Useful for debugging SSH connection issues.
245+
- `SSH proxy log directory` directory where SSH proxy logs are written. Useful for debugging SSH connection issues.
245246

246-
```SSH network metrics directory``` directory where network information used by the SSH proxy is stored.
247+
- `SSH network metrics directory` directory where network information used by the SSH proxy is stored.
247248

248-
```Extra SSH options``` additional options appended to the SSH configuration. Can be used to customize the behavior of
249+
- `Extra SSH options` additional options appended to the SSH configuration. Can be used to customize the behavior of
249250
SSH connections.
250251

251252
### Saving Changes
252253

253254
Changes made in the settings page are saved by clicking the Save button. Some changes, like toggling SSH wildcard
254-
support,
255-
may trigger regeneration of SSH configurations.
255+
support, may trigger regeneration of SSH configurations.
256256

257257
### Security considerations
258258

259-
> ⚠️ **Attention:** Token authentication is required when TLS certificates are not configured.
259+
> [!IMPORTANT]
260+
> Token authentication is required when TLS certificates are not configured.
260261
261262
## Releasing
262263

@@ -270,4 +271,4 @@ may trigger regeneration of SSH configurations.
270271
- do **not** add any lambdas, handlers, or class handles to Java runtime hooks.
271272
- do **not** create threads manually (including via libraries). If you must, ensure they are properly cleaned up in the plugin's `CoderRemoteProvider#close()` method.
272273
- do **not** bundle libraries that are already provided by Toolbox.
273-
- do **not** perform any ill-intentioned actions.
274+
- do **not** perform any ill-intentioned actions.

gradle/libs.versions.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ksp = "2.1.20-2.0.1"
1313
retrofit = "3.0.0"
1414
changelog = "2.2.1"
1515
gettext = "0.7.0"
16-
plugin-structure = "3.309"
16+
plugin-structure = "3.310"
1717
mockk = "1.14.4"
1818

1919
[libraries]

0 commit comments

Comments
 (0)