CLI:Canasta config

canasta config

View and modify Canasta configuration

Synopsis

View and modify the .env configuration for a Canasta installation.

Use "canasta config get" to view current settings and "canasta config set" to change them. The set command handles side effects automatically (e.g., updating wikis.yaml when changing HTTPS_PORT) and restarts the instance. Editing .env by hand may leave the installation in an inconsistent state.

Key names are case-insensitive and hyphens are treated as underscores, so "https-port", "HTTPS_PORT", and "Https_Port" all work.

Settings safe to change on a running installation:

 Network
   HTTP_PORT                       HTTP port (default: 80)
   HTTPS_PORT                      HTTPS port (default: 443)

 PHP
   PHP_UPLOAD_MAX_FILESIZE         Upload file size limit (default: 10M)
   PHP_POST_MAX_SIZE               POST data size limit (default: 10M)
   PHP_MAX_INPUT_VARS              Max input variables (default: 1000)

 Sitemaps
   MW_SITEMAP_PAUSE_DAYS           Days between sitemap refreshes (default: 1)

 Features
   CANASTA_ENABLE_ELASTICSEARCH    Enable Elasticsearch (default: false)
   CANASTA_ENABLE_OBSERVABILITY    Enable observability stack (default: false)
   CANASTA_ENABLE_WIKI_DIRECTORY   Show wiki directory on 404 pages (default: false)

 MediaWiki site
   MW_SITE_SERVER                  Site URL (e.g., https://example.com)
   MW_SITE_FQDN                    Domain name (e.g., example.com)

 Caddy / TLS
   CADDY_AUTO_HTTPS                Set to "off" behind a reverse proxy

 Docker Image
   CANASTA_IMAGE                   Override the default Canasta image

 Backup (Restic)
   RESTIC_REPOSITORY               Restic repo URL or local path
   RESTIC_PASSWORD                 Restic repo password
   Plus any backend-specific credentials (e.g., AWS_ACCESS_KEY_ID
   and AWS_SECRET_ACCESS_KEY for S3, AZURE_ACCOUNT_NAME and
   AZURE_ACCOUNT_KEY for Azure, B2_ACCOUNT_ID and B2_ACCOUNT_KEY
   for Backblaze B2). The entire .env is passed to the Restic
   container, so any variable Restic recognizes will work.
   See https://restic.readthedocs.io/en/stable/040_backup.html

Other settings (database passwords, secret keys, etc.) are generated by "canasta create" and should not be changed directly. To change the domain, first edit config/wikis.yaml, then use "canasta config set" to update MW_SITE_SERVER and MW_SITE_FQDN.

Subcommands

This command requires a subcommand:

get — Show configuration settings
set — Change a configuration setting
unset — Remove a configuration setting

Flags

Flag	Shorthand	Description	Default
`--help`	`-h`	help for config
`--id`	`-i`	Canasta instance ID	instance associated with current directory
`--verbose`	`-v`	Verbose output