nginx

どのようなものか

nginxは、HTTP接続を受け付け、リクエストごとに、ディスク上のファイル
で応答するか、別のサーバーへ渡してその応答を中継する、オープンソース
のプログラムです。名前は「engine
x」と発音し、プロジェクト自身のページでもNGINXと表記します。Igor
Sysoevが開発し、最初の公開版0.1.0は2004年10月4日に登場しました。2条
項BSDライセンスで無料で利用でき、F5,
Inc.は企業向けのディストリビューション、サポート、研修を販売していま
す。

プロジェクトは、HTTPサーバー、リバースプロキシ、コンテンツキャッ
シュ、ロードバランサー、TCPおよびUDPプロキシ、メールプロキシという六
つの役割を挙げます。ウェブホストでは通常、二つの仕事の一方、または両
方を担います。ディスクから静的ファイルを配信することと、アプリケー
ションサーバーの前に立ってTLSを終端し、各リクエストを内部へ転送する
ことです。

起動時には、単一のマスタープロセスと、複数のワーカープロセスが動きま
す。マスターは設定を読み取って検査し、ワーカーを管理します。ワーカー
は特権のないユーザーで動き、リクエスト処理をすべて担います。各ワー
カーは、Linuxではepoll、FreeBSDではkqueueに基づくイベントループを使
うため、少数でも数千の接続を同時に開いておけます。worker_processes
ディレクティブで数を指定し、固定数か、CPUコアごとに一つを割り当てる
autoを選びます。プロジェクトの機能一覧では、アイドル状態のキープアラ
イブ接続10,000本に必要なメモリーは約2.5
MBとしています。

設定は、ディレクティブを記したテキストファイルです。単純なディレク
ティブは名前と引数からなり、セミコロンで終わります。ブロックディレク
ティブは、ほかのディレクティブを波括弧で囲み、ディレクティブを含めら
れるブロックをコンテキストと呼びます。eventsとhttpのコンテキストは最
上位にあります。httpの中では、各serverブロックが一つの仮想サーバーを
記述します。まず待ち受けるアドレスとポート、次にクライアントが要求し
たホスト名で選ばれます。serverブロック内の各locationブロックは、ある
一群のリクエストパスをどう処理するかを定めます。

なぜ重要なのか

ウェブサーバーは、すべての訪問者が接するプログラムなので、負荷がか
かったときの動作と既定値が全員に影響します。nginxを選ぶ理由となる性
質は二つあります。

一つ目は、遅い接続を低いコストで維持できることです。プロキシ先サー
バーの応答のバッファリングは、既定で有効です。nginxは、バックエンド
が応答を生成する速さでそれを受け取り、メモリーに収まらなくなれば一時
ファイルへ書き出し、クライアントが受け取れる速さで送ります。電波の弱
い携帯電話が前の応答をまだダウンロードしている間にも、アプリケーショ
ンサーバーは次のリクエストを処理できます。

二つ目は、リクエストを切らずに設定変更を反映できることです。設定の編
集が有効になるのは、再読み込みか再起動のときだけです。再読み込みで
は、マスターが新しい設定を検査し、適用を試みます。成功すると、新しい
ワーカーがその設定で起動し、古いワーカーは接続の受け付けを止め、抱え
ているリクエストを完了して終了します。失敗した場合は、マスターが変更
を戻し、それまでの設定で配信を続けます。プロジェクトは、クライアント
の通信を中断せず、バイナリー自体を更新する機能も挙げています。

その代償は設定言語にあり、優先順位と継承の規則が、意外な動作の大半を
生みます。リクエストパスに対して、nginxはまず、一致するプレフィック
スが最も長いlocationを見つけて覚えます。次に、正規表現のlocationを
ファイルに書かれた順に調べ、最初の一致を採用します。正規表現がどれも
一致しなければ、覚えたプレフィックスを使います。`=`付きのlocation
は、パスが完全一致すると検索を直ちに終え、最長のプレフィックスに`^~`
が付いていれば、正規表現を調べません。add_headerやproxy_set_headerな
どのディレクティブは、現在の階層に、そのディレクティブの独自定義が一
つもないときだけ、外側の階層から継承されます。

証明書は長い間、nginxと並行して動くACMEクライアントから取得していま
した。現在は、コアのビルドとは別に配布するngx_http_acme_moduleも提供
しています。

実際の活用例

創業者の以前の職務で行った二つのホスティング業務に、nginxが使われて
います。どちらもApacheを置き換えず、同じサーバーで併用していました。

一つ目は、高速で、常にアクセスできる必要があった四十の顧客サイトで
す。Apacheとnginxの両方を使うUbuntu
Linuxサーバーで動かしていました。設定を書き、速度を調整し、実際の訪
問者が利用している間も保守する仕事で、四十サイトすべてが高い可用性を
維持しました。同じサーバー群で二つのウェブサーバーを使うと、すべての
規則を二つの方言で表す必要があります。Apacheの仮想ホストはnginxの
serverブロックに当たり、一方で見つけた修正は、もう一方に合わせて訳す
必要があります。

