Zato Docker Environment Variables

This document provides a comprehensive reference for all environment variables that can be used to configure Zato Docker containers.

Port Configuration

These variables control the network ports that Zato components listen on. You can override these to avoid port conflicts or to match your infrastructure requirements.

Database Configuration

Zato uses PostgreSQL for storing operational data and pub/sub messages. These variables configure the database connections.

Message Broker Configuration (RabbitMQ)

These variables configure the connection to RabbitMQ, which Zato uses as a message broker for pub/sub functionality.

Authentication and Passwords

These variables set passwords for various Zato components. If not provided, secure random passwords are generated automatically.

Monitoring and Metrics

These variables configure Prometheus, Grafana, and metrics collection for monitoring Zato environments.

Environment and Cluster Configuration

These variables define the Zato environment structure and cluster settings.

Deployment and Hot-Deploy Configuration

These variables control how services and configuration are deployed to the Zato server.

Startup Behavior Configuration

These variables control what components start and how the container behaves during startup.

Python and Build Configuration

These variables configure the Python environment and build process.

Dashboard Configuration

These variables configure the Zato web dashboard behavior.

Proxy Configuration

These variables configure HTTP/HTTPS proxy settings for the container.

Docker-Specific Variables

These variables are set automatically by the container and indicate the runtime environment.

Usage Examples

Basic Development Setup

docker run -it --rm \
    -p 8183:8183 \
    -p 17010:17010 \
    -e Zato_Password=mypassword \
    -e Zato_Log_Env_Details=True \
    ghcr.io/zatosource/zato-4.1:latest

Custom Port Configuration

docker run -it --rm \
    -p 9000:9000 \
    -p 18000:18000 \
    -e Zato_Port_Dashboard=9000 \
    -e Zato_Port_Server=18000 \
    -e Zato_Password=mypassword \
    ghcr.io/zatosource/zato-4.1:latest

Production Setup with External RabbitMQ

docker run -it --rm \
    -p 8183:8183 \
    -p 17010:17010 \
    -e Zato_Broker_Address=rabbitmq.example.com:5672 \
    -e Zato_Broker_Username=zato_prod \
    -e Zato_Broker_Internal_Password=secure_password \
    -e Zato_Dashboard_Password=admin_password \
    -e Zato_Env_Name=Production \
    ghcr.io/zatosource/zato-4.1:latest

Disable Management Plugin for Performance

docker run -it --rm \
    -p 8183:8183 \
    -p 17010:17010 \
    -e Zato_RabbitMQ_Disable_Management_Plugin=True \
    -e Zato_Password=mypassword \
    ghcr.io/zatosource/zato-4.1:latest

Notes

• All passwords are automatically generated with secure random values if not explicitly provided
• The Zato_Password variable is a convenience setting that overrides all other password variables
• Generated passwords are stored in /opt/zato/env/details/ inside the container
• When Zato_Log_Env_Details=True, all credentials are saved to /opt/zato/env/details/all-zato-env-details.json and .txt files
• Port variables only affect the internal configuration; you still need to map ports with Docker's -p flag
• Build-time arguments (Zato_RabbitMQ_Version, Zato_Python_Version, etc.) must be set during docker build, not docker run

Related Documentation

• Deploying Zato Projects - Learn how to deploy your Zato projects with Docker
• Enmasse Configuration - Understand how to manage configuration as code