nginx 設定ファイルで環境変数を使用する方法

序文

Nginx はパフォーマンスを重視して設計された HTTP サーバーです。Apache や lighttpd と比較すると、メモリ使用量が少なく、安定性が高いという利点があります。

nginx docker をデプロイする必要があるため、コンテナを起動する前に、nginx 構成ファイル内の server_name を動的に変更できることを期待します。
ただし、nginx 構成ファイルは環境変数の使用をサポートしていません。オンラインで多くの解決策を見つけ、最終的にenvsubstを使用して nginx 構成ファイルを書き換えることにしました。

仕組み

Nginx はカーネルとモジュールで構成されています。カーネルは非常に小さく簡潔で、その動作も非常にシンプルです。設定ファイルを参照して、クライアントのリクエストをロケーションブロック (ロケーションは URL マッチングのための Nginx 設定のディレクティブ) にマッピングするだけです。このロケーションで構成された各ディレクティブは、対応する作業を完了するために異なるモジュールを起動します。

Nginx モジュールは構造的にコアモジュール、基本モジュール、サードパーティモジュールに分かれています。

コアモジュール: HTTPモジュール、EVENTモジュール、MAILモジュール基本モジュール: HTTPアクセスモジュール、HTTP FastCGIモジュール、HTTPプロキシモジュール、HTTPリライトモジュール、
サードパーティモジュール: HTTP アップストリームリクエストハッシュモジュール、通知モジュール、HTTP アクセスキーモジュール。

envsubstを学ぶ

envsubst は、環境変数をファイル内の指定されたタグの値に置き換えます。
たとえば、次の内容のenv.confファイルがあります。

[テスト]
ip = ${ip}
ポート = ${port}
URL = http://${ip}:${port}/index.html
電話 = ${phone}

export ip=192.168.1.5 、 export port=8081 、 export phone=13522223334を実行すると、環境変数が書き込まれます。
次にenvsubst < env.conf > env.new.confを実行して次のenv.new.confを生成します。

[テスト]
IPアドレス = 192.168.1.5
ポート = 8081
URL = http://192.168.1.5:8081/index.html
電話番号 = 13522223334

一部の環境変数のみを置き換えるように指定することもできます。 source env.env && envsubst '$ip;$phone' < env.conf 、2 つの変数 ip と phone のみが置き換えられます。
上記は環境変数の一部のみを置き換えます。Linux のテストでは、一重引用符のみ使用できます。二重引用符は無効です。区切り文字, . ; |を試しましたが、これら 4 つはすべて OK です。他にも区切り文字があると思います。

nginx設定ファイルを適用する

docker-compose.ymlファイルは次のとおりです

バージョン: "3"
 
サービス:
  nginx:
    イメージ: nginx:1.20.1-alpine
    コンテナ名: nginx
    ポート:
      - 80:80
      -443:443
    環境：
      - NGINX_HOST=www.janbar.com
      - NGINX_PORT=80
    ボリューム:
      - /root/janbar.temp:/etc/nginx/conf.d/janbar.temp
    コマンド: /bin/sh -c "envsubst < /etc/nginx/conf.d/janbar.temp > /etc/nginx/conf.d/default.conf && exec nginx -g 'daemon off;'"
    ネットワークモード: ブリッジ
    再起動: 常に

/root/janbar.tempファイルの内容は次のとおりです。

サーバー{
    ${NGINX_PORT} をリッスンします。
    [::]:${NGINX_PORT} をリッスンします。
    サーバー名 ${NGINX_HOST};

    位置 / {
        ルート /usr/share/nginx/html;
        インデックス index.html index.htm;
    }

    エラーページ 500 502 503 504 /50x.html;
    場所 = /50x.html {
        ルート /usr/share/nginx/html;
    }
}

上記のdocker-compose.yml設定ファイルに従って、dockerコンテナ内の設定ファイルは最終的に次のように生成されますcat /etc/nginx/conf.d/default.conf

サーバー{
    聞く 80;
    聞く [::]:80;
    サーバー名 www.janbar.com;

    位置 / {
        ルート /usr/share/nginx/html;
        インデックス index.html index.htm;
    }

    エラーページ 500 502 503 504 /50x.html;
    場所 = /50x.html {
        ルート /usr/share/nginx/html;
    }
}