Environment variables

This is the reference of environment variables that configure Zato environments, grouped by subject. Every variable is applied anew each time a container starts - set the variable, restart the container, it applies.

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. A one-table summary of all the defaults is in the default ports reference.

Server configuration

These variables control the runtime behavior of the Zato server.

Automatic REST channels

The server can create REST channels automatically for deployed services - the linked chapter explains the pattern syntax and how the channels behave.

Running behind another proxy

When something of your own - another load balancer, an ingress, a TLS terminator - stands in front of the container, these two say what to expect from it. Both are off by default, because whatever they turn on takes what arrives at face value. The ports reference shows which ports such a proxy stands in front of.

ODB configuration

The ODB of a quickstart container is SQLite by default and can use an external MySQL or PostgreSQL database instead. These variables configure its connection, including SSL/TLS. The certificate paths point to locations inside the container, so mount the certificate files first, e.g. under /opt/hot-deploy/ssl.

Audit log configuration

The audit log stores its events in SQLite by default and can use MySQL, PostgreSQL or Oracle DB instead. These variables configure its database connections, including SSL/TLS.

Audit log retention and writing

These control how long events live, how much of a message is kept, and how events are written.

Both retention variables can be applied to one source only, by appending the source name in upper case with dashes turned into underscores, e.g. Zato_Audit_Log_Retention_Days_AS2 or Zato_Audit_Log_Content_Retention_Days_REST_CHANNEL. The per-source variable wins over the general one. The audit log chapter lists the source names.

Other databases configured through the environment

Three more data stores can each use their own external database, configured entirely through the environment. Each family follows the same shape as the audit log's table above, with the prefix replaced:

Additional pub/sub settings

Scheduler

The multi-server chapter explains where the scheduler runs in environments with more than one server.

Dashboard

Dashboard authentication covers the admin account and Microsoft Entra ID single sign-on that these variables configure.

HL7 MLLP

Tuning for the MLLP listener, all integers unless noted.

Authentication and passwords

These variables set passwords for various Zato components. If not provided, secure random passwords are generated automatically - changing passwords and security defaults cover what to change and when.

Monitoring configuration

These variables configure monitoring with Prometheus and the load balancer's own endpoints listed in the ports reference.

Logging configuration

These variables change log levels and rotation settings. The logging chapter covers them all in detail.

SSL/TLS configuration

These configure the TLS the load balancer serves. The variables marked "auto-generated only" shape the self-signed certificate the container creates when you do not mount a zato.pem of your own, and are ignored when you do. The SSL/TLS chapter covers the whole subject.

Environment configuration

Startup behavior configuration

These variables control what components start and how the container behaves during startup - starting and stopping covers the container lifecycle.

Proxy configuration

These variables configure HTTP/HTTPS proxy settings for the container's own outgoing traffic.

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 \
    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 \
    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 covers the SSH, IDE and Dashboard passwords and the two load balancer ones
• When Zato_Log_Env_Details=True, credentials are saved to /opt/zato/env/details/all-zato-env-details.json and .txt files inside the container - nothing is written there otherwise
• Port variables only affect the internal configuration, you still need to map ports with Docker's -p flag

Learn more