You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -179,7 +179,8 @@ Steps to enable debug logging:
179
179
180
180
There is no need to restart Toolbox, as it will begin logging at the __DEBUG__ level right away.
181
181
182
-
> ⚠️ **Attention:** Toolbox does not persist log level configuration between restarts.
182
+
> [!WARNING]
183
+
> Toolbox does not persist log level configuration between restarts.
183
184
184
185
#### Viewing the Logs
185
186
@@ -196,67 +197,67 @@ storage paths. The options can be configured from the plugin's main Workspaces p
196
197
197
198
### CLI related settings
198
199
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.
200
201
If a relative path is provided, it is resolved against the deployment domain.
201
202
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.
203
204
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
205
206
directory.
206
207
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
208
209
directory is not writable.
209
210
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
211
212
overridden by the binary directory setting.
212
213
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.
214
215
The environment variable CODER_URL will be available to the command process.
215
216
216
217
### TLS settings
217
218
218
219
The following options control the secure communication behavior of the plugin with Coder deployment and its available
219
220
API.
220
221
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.
222
223
The certificate should be in X.509 PEM format.
223
224
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.
225
226
The certificate should be in X.509 PEM format.
226
227
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
228
229
certs returned by the Coder deployment. The file should be in X.509 PEM format. This option can also be used to verify
229
230
proxy certificates.
230
231
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
232
233
used to connect to the Coder deployment does not match the hostname in the TLS certificate.
233
234
234
235
### SSH settings
235
236
236
237
The following options control the SSH behavior of the Coder CLI.
237
238
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
239
240
workspaces constantly active.
240
241
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
242
243
rules for matching multiple workspaces.
243
244
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.
245
246
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.
247
248
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
249
250
SSH connections.
250
251
251
252
### Saving Changes
252
253
253
254
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.
256
256
257
257
### Security considerations
258
258
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.
260
261
261
262
## Releasing
262
263
@@ -270,4 +271,4 @@ may trigger regeneration of SSH configurations.
270
271
- do **not** add any lambdas, handlers, or class handles to Java runtime hooks.
271
272
- do **not** create threads manually (including via libraries). If you must, ensure they are properly cleaned up in the plugin's `CoderRemoteProvider#close()` method.
272
273
- do **not** bundle libraries that are already provided by Toolbox.
0 commit comments