Configuration
List of command launcher configurations
List of configurations
| Config Name | Type | Description |
|---|---|---|
| ci_enabled | bool | whether the CI mode is enabled or not |
| command_repository_base_url | string | the base url of the remote repository, it must contain a /index.json endpoint to list the available pacakges |
| command_update_enabled | bool | whether auto update managed commands or not |
| dropin_folder | string | the absolute path of the dropin folder |
| enable_user_consent | bool | whether enable the user consent. Be caution, when set to false, all resources are allowed to pass to the managed commands. |
| experimental_command_enabled | bool | whether enable experimental command or not |
| internal_command_enabled | bool | whether enable internal command or not |
| local_command_repository_dirname | bool | the absolute path of the local repository folder. |
| log_enabled | bool | whether log is enabled or not |
| log_level | string | the log level of command launcher. Note, the managed command could also request access to this config |
| metric_graphite_host | string | graphite url for metrics |
| package_lock_file | string | only available for CI mode (ci_enabled = true). Lock the package version for CI purpose |
| remote_config_check_cycle | int | interval in hours to check the remote config |
| remote_config_check_time | time | next remote config check time. This configuration is set automatically by command launcher, you shouldn’t change it manually. |
| self_update_base_url | string | base url to get command launcher binaries |
| self_update_enabled | bool | whether auto update command launcher itself |
| self_update_latest_version_url | string | url to get the latest command launcher version information |
| self_update_timeout | duration | timeout duration for self update |
| usage_metrics_enabled | bool | whether enable metrics |
| user_consent_life | duration | the life of user consent |
| system_package | string | the system package name |
| system_package_public_key | string | the public key to verify the system package signature |
| system_package_public_key_file | string | the public key file to verify the system package signature |
| verify_package_checksum | bool | whether to verify the package checksum during package installation |
| verify_package_signature | bool | whether to verify the package signature during package installation (will be available in 1.8) |
| extra_remotes | map | extra remote registry configurations, see extra remote configuration (available 1.8+) |
| enable_package_setup_hook | bool | call setup hook after a new version of package is installed (available 1.9+) |
| group_help_by_registry | bool | group help by registry, default true (available 1.13+) |
extra remote configuration
Each extra remote must have a unique name, it is used to identify the command as part of the command full name. The example configuration looks like the following:
{
"extra_remotes": {
"remote1": {
"remote_base_url": "",
"sync_policy": "always",
"repository_dir": ""
}
}
}
| Config Name | Type | Description |
|---|---|---|
| remote_base_url | string | the base url of the remote repository, it must contain a /index.json endpoint to list all available packages |
| sync_policy | string | how often the repository is synched from its remote, always, hourly, daily, weekly, or monthly |
| repository_dir | string | the absolute path of the local repository folder to keep the downloaded local packages |
You don’t need to manage these extra remote configurations by your self. Use the built-in
remotecommand instead
Change configuration
It is recommended to use the built-in config command to change the configurations. For duration type configurations, you can use h, m, and s to present hour, minute, and seconds. For example:
cola config user_consent_life 24h
set the user consent life to 24 hours.