Canasta Documentation¶
Canasta is a fully featured MediaWiki distribution that bundles MediaWiki with over 170 extensions and skins, a database server, a web server, and a caching layer into a single containerized package supporting both Docker Compose and Kubernetes. It is designed to make it easy to set up, manage, and maintain enterprise-grade wikis without needing deep knowledge of MediaWiki's internals.
Canasta CLI¶
The Canasta CLI is the command-line tool for managing Canasta installations. It supports Docker Compose and local Kubernetes orchestration and provides features for:
- Creating new Canasta installations (single wikis or wiki farms)
- Managing extensions and skins
- Backing up and restoring with Restic
- Importing and exporting wiki data
- Upgrading existing installations
Supported platforms¶
| Platform | Architectures |
|---|---|
| Linux | AMD64/x86-64, ARM64/AArch64 |
| macOS | Intel (AMD64), Apple Silicon (ARM64) |
| Windows | Use WSL with Linux version |
Quick start¶
# Install Canasta CLI
curl -fsSL https://raw.githubusercontent.com/CanastaWiki/Canasta-CLI/main/install.sh | sudo bash
# Create a new Canasta installation
canasta create -i myinstance -w wiki1 -a admin -n localhost
Note: Linux users
Before running CLI commands, add your user to the
dockerandwww-datagroups. See the installation guide for details.
Next steps¶
- Installation guide - Detailed installation instructions
- CLI reference - Complete command documentation
Guides¶
- General concepts - Installation IDs, wiki IDs, directory structure, settings, and configuration
- Wiki farms - Running multiple wikis in one installation
- Extensions and skins - Enabling, disabling, and adding extensions and skins
- Observability - Log aggregation with OpenSearch and Dashboards
- Development mode - Live code editing and Xdebug debugging
- Kubernetes - Deploying to Kubernetes with a CLI-managed kind cluster
- Backup and restore - Setting up backups with restic
- Upgrading - Upgrade process, version notes, and legacy migration
- Sitemaps - XML sitemap generation for search engine indexing
- Best practices - Security considerations and best practices
- Troubleshooting - Common issues and debugging