Nginx Wiki (古い最新版: http://nginxorg/en/docs/)

概要このモジュールにより、リクエストを別のサーバーに転送できるようになります。例:

<span>location</span> / <span>{</span>
  proxy_pass        <span>http</span>://localhost:<span>8000</span><span>;</span>
  proxy_set_header  X-Real-IP  <span>$remote_addr</span><span>;</span><span>}</span>

HTTP プロキシ モジュールを使用する場合 (または FastCGI を使用する場合でも)、クライアント リクエスト全体がバックエンドのプロキシサーバーに渡される前に、nginx でバッファリングされます。その結果、アップロードの進行状況メーターは機能しても正しく機能しなくなります。 バックエンドサーバーによって受信されたデータを測定することによって。 コンテキスト: http、サーバー、 locationversion: ≥ 0.8.22example:

proxy_bind  192.168.1.1<span>;</span>

このディレクティブは、connect() を呼び出す前に、各アップストリームソケットをローカルアドレスにバインドします。ホストに複数のインターフェイス/エイリアスがあり、特定のインターフェイス/アドレスから発信接続を渡したい場合に便利です。 デフォルト:4k|8kコンテキスト:

http

server

locationReference:proxy_buffer_size
このディレクティブは、プロキシサーバーから取得した応答の最初の部分が読み込まれるバッファサイズを設定します。応答のこの部分には、原則として小さな応答ヘッダーが配置されます。デフォルトでは、バッファ サイズはディレクティブ の 1 つのバッファのサイズと等しくなります。ただし、設定することは可能です proxy_buffersproxy_buffering 構文:proxy_buffering on | off デフォルト: on コンテキスト: httpサーバー場所

参照: proxy_buffering
このディレクティブは、プロキシサーバーの応答バッファリングを有効にします。バッファリングが有効な場合、nginx はプロキシサーバーから可能な限り高速に応答を読み取り、ディレクティブで設定されたとおりにバッファに保存しますproxy_buffer_size and proxy_buffers。 応答がメモリに収まらない場合は、その一部がディスクに書き込まれます。 バッファリングがオフになっている場合、応答は受信するとすぐに同期してクライアントに転送されます。 nginx はプロキシサーバーから応答全体を読み取ろうとはしません。nginx がサーバーから受け入れることができるデータの最大サイズは次のとおりです。 ディレクティブによって設定されますproxy_buffer_size。また、proxy_buffering が off に設定されている場合、アップストリーム プロキシ応答のキャッシュは機能しないことに注意してください。ロングポーリングに基づく Comet アプリケーションの場合、proxy_buffering を off に設定することが重要です。そうしないと、非同期応答がバッファリングされます。そして Comet は機能しません。バッファリングは、プロキシ応答に X-Accel-Buffering ヘッダーを設定することでリクエストごとに設定できます。proxy_buffers 構文: proxy_buffers 数値 サイズ デフォルト: 8 4k|8k コンテキスト: http
サーバー
場所 参照: proxy_buffers
このディレクティブは、プロキシサーバーから取得した回答を読み込むバッファーの数とサイズを設定します。デフォルトでは、1 つのバッファーのサイズはページのサイズと同じです。プラットフォームに応じて、これは 4K または 8K です。proxy_busy_buffers_size 構文: proxy_busy_buffers_size size デフォルト: 8k|16k コンテキスト: http
サーバー
の場所 参照: proxy_busy_buffers_size
proxy_cache 構文: proxy_cache zone | off デフォルト: オフ コンテキスト: http
サーバー
の場所 参照: proxy_cache
このディレクティブキャッシュするゾーンの名前を設定します。同じゾーンを複数の場所で使用できます。 バージョン 0.7.48 以降、キャッシュはバックエンドの「Expires」、「Cache-Control: no-cache」、および「Cache-Control: max-age=XXX」ヘッダーを尊重します。バージョン 7.66 以降、「プライベート」および「ストアなし」も受け入れられます。 nginx はキャッシュ時に「Vary」ヘッダーを処理しません。確実にするために 非公開アイテムはキャッシュによって意図せずにすべてのユーザーに配信されるわけではありません。バックエンドは「no-cache」または「max-age=0」を設定できます。あるいは、proxy_cache_key を設定する必要があります。 $cookie_xxx などのユーザー固有のデータが含まれます。ただし、proxy_cache_key の一部として Cookie 値を使用すると、公開アイテムのキャッシュの利点が損なわれる可能性があるため、異なる proxy_cache_key 値を使用して場所を分離してください。 プライベート アイテムとパブリック アイテムを分離するために必要な場合があります。キャッシュはプロキシ バッファーに依存し、proxy_buffers が off に設定されている場合は機能しません。次の応答ヘッダーは、無視されない限り、応答にキャッシュ不可能としてフラグを立てます:

Set -Cookie

「キャッシュなし」、「ストアなし」、「プライベート」、または数値以外または 0 の値を持つ「最大期間」を含むキャッシュ コントロール

過去の時刻で期限切れになります

X-Accel-Expires: 0

proxy_cache_bypass 構文: proxy_cache_bypass string ... デフォルト: コンテキスト: http
サーバー
の場所 参照: proxy_cache_bypass
The directive specifies the conditions under which the answer will not be taken from the cache. If at least one of a string variable is not empty and not equal to "0", the answer is not taken from the cache:

 proxy_cache_bypass <span>$cookie_nocache</span><span>$arg_nocache</span><span>$arg_comment</span><span>;</span>
 proxy_cache_bypass <span>$http_pragma</span><span>$http_authorization</span><span>;</span>

Note that the response from the back-end is still eligible for caching. Thus one way of refreshing an item in the cache is sending a request with a header you pick yourself, e.g. "My-Secret-Header: 1", then having a proxy_cache_bypass line like:

proxy_cache_bypass <span>$http_my_secret_header</span><span>;</span>

Can be used in conjunction with the directive proxy_no_cache.proxy_cache_key Syntax: proxy_cache_key string Default: $scheme$proxy_host$request_uri Context: http
server
location Reference: proxy_cache_key
The directive specifies what information is included in the key for caching, for example

proxy_cache_key <span>"$host$request_uri$cookie_user"</span><span>;</span>

Note that by default, the hostname of the server is not included in the cache key. If you are using subdomains for different locations on your website, you need to include it, e.g. by changing the cache key to something like

proxy_cache_key <span>"$scheme$host$request_uri"</span><span>;</span>

proxy_cache_lock Syntax: proxy_cache_lock on | off Default: off Context: http
server
location Appeared in: 1.1.12 Reference: proxy_cache_lock When enabled, only one request at a time will be allowed to populate a new cache element identified according to the proxy_cache_key directive by passing a request to a proxied server. Other requests of the same cache element will either wait for a response to appear in the cache or the cache lock for this element to be released, up to the time set by the proxy_cache_lock_timeout directive. Similar effect for updating cache entry (this directive works only for inserting new cache element) can be archieved by using proxy_cache_use_stale updating directive.proxy_cache_lock_timeout Syntax: proxy_cache_lock_timeout time Default: 5s Context: http
server
location Appeared in: 1.1.12 Reference: proxy_cache_lock_timeout
proxy_cache_methodssyntax: proxy_cache_methods [GET HEAD POST];default: proxy_cache_methods GET HEAD;context: http, server, locationGET/HEAD is syntax sugar, i.e. you can not disable GET/HEAD even if you set just

proxy_cache_methods POST<span>;</span>

proxy_cache_min_uses Syntax: proxy_cache_min_uses number Default: 1 Context: http
server
location Reference: proxy_cache_min_uses
クエリの数。その後、応答がキャッシュされます。proxy_cache_path 構文: proxy_cache_path path [ レベル = levels = levels ] keys_zone = name : size [ inactiveレベル ] keys_zone = namemax_size = size ] [ loader_files : size [ 非アクティブ = loader_sleep = time ] [ loader_threshold時間 ] [max_size = size ] [ loader_files = number ] [loader_sleep = time ] [ loader_threshold = time ] デフォルト: コンテキスト: http 参照:🎜🎜🎜proxy_cache_path🎜🎜🎜🎜
This directive sets the cache path and other cache parameters. Cached data is stored in files. An MD5 hash of the proxied URL is used as the key for the cache entry, and is also used as the filename in the cache path for the response contents and metadata. The levels parameter sets the number of subdirectory levels in cache. For example:

proxy_cache_path  /data/nginx/cache/one  levels<span>=</span><span>1</span>:<span>2</span>   keys_zone<span>=</span>one:10m<span>;</span>

In this cache, file names will be like the following:

<span>/</span>data<span>/</span>nginx<span>/</span>cache<span>/</span>c<span>/</span><span>29</span><span>/</span>b7f54b2df7773722d382f4809d65029c

You may use any combination of 1 and 2 in the level formats: X, X:X, or X:X:X e.g.: "2", "2:2", "1:1:2". There can be at most 3 levels.All active keys and metadata is stored in shared memory. Zone name and the size of the zone is defined via the keys_zone parameter.Note that each defined zone must have a unique path. For example:

proxy_cache_path  /data/nginx/cache/one    levels<span>=</span><span>1</span>      keys_zone<span>=</span>one:10m<span>;</span>
proxy_cache_path  /data/nginx/cache/two    levels<span>=</span><span>2</span>:<span>2</span>    keys_zone<span>=</span>two:100m<span>;</span>
proxy_cache_path  /data/nginx/cache/three  levels<span>=</span><span>1</span>:<span>1</span>:<span>2</span>  keys_zone<span>=</span>three:1000m<span>;</span>

If cached data is not requested for time defined by the inactive parameter, than that data is removed from the cache. The inactive parameter defaults to 10 minutes (10m).A special process, called "cache manager", is created to control the on-disk cache. It is responsible for removing inactive items and enforcing the size of the cache, as defined by the parameter max_size. When the total size of the cache exceeds the maximum size set by max_size, the least recently used data in the cache is deleted to make room for a new cache entry (a LRU replacement policy).Zone size should be set proportional to number of pages to cache. The size of the metadata for one page (file) depends on the OS; currently it is 64 bytes for FreeBSD/i386, and 128 bytes for FreeBSD/amd64.The directories specified by proxy_cache_path and proxy_temp_path should be located on the same filesystem.proxy_cache_use_stale 構文: proxy_cache_use_stale error | timeout | invalid_header | updating | http_500 | http_502 | http_503 | http_504 | http_404 | off ... デフォルト: オフ コンテキスト: http
サーバー
の場所 参照: proxy_cache_use_stale
このディレクティブは、プロキシ キャッシュから古いアイテムをいつ提供するかを Nginx に指示します。このディレクティブのパラメータは、proxy_next_upstream と似ています。 'updating' の追加。 キャッシュ スタンピード (複数のスレッドがキャッシュを同時に更新しようとして殺到するとき) を防ぐために、'updating' パラメーターを指定できます。これにより、1 つのスレッドがキャッシュを更新し、更新の進行中は他のすべてのスレッドがキャッシュを更新します。 キャッシュ内にあるものの古いバージョン。proxy_cache_valid 構文: proxy_cache_valid [ code ...] time デフォルト: コンテキスト: http
server
location 参照: proxy_cache_valid
This directive sets the time for caching different replies. Example:

proxy_cache_valid  <span>200</span><span>302</span>  10m<span>;</span>
proxy_cache_valid  <span>404</span>      1m<span>;</span>

sets 10 minutes cache time for replies with code 200 and 302, and 1 minute for 404s.If only time is specified:

proxy_cache_valid 5m<span>;</span>

then only replies with codes 200, 301 and 302 will be cached.Also it is possible to cache any replies with parameter "any":

proxy_cache_valid  <span>200</span><span>302</span> 10m<span>;</span>
proxy_cache_valid  <span>301</span> 1h<span>;</span>
proxy_cache_valid  any 1m<span>;</span>

Upstream cache-related directives have priority over proxy_cache_valid value, in particular the order is (from Igor):

X-Accel-Expires

Expires/Cache-Control

proxy_cache_valid

The order in which your backend return HTTP headers change cache behaviour. Read this post for details.You may ignore the headers using

proxy_ignore_headers X-Accel-Expires Expires Cache-Control<span>;</span>

Concerning If-Modified / Last-Modified since behaviour, please remember that by default nginx sends 304 only if L-M == I-M-S. Controlled by directive if_modified_since [off|exact|before]Note: you must set this option for any persistent caching to occur.proxy_connect_timeout Syntax: proxy_connect_timeout time Default: 60s Context: http
server
location Reference: proxy_connect_timeout
このディレクティブは、上流サーバーへの接続のタイムアウトを割り当てます。このタイムアウトは 75 秒を超えることはできないことに留意する必要があります。これは、サーバーがページを返すまでの時間、つまり proxy_read_timeout ステートメントではありません。もしあなたの 上流のサーバーは稼働しているがハングしている (たとえば、リクエストを処理するのに十分なスレッドがないため、後で処理する必要がある接続のプールに入れられる) 場合、サーバーへの接続は確立されているため、このステートメントは役に立ちません。 proxy_cookie_domain 構文: proxy_cookie_domain オフ off 
proxy_cookie_domain domain replacement Default: off Context: http
server
location Appeared in: 1.1.15 Reference: proxy_cookie_domain
proxy_cookie_path Syntax: proxy_cookie_path off
proxy_cookie_domain ドメインの置換 デフォルト: オフ httpサーバー
場所
登場: 1.1.15 参照: proxy_cookie_domain 🎜🎜🎜🎜🎜 🎜proxy_cookie_path🎜🎜🎜🎜🎜🎜🎜構文:🎜🎜🎜🎜proxy_cookie_path 🎜 オフ 🎜🎜proxy_cookie_path🎜 🎜パス置換🎜🎜🎜🎜🎜🎜デフォルト:🎜🎜🎜🎜オフ🎜 🎜🎜🎜🎜🎜コンテキスト:🎜🎜🎜http🎜server🎜location🎜🎜🎜🎜🎜出現場所:🎜🎜🎜1.1.15🎜🎜🎜🎜🎜参照:🎜🎜🎜proxy_cookie_path🎜🎜🎜 🎜
proxy_headers_hash_bucket_size構文: proxy_headers_hash_bucket_size サイズ;デフォルト: proxy_headers_hash_ bucket_size 64;context: http、サーバー、場所、ifこのディレクティブヘッダー ハッシュ テーブルのバケット サイズを設定します。 これはヘッダー名の制限を決定します。 64 文字を超えるヘッダー名を使用する場合は、この値を増やしてください。
proxy_headers_hash_max_sizesyntax: proxy_headers_hash_max_size size;default: proxy_headers_hash_max_size 512;コンテキスト: http、サーバー、location、if このディレクティブは、ヘッダー ハッシュ テーブルの最大サイズを設定します。 バックエンドが設定しているヘッダーの量より小さくてはなりません。
proxy_hide_header 構文: proxy_hide_header field デフォルト: コンテキスト: httpサーバー
の場所
参照: proxy_hide_header
nginx does not transfer the "Date", "Server", "X-Pad" and "X-Accel-..." header lines from the proxied server response. The proxy_hide_header directive allows to hide some additional header lines. But if on the contrary the header lines must be passed, then the proxy_pass_header should be used. For example if you want to hide the MS-OfficeWebserver and the AspNet-Version:

<span>location</span> / <span>{</span>
  proxy_hide_header X-AspNet-Version<span>;</span>
  proxy_hide_header MicrosoftOfficeWebServer<span>;</span><span>}</span>

This directive can also be very helpful when using X-Accel-Redirect. For example, you may have one set of backend servers which return the headers for a file download, which includes X-Accel-Redirect to the actual file, as well as the correct Content-Type. However, the Redirect URL points to a files erver which hosts the actual file you wish to serve, and that server sends its own Content-Type header, which might be incorrect, and overrides the header sent by the original backend servers. You can avoid this by adding the proxy_hide_header directive to the fileserver. Example:

<span>location</span> / <span>{</span>
  proxy_pass <span>http</span>://backend_servers<span>;</span><span>}</span>
 
<span>location</span> /files/ <span>{</span>
  proxy_pass <span>http</span>://fileserver<span>;</span>
  proxy_hide_header Content-Type<span>;</span><span>}</span>

proxy_http_version Syntax: proxy_http_version 1.0 | 1.1 Default: 1.0 Context: http
server
location Appeared in: 1.1.4 Reference: proxy_http_version
proxy_ignore_client_abort Syntax: proxy_ignore_client_abort on | off Default: off Context: http
server
location Reference: proxy_ignore_client_abort
クライアント自体がリクエストを中止した場合に、プロキシへのリクエストが中止されるのを防ぎます。フィールド ...デフォルト: コンテキスト:httpサーバーの場所 参照: proxy_ignore_headers

プロキシサーバーの応答からのヘッダー行の処理を禁止します。 文字列を「X-Accel-Redirect」、「X-Accel-Expires」、「Expires」、「Cache-Control」、または「Set-Cookie」として指定できます。デフォルトでは、 nginx は Set-Cookie を使用したリクエストをキャッシュしません。 color:rgb(102,102,102)">オン | オフ デフォルト: オフ
コンテキスト:httpserverlocation Reference: proxy_intercept_errors on | off Default: off Context: http
server
location Reference: proxy_intercept_errors
This directive decides if nginx will intercept responses with HTTP status codes of 400 and higher.By default all responses will be sent as-is from the proxied server.If you set this to on then nginx will intercept status codes that are explicitly handled by an error_pageerror_page nginx は、HTTP ステータス コード 400 以上の応答をインターセプトします。 デフォルトでは、すべての応答はプロキシサーバーからそのまま送信されます。これをon の場合、nginx は ディレクティブによって明示的に処理されるステータス コードをインターセプトします。 ディレクティブと一致しないステータス コードを含む応答は、プロキシされたサーバーからそのまま送信されます。 デフォルト: 1024m コンテキスト: httpサーバーの場所 参照:

proxy_max_temp_file_size
The maximum size of a temporary file when the content is larger than the proxy buffer. If file is larger than this size, it will be served synchronously from upstream server rather than buffered to disk.If proxy_max_temp_file_size is equal to zero, temporary files usage will be disabled.proxy_methodsyntax: proxy_method [method];default: Nonecontext: http, server, locationAllows you to override the HTTP method of the request to be passed to the backend server. If you specify POST for example, all requests forwarded to the backend server will be POST requests.Example:

proxy_method POST<span>;</span>

proxy_next_upstream Syntax: proxy_next_upstream error | timeout | invalid_header | http_500 | http_502 | http_503 | http_504 | http_404 | off ... Default: error timeout Context: http
server
location Reference: proxy_next_upstream
Directive determines in what cases the request will be transmitted to the next server:

error — an error has occurred while connecting to the server, sending a request to it, or reading its response;

timeout — occurred timeout during the connection with the server, transfer the request or while reading response from the server;

invalid_header — server returned a empty or incorrect answer;

http_500 — server returned answer with code 500

http_502 — server returned answer with code 502

http_503 — server returned answer with code 503

http_504 — server returned answer with code 504

http_404 — server returned answer with code 404

off — it forbids the request transfer to the next server

Transferring the request to the next server is only possible when nothing has been transferred to the client -- that is, if an error or timeout arises in the middle of the transfer of the request, then it is not possible to retry the current request on a different server.proxy_no_cache Syntax: proxy_no_cache string ... Default:   Context: http
server
location Reference: proxy_no_cache
Specifies in what cases a response will not be cached, e.g.

proxy_no_cache <span>$cookie_nocache</span><span>$arg_nocache</span><span>$arg_comment</span><span>;</span>
proxy_no_cache <span>$http_pragma</span><span>$http_authorization</span><span>;</span>

The response is marked uncacheable if any of the arguments expand to anything other than "0" or the empty string. For instance, in the above example, the response will never be cached if the cookie "nocache" is set in the request.proxy_pass Syntax: proxy_pass URL Default:   Context: location
if in location
limit_except Reference: proxy_pass
This directive sets the address of the proxied server and the URI to which location will be mapped. Address may be given as hostname or address and port, for example,

proxy_pass <span>http</span>://localhost:<span>8000</span>/uri/<span>;</span>

or as unix socket path:

proxy_pass <span>http</span>://unix:/path/to/backend.socket:/uri/<span>;</span>

path is given after the word unix between two colons.By default, the Host header from the request is not forwarded, but is set based on the proxy_pass statement. To forward the requested Host header, it is necessary to use:

proxy_set_header Host <span>$host</span><span>;</span>

While passing request nginx replaces URI part which corresponds to location with one indicated in proxy_pass direct