Environment Variables#

Environment variables may be used by docker compose or atk to override existing functionality or to configure the service itself. The available environment variables are described here.

docker compose Environment Variables#

Note

See the official documentation for more detailed information.

Because atk is simply a wrapper of docker compose, all the traditional techniques to use environment variables in docker compose still works. It is recommended to put a atk.env file in the same directly as the atk.yml file as no additional configuration is needed to read the atk.env file automatically.

Note

By default, atk passes --env-file atk.env to docker compose.

atk Environment Variables#

Todo

There are currently no environment variables for atk directly.