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
@@ -170,7 +163,8 @@ Steps to enable debug logging:
170
163
171
164
There is no need to restart Toolbox, as it will begin logging at the __DEBUG__ level right away.
172
165
173
-
> ⚠️ **Attention:** Toolbox does not persist log level configuration between restarts.
166
+
> [!WARNING]
167
+
> Toolbox does not persist log level configuration between restarts.
174
168
175
169
#### Viewing the Logs
176
170
@@ -187,67 +181,67 @@ storage paths. The options can be configured from the plugin's main Workspaces p
187
181
188
182
### CLI related settings
189
183
190
-
```Binary source``` specifies the source URL or relative path from which the Coder CLI should be downloaded.
184
+
-`Binary source` specifies the source URL or relative path from which the Coder CLI should be downloaded.
191
185
If a relative path is provided, it is resolved against the deployment domain.
192
186
193
-
```Enable downloads``` allows automatic downloading of the CLI if the current version is missing or outdated.
187
+
-`Enable downloads` allows automatic downloading of the CLI if the current version is missing or outdated.
194
188
195
-
```Binary directory``` specifies the directory where CLI binaries are stored. If omitted, it defaults to the data
189
+
-`Binary directory` specifies the directory where CLI binaries are stored. If omitted, it defaults to the data
196
190
directory.
197
191
198
-
```Enable binary directory fallback``` if enabled, falls back to the data directory when the specified binary
192
+
-`Enable binary directory fallback` if enabled, falls back to the data directory when the specified binary
199
193
directory is not writable.
200
194
201
-
```Data directory``` directory where plugin-specific data such as session tokens and binaries are stored if not
195
+
-`Data directory` directory where plugin-specific data such as session tokens and binaries are stored if not
202
196
overridden by the binary directory setting.
203
197
204
-
```Header command``` command that outputs additional HTTP headers. Each line of output must be in the format key=value.
198
+
-`Header command` command that outputs additional HTTP headers. Each line of output must be in the format key=value.
205
199
The environment variable CODER_URL will be available to the command process.
206
200
207
201
### TLS settings
208
202
209
203
The following options control the secure communication behavior of the plugin with Coder deployment and its available
210
204
API.
211
205
212
-
```TLS cert path``` path to a client certificate file for TLS authentication with Coder deployment.
206
+
-`TLS cert path` path to a client certificate file for TLS authentication with Coder deployment.
213
207
The certificate should be in X.509 PEM format.
214
208
215
-
```TLS key path``` path to the private key corresponding to the TLS certificate from above.
209
+
-`TLS key path` path to the private key corresponding to the TLS certificate from above.
216
210
The certificate should be in X.509 PEM format.
217
211
218
-
```TLS CA path``` the path of a file containing certificates for an alternate certificate authority used to verify TLS
212
+
-`TLS CA path` the path of a file containing certificates for an alternate certificate authority used to verify TLS
219
213
certs returned by the Coder deployment. The file should be in X.509 PEM format. This option can also be used to verify
220
214
proxy certificates.
221
215
222
-
```TLS alternate hostname``` overrides the hostname used in TLS verification. This is useful when the hostname
216
+
-`TLS alternate hostname` overrides the hostname used in TLS verification. This is useful when the hostname
223
217
used to connect to the Coder deployment does not match the hostname in the TLS certificate.
224
218
225
219
### SSH settings
226
220
227
221
The following options control the SSH behavior of the Coder CLI.
228
222
229
-
```Disable autostart``` adds the --disable-autostart flag to the SSH proxy command, preventing the CLI from keeping
223
+
-`Disable autostart` adds the --disable-autostart flag to the SSH proxy command, preventing the CLI from keeping
230
224
workspaces constantly active.
231
225
232
-
```Enable SSH wildcard config``` enables or disables wildcard entries in the SSH configuration, which allow generic
226
+
-`Enable SSH wildcard config` enables or disables wildcard entries in the SSH configuration, which allow generic
233
227
rules for matching multiple workspaces.
234
228
235
-
```SSH proxy log directory``` directory where SSH proxy logs are written. Useful for debugging SSH connection issues.
229
+
-`SSH proxy log directory` directory where SSH proxy logs are written. Useful for debugging SSH connection issues.
236
230
237
-
```SSH network metrics directory``` directory where network information used by the SSH proxy is stored.
231
+
-`SSH network metrics directory` directory where network information used by the SSH proxy is stored.
238
232
239
-
```Extra SSH options``` additional options appended to the SSH configuration. Can be used to customize the behavior of
233
+
-`Extra SSH options` additional options appended to the SSH configuration. Can be used to customize the behavior of
240
234
SSH connections.
241
235
242
236
### Saving Changes
243
237
244
238
Changes made in the settings page are saved by clicking the Save button. Some changes, like toggling SSH wildcard
245
-
support,
246
-
may trigger regeneration of SSH configurations.
239
+
support, may trigger regeneration of SSH configurations.
247
240
248
241
### Security considerations
249
242
250
-
> ⚠️ **Attention:** Token authentication is required when TLS certificates are not configured.
243
+
> [!IMPORTANT]
244
+
> Token authentication is required when TLS certificates are not configured.
251
245
252
246
## Releasing
253
247
@@ -261,4 +255,4 @@ may trigger regeneration of SSH configurations.
261
255
- do **not** add any lambdas, handlers, or class handles to Java runtime hooks.
262
256
- do **not** create threads manually (including via libraries). If you must, ensure they are properly cleaned up in the plugin's `CoderRemoteProvider#close()` method.
263
257
- do **not** bundle libraries that are already provided by Toolbox.
0 commit comments