二つ目は2015年から2022年にかけての業務です。ACMEの処理フローで、百の
Dockerアプリケーションの証明書管理を自動化しました。各証明書を発行
し、期限前に更新し、人手を介さずUbuntuホストへ配置しており、そのホス
トでもApacheとnginxを併用していました。nginx側では、ディスク上のファ
イルを更新しても、変更は半分しか終わっていません。単純なパスで指定し
た証明書は、設定の読み込み時に読み取ります。ドキュメントによると、
TLSハンドシェイクのたびに証明書を読み直すのは、変数から組み立てた
ファイル名の場合だけです。新しいファイルを書き込む更新が訪問者に届く
のは、再読み込みの後です。そのため、nginx向けの自動更新は、最後に再
読み込みを行う必要があります。

問題が起きるところ

サイト全体に設定したヘッダーが、一つのパスで消えます。
locationに独自のadd_headerが一つでもあれば、serverやhttp階層の
add_headerを一つも継承しません。一つのlocationにキャッシュヘッダーを
足すだけで、上位にあるセキュリティーヘッダーがすべて、気付かないうち
に消えます。proxy_set_headerも同じ規則です。add_headerは、`always`を
付けなければ、200、301、304などの成功とリダイレクトのコードにしか適
用しないため、エラーページには、その追加ヘッダーが付きません。共有す
るヘッダーを一つのファイルにまとめ、独自の設定を持つ各階層でinclude
するか、1.29.3以降なら`add_header_inherit
merge;`を設定します。エラー応答でも必要な場所には`always`を付け、各
パスを`curl -sI`で確認します。

あるサイトへのリクエストに、別のサイトが応答します。
nginxは、先にアドレスとポートを照合し、次にHostヘッダーをserver_name
と照合します。そのポートのどのserverブロックも名前を認識しなければ、
既定のサーバーへ送ります。別のサーバーにdefault_serverを指定しない限
り、最初に列挙したものが既定です。新しいサイトのserver_nameに入力ミ
スがあると、以前からある隣のサイトのページを、気付かないうちに配信し
ます。未知の名前には、接続を閉じる`return
444`で応答する既定のサーバーを明示します。間違ったサイトを表示するの
でなく、エラーとして分かるようにするためです。

アップロードが413 Request Entity Too Largeで失敗します。
client_max_body_sizeの既定値は1
MBで、それより大きいリクエストボディーは、アプリケーションに届く前に
nginxが拒否します。サーバー全体でなく、アップロードを受け付ける
locationで上限を上げ、アプリケーション側の上限とも揃えます。

バックエンドが、違うホストへのリンクを作るか、違うパスを受け取りま
す。
別の指定がなければ、nginxは、`127.0.0.1:8080`などのproxy_pass内のア
ドレスを基にしたHostヘッダーを、プロキシ先へ送ります。そのため、アプ
リケーションは、そのアドレスへのリダイレクトや絶対リンクを生成しま
す。プロキシするlocationには、`proxy_set_header
Host
$host;`を設定します。パスの扱いはproxy_passの書き方で変わります。URI
付きなら、単に`/`だけでも、locationに一致したパスの部分を置き換え、
URIなしなら、パスを変えずに渡します。どの変更の後も、入れ子になった
パスを試します。

クライアントが、古い設定や証明書を受け取り続けます。
ファイルを編集したり、夜間に証明書が更新されたりしても、再読み込みま
では、稼働中のnginxに影響しません。壊れた設定の再読み込みでは、古い
設定が残ります。毎回、再読み込み前にテストし、その後、エラーログを読
み、クライアントが実際に受け取るものを確認します。

```sh
nginx -t && nginx -s reload
openssl s_client -connect example.com:443 \
  -servername example.com </dev/null |
  openssl x509 -noout -enddate
```

参考資料

  * nginxドキュメント — ガイドと、モジュールごとのディレクティブ参照
資料をまとめた、プロジェクトの索引です。

  * 入門ガイド — マスターとワーカーのプロセス、再読み込み、設定の構
造です。

  * nginxによるリクエスト処理 — アドレス、ポート、Hostヘッダーから
serverブロックを選ぶ方法です。

  * ngx_http_core_moduleモジュール —
locationの照合順序、server_name、client_max_body_sizeです。

  * ngx_http_proxy_moduleモジュール —
proxy_pass、ヘッダーの既定値、タイムアウト、応答のバッファリングで
す。

  * ngx_http_headers_moduleモジュール — add_header、対象の応答コー
ド、継承規則です。

hこのページのウェブ版	URL:https://engineer.company/ja/glossary/nginx/	engineer.company	70
