create

canasta create

Create a Canasta installation

Synopsis

Create a new Canasta MediaWiki installation. This generates configuration files, starts the containers, and runs the MediaWiki installer. You can optionally import an existing database dump instead of running the installer, or enable development mode with Xdebug (Compose only).

canasta create [flags]

Examples

  # Create a basic single-wiki installation
  canasta create -i myinstance -w main -a admin -n example.com

  # Create with an existing database dump
  canasta create -i myinstance -w main -d /path/to/dump.sql -n example.com

  # Create with development mode enabled
  canasta create -i myinstance -w main -a admin -n localhost -D

Options

Flag	Shorthand	Description	Default
--admin	-a	Initial wiki admin username
--build-from	``	Build a local Canasta and/or CanastaBase image from the specified local source directory
--composer	``	Path to custom composer.local.json to copy to config/
--create-cluster	``	Create and manage a local Kubernetes cluster for this installation (Kubernetes only)
--database	-d	Path to existing database dump (.sql or .sql.gz) to import instead of running install.php
--dev	-D	Enable development mode with Xdebug and code extraction (Compose only)
--dev-tag	``	Canasta image tag to use (e.g., latest, dev-branch) (Compose only)	latest
--domain-name	-n	Domain name	localhost
--envfile	-e	Path to .env file with password overrides (merged with default .env)
--global-settings	-g	Path to global settings file to copy to config/settings/global/ (filename preserved)
--help	-h	help for create
--id	-i	Canasta instance ID
--keep-config	-k	Keep the config files on installation failure
--orchestrator	-o	Orchestrator to use (compose or kubernetes)	compose
--override	-r	Name of a file to copy to docker-compose.override.yml (Compose only)
--password	-s	Initial wiki admin password (if not provided, auto-generates and saves to config/admin-password_{wikiid})
--path	-p	Canasta directory	/home/runner/work/Canasta-CLI/Canasta-CLI/tools/docgen
--registry	``	Container registry for pushing locally built images (used with --build-from on Kubernetes)	localhost:5000
--rootdbpass	``	Root database password (if not provided, auto-generates and saves to .env). Tip: Use --rootdbpass "$ROOT_DB_PASS" to avoid exposing password in shell history
--site-name	-t	Display name of the wiki (optional, defaults to wiki ID)
--wiki	-w	ID of the wiki
--wiki-settings	-l	Path to per-wiki settings file to copy to config/settings/wikis// (filename preserved)
--wikidbpass	``	Wiki database password (if not provided, auto-generates and saves to .env). Tip: Use --wikidbpass "$WIKI_DB_PASS" to avoid exposing password in shell history
--wikidbuser	``	The username of the wiki database user (default: "root")	root
--yamlfile	-f	Initial wiki yaml file

Options inherited from parent commands

Flag	Shorthand	Description	Default
--verbose	-v	Verbose output

SEE ALSO

• canasta - A CLI tool for Canasta installations.