Docker Environment Variables

Find the available docker environment variables below with default values, if applicable. You might also be interested in the environment variables documentation.

TIP

If you want to use a .env file, you can use the provided .env.dist file and copy it to .env. That way it will be picked up by Docker-Compose automatically and not overwritten during updates.

Zammad

VERSION <current stable version of Zammad>

Allows customization of the Zammad image tag. Example: 6.3.1-54. This default version may be increased when you update your Zammad docker stack. Please see the example env template for more details on this variable.

AUTOWIZARD_JSON

This variable allows you to provide initial configuration data for your instance. Autowizard JSON is out of scope of this documentation, however this example file should help.

ZAMMAD_HTTP_TYPE

Set the http type (http/https) for your instance.

ZAMMAD_FQDN

Set the FQDN for your instance.

ZAMMAD_WEB_CONCURRENCY

Allows spawning n workers to allow more simultaneous connections for Zammad's web UI. See also: Configuration via Environment Variables.

In case you applied docker hardware resource limits, the zammad-railsserver's CPU setting should match the value from this variable.

ZAMMAD_PROCESS_SESSION_JOBS_WORKERS

Allows spawning n independent session jobs workers to release pressure from Zammad's background worker. See also: Configuration via Environment Variables.

In case you applied docker hardware resource limits, the zammad-scheduler CPU setting should match the sum of all worker settings variables.

ZAMMAD_PROCESS_SCHEDULED_JOBS_WORKERS

Allows spawning 1 independent scheduled job worker to reduce pressure from Zammad's background worker. See also: Configuration via Environment Variables.

In case you applied docker hardware resource limits, the zammad-scheduler CPU setting should match the sum of all worker settings variables.

ZAMMAD_PROCESS_DELAYED_JOBS_WORKERS

Allows spawning n delayed job workers to reduce pressure from Zammad's background worker. See also: Configuration via Environment Variables.

In case you applied docker hardware resource limits, the zammad-scheduler CPU setting should match the sum of all worker settings variables.

RAILS_TRUSTED_PROXIES 127.0.0.1,::1

This setting is important for the correct detection of client IP addresses and features based on it, like rate limiting.

By default, Zammad trusts localhost proxies only. Any additional proxy servers will have to be added here, by IP address (if static) or by host name. Host names are resolved during the start of Zammad, so that a restart is required whenever the IP address of a proxy server changes.

Note that in docker context, Zammad may see the network gateway IP address instead of the actual proxy server IP address, if it is placed in another network.

MEMCACHE_SERVERS zammad-memcached:11211

Provide your own Memcached instance to Zammad if you already have one.

REDIS_URL redis://zammad-redis:6379

Provide your own Redis instance if you already have one. Please note that this method currently does not allow authentication.

Elasticsearch

ELASTICSEARCH_ENABLED true

Setting this variable to false will allow you to run your Zammad without Elasticsearch. Please note that we strongly advise against doing so.

ELASTICSEARCH_HOST zammad-elasticsearch

Provide a host name or address to your external Elasticsearch cluster.

ELASTICSEARCH_PORT 9200

Provide a different port for Elasticsearch if needed.

ELASTICSEARCH_SCHEMA http

By default, Elasticsearch is reachable via HTTP.

ELASTICSEARCH_NAMESPACE zammad

With this name space all Zammad related indexes will be created. Change this if you're using external clusters.

ELASTICSEARCH_REINDEX

The searchindex automatically gets rebuilt when no index can be detected. If you need to rebuild the searchindex manually, either set this variable to true or run the reindex command via docker manually.

ELASTICSEARCH_SSL_VERIFY true

Allows you to let the compose scripts ignore self signed SSL certificates for your Elasticsearch installation if needed.

ELASTICSEARCH_HEAP_SIZE 1G

Set the available memory for Elasticsearch. If you face issues with ES and its performance, you should increase this value to a reasonable size.

PostgreSQL

POSTGRESQL_HOST zammad-postgresql

Host name of your PostgreSQL server. Use your own if you already have one.

POSTGRESQL_PORT 5432

Adjust the Port of your PostgreSQL server.

POSTGRESQL_USER zammad

The database user for Zammad.

POSTGRESQL_PASS zammad

The password of Zammad's database user.

POSTGRESQL_DB zammad_production

Zammad's database to use.

POSTGRESQL_OPTIONS ?pool=50

Additional postgresql parameters to be appended to the database URI.

POSTGRESQL_DB_CREATE true

By default Zammad creates the required database.

WARNING

On dedicated database servers, this setting might be troublesome.

Nginx

NGINX_EXPOSE_PORT 8080

The port to be exposed for accessing the Zammad stack from outside. Change this to another value if you already have an existing service listening on this port.

NGINX_PORT 8080

The internal port the nginx service will listen on.

NGINX_SERVER_NAME _

By default the Nginx container of Zammad will respond to all request. You can provide your IP / FQDN if you want to.

NGINX_SERVER_SCHEME \$scheme

If the Nginx container for Zammad is not the upstream server (means if you are using another proxy in front of nginx) you might want to change this. You can set the correct scheme http or https if needed.

NGINX_CLIENT_MAX_BODY_SIZE

Define the maximum size of data that a client can send to the server.

ZAMMAD_RAILSSERVER_HOST zammad-railsserver

Host name of the rails server container.

ZAMMAD_RAILSSERVER_PORT 3000

Port of Zammad's rails server.

ZAMMAD_WEBSOCKET_HOST zammad-websocket

Host name of Zammad's websocket server.

ZAMMAD_WEBSOCKET_PORT 6042

Port of Zammad's websocket server.