88meza COMMAND [directives]
99```
1010
11- ## Quick Multi-Server Setup
11+ ## Quick Start
1212
13- To set up a multi-server environment:
13+ ### Single Machine Development Setup
14+ ``` bash
15+ # Deploy monolith environment (creates 'demo' wiki automatically)
16+ meza deploy monolith
17+
18+ # Create additional wikis
19+ meza create wiki monolith
20+ ```
1421
22+ ### Multi-Server Production Setup
1523``` bash
1624# 1. Setup the environment (follow prompts)
17- meza setup env
25+ meza setup env production
1826
1927# 2. Edit configuration files as required:
20- sudo vi /opt/conf-meza/secret/< env-name > /hosts
21- sudo vi /opt/conf-meza/secret/< env-name > /secret.yml
28+ sudo vi /opt/conf-meza/secret/production /hosts
29+ sudo vi /opt/conf-meza/secret/production /secret.yml
2230
2331# 3. Deploy the environment
24- sudo meza deploy < env-name>
32+ sudo meza deploy production
33+
34+ # 4. Monitor deployment progress
35+ meza deploy-tail production
36+ ```
37+
38+ ### Common Management Tasks
39+ ``` bash
40+ # List existing wikis
41+ meza list-wikis monolith
42+
43+ # Backup before changes
44+ meza backup monolith
45+
46+ # Run maintenance jobs
47+ meza maint run-jobs monolith
48+
49+ # Check deployment status
50+ meza deploy-check production
2551```
2652
2753## Command Reference
2854
55+ ### Environment Management
2956| Command | Directives | Description |
3057| ---------| ------------| -------------|
31- | ** deploy** | ` <environment> ` | Deploy your server (e.g. ` monolith ` ) |
32- | ** setup** | ` env ` | Setup an environment |
33- | | ` dev ` | Setup dev features (Git, FTP) |
34- | ** create** | ` wiki ` | Create a wiki |
35- | | ` wiki-promptless ` | Create a wiki without prompts |
36- | ** backup** | ` <environment> ` | Create a backup of an environment |
37- | ** docker** | ` run ` | 🧪 (experimental) Start container |
58+ | ** setup** | ` env ` | Setup a new environment |
59+ | | ` dev ` | Setup development tools (Git, FTP) |
60+ | | ` dev-networking ` | Configure VirtualBox VM networking |
61+ | | ` docker ` | Install Docker (CentOS only) |
62+ | ** deploy** | ` <environment> ` | Deploy MediaWiki to environment |
63+ | ** update** | ` [version] ` | Update Meza to version or branch |
64+
65+ ### Wiki Operations
66+ | Command | Directives | Description |
67+ | ---------| ------------| -------------|
68+ | ** create** | ` wiki ` | Create a new wiki (interactive) |
69+ | | ` wiki-promptless ` | Create wiki without prompts |
70+ | ** delete** | ` wiki ` | Delete a wiki (interactive) |
71+ | | ` wiki-promptless ` | Delete wiki without prompts |
72+ | | ` elasticsearch ` | Delete Elasticsearch data |
73+ | ** list-wikis** | ` <environment> ` | List all wikis in environment |
74+
75+ ### Maintenance & Backup
76+ | Command | Directives | Description |
77+ | ---------| ------------| -------------|
78+ | ** backup** | ` <environment> ` | Create environment backup |
79+ | ** push-backup** | ` <environment> ` | Push backup to remote location |
80+ | ** maint** | ` run-jobs ` | Run MediaWiki job queue |
81+ | | ` rebuild ` | Rebuild search index and SMW |
82+ | | ` cleanuploadstash ` | Clean upload stash |
83+ | | ` encrypt-string ` | Encrypt sensitive data |
84+ | | ` decrypt-string ` | Decrypt data |
85+
86+ ### Deployment Management
87+ | Command | Directives | Description |
88+ | ---------| ------------| -------------|
89+ | ** deploy-check** | ` <environment> ` | Check if environment is deploying |
90+ | ** deploy-lock** | ` <environment> ` | Lock environment for deployment |
91+ | ** deploy-unlock** | ` <environment> ` | Remove deployment lock |
92+ | ** deploy-kill** | ` <environment> ` | Kill deployment and remove lock |
93+ | ** deploy-log** | ` <environment> ` | Get deployment log file path |
94+ | ** deploy-tail** | ` <environment> ` | Follow deployment logs real-time |
95+
96+ ### Development & Debug
97+ | Command | Directives | Description |
98+ | ---------| ------------| -------------|
99+ | ** debug** | ` <environment> [variable] ` | Debug Ansible variables |
100+ | ** docker** | ` run ` | 🧪 Start development container |
38101| | ` exec ` | Execute command on container |
102+ | ** migrate-wikis** | ` <environment> ` | Migrate wiki IDs to declarative YAML |
39103
40104## Getting Help
41105
42106Every command has directives. If you run any command without directives, it will provide help for that command.
43107
44108``` bash
45- # Get help for specific commands
109+ # Get help for main commands
46110meza deploy --help
47111meza setup --help
48112meza create --help
113+ meza maint --help
114+
115+ # Get help for deployment management
116+ meza deploy-check --help
117+ meza deploy-tail --help
118+
119+ # Run commands without arguments for specific help
120+ meza backup
121+ meza debug
122+ meza delete
49123```
50124
51125## Architecture Overview
52126
53127- ** Environment** : Complete MediaWiki deployment (production, development, etc.)
54- - ** Wiki** : Individual wiki within an environment
128+ - ** Wiki** : Individual wiki within an environment
55129- ** Monolith** : Single-server environment (ideal for development)
56130- ** Multi-server** : Distributed deployment across multiple servers
57131
@@ -65,4 +139,4 @@ meza create --help
65139
66140- [ Complete Command Index] ( index.md ) - Detailed documentation for all commands
67141- [ Installation Guide] ( install.md ) - Get started with Meza
68- - [ Setup Guide] ( setup.md ) - Environment configuration
142+ - [ Setup Guide] ( setup.md ) - Environment configuration
0 commit comments