Canasta CLI¶
Welcome to the official documentation for Canasta CLI, the command-line interface tool for managing Canasta MediaWiki installations.
What is Canasta CLI?¶
Canasta CLI is a powerful tool that allows you to create, manage, and maintain multiple Canasta MediaWiki installations with ease. It supports Docker Compose 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
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
- Development mode - Live code editing and Xdebug debugging
- Backup and restore - Setting up backups with restic
- Best practices - Security considerations and best practices
- Troubleshooting - Common issues and debugging