Comment puis-je utiliser des variables d'environnement dans Nginx.conf ?

Depuis le fichier docker officiel de Nginx :

Utilisation de variables d'environnement dans la configuration de nginx :

Par défaut, Nginx ne prend pas en charge l'utilisation de variables d'environnement à l'intérieur de la plupart des blocs de configuration.

Mais envsubst peut être utilisé comme un contournement si vous avez besoin de générer votre configuration nginx dynamiquement avant le démarrage de nginx.

Voici un exemple utilisant docker-compose.yml :

image: nginx
volumes:
 - ./mysite.template:/etc/nginx/conf.d/mysite.template
ports:
 - "8080:80"
environment:
 - NGINX_HOST=foobar.com
 - NGINX_PORT=80
command: /bin/bash -c "envsubst < /etc/nginx/conf.d/mysite.template > /etc/nginx/conf.d/default.conf && nginx -g 'daemon off;'" 

Le fichier mysite.template peut alors contenir des références de variables comme ceci :

listen ${NGINX_PORT};

Mise à jour :

Mais vous savez que ceci a causé ses variables Nginx à être comme ceci :

proxy_set_header        X-Forwarded-Host $host;

endommagé en :

proxy_set_header        X-Forwarded-Host ;

Alors, pour prévenir cela, j'utilise ce petit truc :

J'ai un script pour exécuter Nginx, qui est utilisé dans le fichier docker-compose comme option de commande pour le serveur Nginx, je l'ai nommé run_nginx.sh :

#!/usr/bin/env bash
export DOLLAR='$'
envsubst < nginx.conf.template > /etc/nginx/nginx.conf
nginx -g "daemon off;"

Et en raison de la définition de la nouvelle variable DOLLAR dans le script run_nginx.sh, maintenant le contenu de mon fichier nginx.conf.template pour la variable Nginx elle-même est comme ceci :

proxy_set_header        X-Forwarded-Host ${DOLLAR}host;

Et pour ma variable définie c'est comme ceci :

server_name  ${WEB_DOMAIN} www.${WEB_DOMAIN};

Aussi, ici, il y a mon vrai cas d'utilisation pour cela.

L'image nginx officielle recommande d'utiliser envsubst, mais comme d'autres l'ont souligné, cela remplacera également $host et d'autres variables, ce qui n'est pas souhaitable. Heureusement, envsubst peut prendre en paramètre les noms des variables à remplacer.

Pour éviter un paramètre de commande très complexe pour le conteneur (comme dans l'exemple lié), vous pouvez écrire un script d'entrée Docker qui remplira les variables d'environnement avant d'exécuter la commande. Le script d'entrée est également un bon endroit pour valider les paramètres et définir des valeurs par défaut.

Voici un exemple d'un conteneur nginx qui prend en compte les paramètres API_HOST et API_PORT en tant que variables d'environnement.

nginx-default.conf.template

resolver  127.0.0.11 valid=10s;  # récupérer le changement IP du backend

server {
  listen  80;

  location / {
    root  /usr/share/nginx/html;
  }

  location /api {
    proxy_pass  http://${API_HOST}:${API_PORT};
    proxy_set_header  Host $http_host;
  }
}

docker-entrypoint.sh

#!/usr/bin/env sh
set -eu

envsubst '${API_HOST} ${API_PORT}' < /etc/nginx/conf.d/default.conf.template > /etc/nginx/conf.d/default.conf

exec "$@"

Dockerfile

FROM nginx:1.15-alpine

COPY nginx-default.conf.template /etc/nginx/conf.d/default.conf.template

COPY docker-entrypoint.sh /
ENTRYPOINT ["/docker-entrypoint.sh"]
CMD ["nginx", "-g", "daemon off;"]

envsubst est désormais géré automatiquement par l'image nginx.

Depuis la documentation:

Par défaut, nginx ne prend pas en charge les variables d'environnement à l'intérieur de la plupart des blocs de configuration. Mais cette image dispose d'une fonction, qui extraira les variables d'environnement avant le démarrage de nginx.

Par défaut, cette fonction lit les fichiers de modèle dans /etc/nginx/templates/*.template et affiche le résultat de l'exécution de envsubst dans /etc/nginx/conf.d.

Faire cela avec Lua est considérablement plus facile que cela n'en a l'air :

server {
    set_by_lua $server_name 'return os.getenv("NGINX_SERVERNAME")';
}

J'ai trouvé ça ici :

https://docs.apitools.com/blog/2014/07/02/using-environment-variables-in-nginx-conf.html

Modifier :

Apparemment, cela nécessite l'installation du module Lua : https://github.com/openresty/lua-nginx-module

Modifier 2 :

Notez qu'avec cette approche, vous devez définir la variable env dans Nginx :

env ENVIRONMENT_VARIABLE_NAME

Vous devez le faire dans le contexte de niveau supérieur de nginx.conf ou cela ne fonctionnera pas ! Pas dans le bloc server ou dans la configuration de certains sites dans /etc/nginx/sites-available, car elle est incluse par nginx.conf dans le contexte http (qui n'est pas un contexte de niveau supérieur).

Remarquez également qu'avec cette approche, si vous essayez de faire une redirection par exemple :

server {
    listen 80;
    server_name $server_name;
    return 301 https://$server_name$request_uri;
}

cela ne fonctionnera pas non plus :

2016/08/30 14:49:35 [emerg] 1#0: the duplicate "server_name" variable in /etc/nginx/sites-enabled/default:8

Et si vous lui donnez un nom de variable distinct :

set_by_lua $server_name_from_env 'return os.getenv("NGINX_SERVERNAME")';

server {
    listen 80;
    server_name $server_name_from_env;
    return 301 https://$server_name$request_uri;
}

Nginx ne l'interprétera pas et vous redirigera vers https://%24server_name_from_env/.

J'ai écrit quelque chose qui peut être utile ou non : https://github.com/yawn/envplate

Il édite en ligne des fichiers de configuration avec des références ${key} aux variables d'environnement, en créant éventuellement des sauvegardes / enregistrant ce qu'il fait. Il est écrit en Go et le binaire statique résultant peut être simplement téléchargé depuis l'onglet de sortie pour Linux et MacOS.

Il peut également exécuter() des processus, substituer des valeurs par défaut, enregistrer des journaux et possède des sémantiques d'échec sensées.