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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
@@ -170,7 +163,8 @@ Steps to enable debug logging:
There is no need to restart Toolbox, as it will begin logging at the __DEBUG__ level right away.
> ⚠️ **Attention:** Toolbox does not persist log level configuration between restarts.
> [!WARNING]
> Toolbox does not persist log level configuration between restarts.
#### Viewing the Logs
Expand All
@@ -187,67 +181,67 @@ storage paths. The options can be configured from the plugin's main Workspaces p
### CLI related settings
```Binary source``` specifies the source URL or relative path from which the Coder CLI should be downloaded.
- `Binary source` specifies the source URL or relative path from which the Coder CLI should be downloaded.
If a relative path is provided, it is resolved against the deployment domain.
```Enable downloads``` allows automatic downloading of the CLI if the current version is missing or outdated.
- `Enable downloads` allows automatic downloading of the CLI if the current version is missing or outdated.
```Binary directory``` specifies the directory where CLI binaries are stored. If omitted, it defaults to the data
- `Binary directory` specifies the directory where CLI binaries are stored. If omitted, it defaults to the data
directory.
```Enable binary directory fallback``` if enabled, falls back to the data directory when the specified binary
- `Enable binary directory fallback` if enabled, falls back to the data directory when the specified binary
directory is not writable.
```Data directory``` directory where plugin-specific data such as session tokens and binaries are stored if not
- `Data directory` directory where plugin-specific data such as session tokens and binaries are stored if not
overridden by the binary directory setting.
```Header command``` command that outputs additional HTTP headers. Each line of output must be in the format key=value.
- `Header command` command that outputs additional HTTP headers. Each line of output must be in the format key=value.
The environment variable CODER_URL will be available to the command process.
### TLS settings
The following options control the secure communication behavior of the plugin with Coder deployment and its available
API.
```TLS cert path``` path to a client certificate file for TLS authentication with Coder deployment.
- `TLS cert path` path to a client certificate file for TLS authentication with Coder deployment.
The certificate should be in X.509 PEM format.
```TLS key path``` path to the private key corresponding to the TLS certificate from above.
- `TLS key path` path to the private key corresponding to the TLS certificate from above.
The certificate should be in X.509 PEM format.
```TLS CA path``` the path of a file containing certificates for an alternate certificate authority used to verify TLS
- `TLS CA path` the path of a file containing certificates for an alternate certificate authority used to verify TLS
certs returned by the Coder deployment. The file should be in X.509 PEM format. This option can also be used to verify
proxy certificates.
```TLS alternate hostname``` overrides the hostname used in TLS verification. This is useful when the hostname
- `TLS alternate hostname` overrides the hostname used in TLS verification. This is useful when the hostname
used to connect to the Coder deployment does not match the hostname in the TLS certificate.
### SSH settings
The following options control the SSH behavior of the Coder CLI.
```Disable autostart``` adds the --disable-autostart flag to the SSH proxy command, preventing the CLI from keeping
- `Disable autostart` adds the --disable-autostart flag to the SSH proxy command, preventing the CLI from keeping
workspaces constantly active.
```Enable SSH wildcard config``` enables or disables wildcard entries in the SSH configuration, which allow generic
- `Enable SSH wildcard config` enables or disables wildcard entries in the SSH configuration, which allow generic
rules for matching multiple workspaces.
```SSH proxy log directory``` directory where SSH proxy logs are written. Useful for debugging SSH connection issues.
- `SSH proxy log directory` directory where SSH proxy logs are written. Useful for debugging SSH connection issues.
```SSH network metrics directory``` directory where network information used by the SSH proxy is stored.
- `SSH network metrics directory` directory where network information used by the SSH proxy is stored.
```Extra SSH options``` additional options appended to the SSH configuration. Can be used to customize the behavior of
- `Extra SSH options` additional options appended to the SSH configuration. Can be used to customize the behavior of
SSH connections.
### Saving Changes
Changes made in the settings page are saved by clicking the Save button. Some changes, like toggling SSH wildcard
support,
may trigger regeneration of SSH configurations.
support, may trigger regeneration of SSH configurations.
### Security considerations
> ⚠️ **Attention:** Token authentication is required when TLS certificates are not configured.
> [!IMPORTANT]
> Token authentication is required when TLS certificates are not configured.
## Releasing
Expand All
@@ -261,4 +255,4 @@ may trigger regeneration of SSH configurations.
- do **not** add any lambdas, handlers, or class handles to Java runtime hooks.
- do **not** create threads manually (including via libraries). If you must, ensure they are properly cleaned up in the plugin's `CoderRemoteProvider#close()` method.
- do **not** bundle libraries that are already provided by Toolbox.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.