できない.dev

proxy_pass

別名: proxy_pass ディレクティブ / nginx のリバースプロキシ

proxy_pass は、nginx が受け取ったリクエストの転送先を指定するディレクティブである。
location の中に書き、URL の末尾にパスを付けるかどうかで、転送先に届くパスが変わる。

公開: 更新:

定義

proxy_pass は、nginx が受け取ったリクエストを転送する先のサーバーを指定するディレクティブである。
location ブロックの中に書き、nginx をリバースプロキシとして動かすときの中心になる。
転送先には http:// か https:// で始まる URL のほか、upstream で定義したサーバー群の名前も書ける。

詳細

転送先に届くパスは、URL にパスを付けたかどうかで変わる。
location /api/ の中で proxy_pass http://127.0.0.1:3000/; と書くと、/api/ に一致した部分が / に置き換わる。
この場合、/api/users は /users として届く。
パスを付けずに proxy_pass http://127.0.0.1:3000; と書けば、/api/users のまま届く。

ホスト名を書いた場合、変数を使っていなければ、nginx は設定を読み込むときに名前を引く。
引けなければ host not found in upstream を出して起動しない。
転送先へ送る Host ヘッダーは、既定で proxy_pass に書いたホスト名に置き換わる。
規則の全体は公式ドキュメント(新しいタブで開く)にある。

よくある誤解

proxy_pass の末尾の / は飾りに見えるが、1 文字の違いで転送先のパスが変わり、アプリ側で 404 になる。
また、nginx が 502 Bad Gateway を返しても、nginx 自身が壊れているとは限らない。
転送先に接続できなかったことを、nginx が代わりに伝えている場合が多い。

関連

転送先に繋がらない例は nginx「502 Bad Gateway」の原因と直し方 にある。
名前を引けずに起動しない例は nginx「host not found in upstream」の原因と直し方 を参照する。
転送先の待ち受けは ポート と localhost で説明している。