Configuration

The CLI manages two types of configuration:

CLI Configuration (~/.apito/config.yml)

• mode - CLI run mode (docker or manual)
• default_account - Default account for plugin operations
• timeout - Request timeout in seconds (default: 30)
• default_plugin - Default plugin for operations
• engine_version - Current engine Docker image version (auto-managed)
• console_version - Current console Docker image version (auto-managed)
• accounts - Account configurations map (supports multiple accounts)
  • account_name - Account configuration
    • server_url - Apito server URL for the account
    • cloud_sync_key - Authentication key for the account

Setting Account Configuration:

You can configure accounts using three methods:

1. Interactive Selection (recommended for beginners):

   apito config set key <value>  # Shows account selection menu
   apito config set url <value>  # Shows account selection menu
   

2. Using -a Flag (recommended for scripts):

   apito config set -a production key <value>
   apito config set -a staging url <value>
   

3. Traditional Syntax (still supported):

   apito config set account production url <value>
   apito config set production key <value>
   

Engine Configuration (~/.apito/bin/.env)

The CLI manages engine configuration in ~/.apito/bin/.env:

System Configuration:

• ENVIRONMENT - local/development/staging/production
• COOKIE_DOMAIN - e.g., localhost
• CORS_ORIGIN - e.g., http://localhost:4000
• BRANKA_KEY - Generated secret key
• APITO_SYSTEM_DB_ENGINE - embed, postgres, mysql, mariadb, mongodb, redis, sqlserver
• SYSTEM_DB_HOST - System database host
• SYSTEM_DB_PORT - System database port
• SYSTEM_DB_NAME - System database name
• SYSTEM_DB_USER - System database username
• SYSTEM_DB_PASSWORD - System database password
• SYSTEM_DATABASE_URL - Complete system database connection string

Project Configuration:

• APITO_PROJECT_DB_ENGINE - postgres, mysql, mariadb, mongodb, redis, sqlserver
• PROJECT_DB_HOST - Project database host
• PROJECT_DB_PORT - Project database port
• PROJECT_DB_NAME - Project database name
• PROJECT_DB_USER - Project database username
• PROJECT_DB_PASSWORD - Project database password
• PROJECT_DATABASE_URL - Complete project database connection string

Service Configuration:

• SERVE_PORT - Engine port (default 5050)
• CACHE_*, KV_ENGINE, AUTH_SERVICE_PROVIDER, TOKEN_TTL
• CADDY_PATH - Absolute path to caddy (managed by CLI)

Database Support

System Database:

• Embedded: boltDB (default)
• External: PostgreSQL, MySQL, MariaDB, MongoDB, Redis, SQL Server

Project Database:

• External: PostgreSQL, MySQL, MariaDB, MongoDB, Redis, SQL Server
• Cloud: Firestore (alpha), DynamoDB (alpha)

Docker Integration

Container Naming Convention:

• System Database: apito-system-{engine} (e.g., apito-system-postgres)
• Project Database: apito-project-{engine} (e.g., apito-project-mysql)

Volume Naming Convention:

• System Database: apito-system-{engine}_data (e.g., apito-system-postgres_data)
• Project Database: apito-project-{engine}_data (e.g., apito-project-mysql_data)

Docker Requirements:

• Docker Engine 20.10+
• Docker Compose v2 (recommended) or v1
• Docker daemon running