How kobotoolbox/kobo-install works
kobo-install is an interactive installer and operator CLI for deploying KoboToolbox with the external kobo-docker project. The primary flow collects installation choices, persists configuration, renders environment and Compose override files, then starts the configured containers. The CLI also exposes operational commands, updates, and legacy configuration/database upgrade handling. Source excerpts show the main dispatch and several direct calls; README statements establish broader CLI capabilities. Some helper relationships and the AWS validation caller are not shown, so those links are omitted or marked unverified.
Main entry points: run.py CLI entry · command.py Container commands · config.py Setup configuration · updater.py Update workflow
Components 16
Setup and configuration
- Setup configuration
helpers/config.py - Network detection
helpers/network.py - AWS validation
helpers/aws_validation.py - Install preparation
helpers/setup.py - Template rendering
helpers/template.py - Generated config files
templates
Container operations
- Container commands
helpers/command.py
Updates and upgrades
- Update workflow
helpers/updater.py - Legacy upgrades
helpers/upgrading.py
CLI and helpers
- CLI entry
run.py - Prompt utilities
helpers/cli.py - Compose command helper
helpers/utils.py - Singleton helper
helpers/singleton.py
Other components
- Operator
- kobo-docker project
- Docker Compose
Connections 23
- Operator → CLI entry: runs commands
readme.md - CLI entry → Setup configuration: loads or builds
run.py - CLI entry → Install preparation: clones project
run.py - CLI entry → Template rendering: renders files
run.py - CLI entry → Container commands: starts containers
run.py - CLI entry → Update workflow: dispatches updates
run.py - CLI entry → Prompt utilities: dispatches operations
run.py - Setup configuration → Network detection: detects network
helpers/config.py - Setup configuration → Prompt utilities: asks questions
helpers/config.py - Install preparation → kobo-docker project: clones project
helpers/setup.py - Template rendering → Generated config files: renders templates
readme.md - Container commands → Docker Compose: runs Compose
helpers/command.py - Container commands → kobo-docker project: operates containers
readme.md - Update workflow → Install preparation: updates project
helpers/updater.py - Update workflow → Legacy upgrades: handles upgrades
- Container commands → Compose command helper: builds commands
helpers/command.py - Setup configuration → Singleton helper: uses helper
helpers/config.py - Setup configuration → AWS validation: validates credentials
helpers/config.py - CLI entry → Container commands: exposes logs and stop
readme.md - CLI entry → Container commands: exposes maintenance mode
readme.md - CLI entry → Container commands: exposes Compose passthrough
readme.md - CLI entry → Container commands: exposes dev build
readme.md - Update workflow → kobo-docker project: updates deployment
helpers/updater.py