canasta create

From Canasta Wiki

canasta > create

canasta create

Create a new Canasta instance

Synopsis

Create a new Canasta MediaWiki instance. Generates configuration files, starts the containers, and runs the MediaWiki installer.

canasta create [flags]

Examples

canasta create -i mysite -w main -n example.com
canasta create -i mysite -w main -d /path/to/dump.sql

Flags

Flag Shorthand Description Default Required Orchestrator
--access-mode Access mode for content PVCs (ReadWriteOnce or ReadWriteMany). Use ReadWriteMany with an RWM-capable storage class for multi-node multi-replica web pods. Kubernetes
--admin -a Initial wiki admin username WikiSysop Both
--argocd-namespace Namespace for Argo CD argocd Kubernetes
--build-from Build from local source directory Both
--canasta-image Custom Canasta image reference Both
--composer Path to custom composer.local.json Both
--database -d Path to existing database dump (.sql or .sql.gz) Both
--domain-name -n Domain name localhost Both
--envfile -e Path to .env file with password overrides Both
--global-settings -g Path to global settings file Both
--host -H Target host for the new instance (default: localhost) Both
--id -i Canasta instance ID Both
--ingress-class Kubernetes ingress class name (e.g. nginx, traefik, alb) Kubernetes
--keep-config -k Keep config files on failure Both
--orchestrator -o Container orchestrator (k8s is an alias for kubernetes) compose Both
--override -r File to copy to docker-compose.override.yml Compose
--password -s Initial wiki admin password (auto-generated if not provided) Both
--path -p Canasta installation directory. Default is '.' for local installs; with --host, default is '~/canasta' on the remote and the value must be absolute (or '~'-prefixed) — relative paths are rejected because they'd otherwise be resolved against the laptop's filesystem. . Both
--registry Container registry for pushing locally built images localhost:5000 Kubernetes
--rootdbpass Root database password (auto-generated if not provided) Both
--site-name -t Display name of the wiki (defaults to wiki ID) Both
--skip-argocd-install Skip Argo CD installation (assume already present) Kubernetes
--skip-tls Skip automatic Let's Encrypt TLS setup Both
--staging-certs Use Let's Encrypt staging CA (untrusted by browsers, but avoids rate limits while testing) Both
--storage-class Kubernetes storage class for shared volumes (e.g. nfs, efs) Kubernetes
--tls-email Email for Let's Encrypt certificate notifications Kubernetes
--wiki -w ID of the wiki Both
--wiki-settings -l Path to per-wiki Settings.php Both
--wikidbpass Wiki database password (auto-generated if not provided) Both
--wikidbuser Wiki database username root Both
--yamlfile -f Initial wikis.yaml file Both

Global Flags

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