Substitute environment variables in NGINX config from docker-compose

by

Since nginx 1.19 you can now use environment variables in your configuration with docker-compose. I used the following setup:

# file: docker/nginx/templates/default.conf.conf
upstream api-upstream {
    server ${API_HOST};
}


# file: docker-compose.yml
services:
    nginx:
        image: nginx:1.19-alpine
        volumes:
            - "./docker/nginx/templates:/etc/nginx/templates/"
        environment:
            NGINX_ENVSUBST_TEMPLATE_SUFFIX: ".conf"
            API_HOST: api.example.com

I’m going off script a little from the example in the documentation. Note the extra .conf extension on the template file – this is not a typo. In the docs for the nginx image it is suggested to name the file, for example, default.conf.template. Upon startup, a script will take that file, substitute the environment variables, and then output the file to /etc/nginx/conf.d/ with the original file name, dropping the .template suffix.

By default that suffix is .template, but this breaks syntax highlighting unless you configure your editor. Instead, I specified .conf as the template suffix. If you only name your file default.conf the result will be a file named /etc/nginx/conf.d/default and your site won’t be served as expected.

More Related Contents:

  1. Re-using environment variables in docker-compose.yml
  2. How to fix docker: Got permission denied issue
  3. Docker Compose – Share named volume between multiple containers
  4. Access docker container from host using containers name
  5. Provide static IP to docker containers via docker-compose
  6. React app exiting in docker container with exit code 0
  7. Docker-Compose persistent data MySQL
  8. How to get docker-compose to always re-create containers from fresh images?
  9. How to correctly link php-fpm and Nginx Docker containers?
  10. How to set a path on host for a named volume in docker-compose.yml
  11. Docker COPY from ubuntu absolute path
  12. Docker Compose – How to execute multiple commands?
  13. How to mount local volumes in docker machine
  14. An error, “failed to solve with frontend dockerfile.v0”
  15. Difference between links and depends_on in docker_compose.yml
  16. Are you trying to mount a directory onto a file (or vice-versa)?
  17. What is the alternative to condition form of depends_on in docker-compose Version 3?
  18. Docker Compose keep container running
  19. How to pass ARG value to ENTRYPOINT?
  20. How can I use environment variables in docker-compose?
  21. How to restart a single container with docker-compose
  22. nginx: use environment variables
  23. How to pass arguments to a Dockerfile?
  24. How to tag docker image with docker-compose
  25. how do you manage secret values with docker-compose v3.1?
  26. Pass argument to docker compose
  27. Docker-compose exit code is 137 when there is no OOM exception
  28. Docker 1.10 access a container by its hostname from a host machine
  29. Build a single image based on docker compose containers
  30. Difference between “docker compose” and “docker-compose”

Leave a Comment