CLI:Canasta create

From canasta

canasta > 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. After creating, use 'canasta devmode enable' to enable development mode.

canasta create [flags]

Examples

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

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

Flags

Flag Shorthand Description Default Required
--admin -a Initial wiki admin username WikiSysop
--build-from Build from local source (directory must contain Canasta/, and optionally CanastaBase/)
--canasta-image Canasta image to use (e.g., ghcr.io/canastawiki/canasta:dev-branch)
--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
--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 /Users/cicalese/xdebug/Canasta-CLI
--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 wiki ID
--wiki -w ID of the wiki
--wiki-settings -l Path to per-wiki settings file to copy to config/settings/wikis/<wiki_id>/ (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 root
--yamlfile -f Initial wiki yaml file
--verbose -v Verbose output