canasta config unset

Remove a configuration setting

Synopsis

Remove one or more configuration keys from the .env file of a Canasta instance.

Each argument is a key name to remove. Multiple keys can be removed in a single invocation and only one restart is performed.

If a key has side effects (e.g., HTTPS_PORT), they are reverted before the key is removed. The instance is then restarted unless --no-restart is specified.

A Kubernetes instance managed through gitops is not restarted: Argo CD deploys it from its gitops repo. Config unset saves the change for that repo, and you deploy it with canasta gitops push, then canasta gitops sync.

With --secret, the keys set with config set --secret are removed, along with any --web exposure: on Compose from .env (and the gitops vars), config/secret-keys, and config/secret-keys-web; on Kubernetes from the gitignored config/secrets.env and config/secrets-web.

canasta config unset [flags] [KEYS...]

Examples

canasta config unset MW_SITE_SERVER
canasta config unset MY_SIDECAR_TOKEN --secret

Arguments

Argument	Description	Default	Required	Orchestrator
`KEYS`	Configuration keys to remove			Both

Flags

Flag	Shorthand	Description	Default	Orchestrator
`--force`	`-f`	Allow unsetting unrecognized keys		Both
`--id`	`-i`	Canasta instance ID	*	Both
`--no-restart`		Remove settings without restarting the instance		Both
`--secret`		Remove key(s) set with 'config set --secret', including their --web exposure, instead of plain .env keys.		Both

* Defaults to the Canasta instance matching the current directory, if any.

Global flags

Flag	Shorthand	Description	Default	Required	Orchestrator
`--help`	`-h`	Show help message and exit			Both
`--verbose`	`-v`	Enable verbose output			Both