@@ -170,9 +170,74 @@ There is no need to restart Toolbox, as it will begin logging at the DEBUG level
170
170
Once enabled, debug logs will be written to the Toolbox log files. You can access logs directly
171
171
via Toolbox App Menu > About > Show log files.
172
172
173
- Alternatively, you can generate a ZIP file using the Workspace Action Menu , available either on the main
173
+ Alternatively, you can generate a ZIP file using the Workspace action menu , available either on the main
174
174
Workspaces page in Coder or within the individual workspace view, under the option labeled _ Collect logs_ .
175
175
176
+ ## Coder Settings
177
+
178
+ The Coder Settings allows users to control CLI download behavior, SSH configuration, TLS parameters, and data
179
+ storage paths. The options can be configured from the plugin's main Workspaces page > deployment action menu > Settings.
180
+
181
+ ### CLI related settings
182
+
183
+ ``` Binary source ``` specifies the source URL or relative path from which the Coder CLI should be downloaded.
184
+ If a relative path is provided, it is resolved against the deployment domain.
185
+
186
+ ``` Enable downloads ``` allows automatic downloading of the CLI if the current version is missing or outdated.
187
+
188
+ ``` Binary directory ``` specifies the directory where CLI binaries are stored. If omitted, it defaults to the data directory.
189
+
190
+ ``` Enable binary directory fallback ``` if enabled, falls back to the data directory when the specified binary
191
+ directory is not writable.
192
+
193
+ ``` Data directory ``` directory where plugin-specific data such as session tokens and binaries are stored if not
194
+ overridden by the binary directory setting.
195
+
196
+ ``` Header command ``` command that outputs additional HTTP headers. Each line of output must be in the format key=value.
197
+ The environment variable CODER_URL will be available to the command process.
198
+
199
+ ### TLS settings
200
+
201
+ The following options control the secure communication behavior of the plugin with Coder deployment and its available API.
202
+
203
+ ``` TLS cert path ``` path to a client certificate file for TLS authentication with Coder deployment.
204
+ The certificate should be in X.509 PEM format.
205
+
206
+ ``` TLS key path ``` path to the private key corresponding to the TLS certificate from above.
207
+ The certificate should be in X.509 PEM format.
208
+
209
+ ``` TLS CA path ``` the path of a file containing certificates for an alternate certificate authority used to verify TLS
210
+ certs returned by the Coder deployment. The file should be in X.509 PEM format. This option can also be used to verify
211
+ proxy certificates.
212
+
213
+ ``` TLS alternate hostname ``` overrides the hostname used in TLS verification. This is useful when the hostname
214
+ used to connect to the Coder deployment does not match the hostname in the TLS certificate.
215
+
216
+ ### SSH settings
217
+
218
+ The following options control the SSH behavior of the Coder CLI.
219
+
220
+ ``` Disable autostart ``` adds the --disable-autostart flag to the SSH proxy command, preventing the CLI from keeping
221
+ workspaces constantly active.
222
+
223
+ ``` Enable SSH wildcard config ``` enables or disables wildcard entries in the SSH configuration, which allow generic
224
+ rules for matching multiple workspaces.
225
+
226
+ ``` SSH proxy log directory ``` directory where SSH proxy logs are written. Useful for debugging SSH connection issues.
227
+
228
+ ``` SSH network metrics directory ``` directory where network information used by the SSH proxy is stored.
229
+
230
+ ``` Extra SSH options ``` additional options appended to the SSH configuration. Can be used to customize the behavior of SSH connections.
231
+
232
+ ### Saving Changes
233
+
234
+ Changes made in the settings page are saved by clicking the Save button. Some changes, like toggling SSH wildcard support,
235
+ may trigger regeneration of SSH configurations.
236
+
237
+ ### Security considerations
238
+
239
+ > ⚠️ ** Attention:** Token authentication is required when TLS certificates are not configured.
240
+
176
241
## Releasing
177
242
178
243
1 . Check that the changelog lists all the important changes.
0 commit comments