Commands Guide

This directory contains detailed guides for all Torrust Tracker Deployer commands.

Available Commands

Environment Creation

• create - Create environments and generate configuration templates
  • create template - Generate environment configuration template
  • create environment - Create deployment environment from configuration

Environment Information

• show - Display environment information with state-aware details

Infrastructure Management

• provision - Provision VM infrastructure
• register - Register existing infrastructure (alternative to provision)
• configure - Configure provisioned infrastructure
• test - Verify deployment infrastructure

Application Deployment

• release - Deploy application configuration and files
• run - Start Torrust Tracker services

Environment Cleanup

• destroy - Destroy deployment environment

Command Workflow

The typical command sequence for a complete deployment:

1. create template    → Generate configuration template
2. (edit template)    → Customize your settings
3. create environment → Create environment from config
4. show               → View environment details
5. provision          → Provision VM infrastructure
6. configure          → Install Docker, Docker Compose, configure firewall
7. test               → Verify infrastructure readiness
8. release            → Deploy application configuration and files
9. run                → Start Torrust Tracker services
10. destroy           → Clean up when done

Command Categories

Plumbing Commands (Low-Level)

These commands provide fine-grained control over each deployment step:

• create template / create environment
• show
• provision / register
• configure
• test
• release
• run
• destroy

Best for: CI/CD pipelines, automation, advanced users, debugging

Porcelain Commands (High-Level) - Coming Soon

Simplified commands that orchestrate multiple plumbing commands:

• deploy - Intelligent orchestration from current state to running

Best for: Quick deployments, beginners, interactive use

State Transitions

Command	State Transition	Description
create template	N/A → Template	Generate config template
create environment	Template → Created	Create environment
show	(read-only)	Display environment info
provision	Created → Provisioned	Provision infrastructure
register	Created → Provisioned	Register existing infra
configure	Provisioned → Configured	Install software, firewall
test	(validation only)	Verify infrastructure
release	Configured → Released	Deploy application files
run	Released → Running	Start tracker services
destroy	Any → Destroyed	Clean up resources

Getting Started

If you're new to the Torrust Tracker Deployer, we recommend:

1. Start with the Quick Start Guides for Docker or native installation
2. Use the individual command guides for detailed information
3. Check the Console Commands Reference for technical details

See Also

• Quick Start Guides - Docker and native installation guides
• Console Commands Reference - Technical command reference
• Codebase Architecture - Understanding the internals