<!-- review: finished -->

<a id="http-proxy"></a>

# Proxy

Allows passing requests to another (proxied) server.

<a id="configuration-example-34"></a>

## Configuration Example

```nginx
location / {
    proxy_pass       http://localhost:8000;
    proxy_set_header Host      $host;
    proxy_set_header X-Real-IP $remote_addr;

    proxy_cache       cache_zone;
    proxy_cache_valid 200 302 10m;
    proxy_cache_valid 404      1m;
}
```

<a id="directives-35"></a>

## Directives

<a id="index-0"></a>

<a id="proxy-bind"></a>

### proxy_bind

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_bind` address [`transparent`] | `off`;   |
|------------------------------------------------------------------------------------------|-------------------------------------------------|
| Default                                                                                  | —                                               |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                          |

Makes outgoing connections to a proxied server originate from the specified local IP address with an optional port. Parameter value can contain variables. The special value `off` cancels the effect of the proxy_bind directive inherited from the previous configuration level, which allows the system to auto-assign the local IP address and port.

The `transparent` parameter allows outgoing connections to a proxied server originate from a non-local IP address, for example, from a real IP address of a client:

```nginx
proxy_bind $remote_addr transparent;
```

In order for this parameter to work, it is usually necessary to run Angie worker processes with the [superuser](https://en.angie.software//angie/docs/configuration/modules/core.md#user) privileges. On Linux it is not required as if the `transparent` parameter is specified, worker processes inherit the CAP_NET_RAW capability from the master process.

#### NOTE
It is necessary to configure kernel routing table to intercept network traffic from the proxied server.

<a id="index-1"></a>

<a id="proxy-buffer-size"></a>

### proxy_buffer_size

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_buffer_size` size;   |
|------------------------------------------------------------------------------------------|-----------------------------|
| Default                                                                                  | `proxy_buffer_size 4k|8k;`  |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location      |

Sets the size of the buffer used for reading the first part of the response received from the proxied server. This part usually contains a small response header. By default, the buffer size is equal to one memory page. This is either 4K or 8K, depending on a platform. It can be made smaller, however.

<a id="index-2"></a>

<a id="proxy-buffering"></a>

### proxy_buffering

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_buffering` `on` | `off`;   |
|------------------------------------------------------------------------------------------|-----------------------------------|
| Default                                                                                  | `proxy_buffering on;`             |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location            |

Enables or disables buffering of responses from the proxied server.

| `on`   | Angie receives a response from the proxied server as soon as possible, saving it into the buffers set by the [proxy_buffer_size](#proxy-buffer-size) and [proxy_buffers](#proxy-buffers) directives. Sending to the client is performed in parallel: filled buffers are passed for sending, but their total size is limited by [proxy_busy_buffers_size](#proxy-busy-buffers-size). If a buffer is not completely filled, it is not passed for sending unless it contains the last part of the response. Therefore, buffered reading is not suitable when you need immediate delivery of every few bytes. If the whole response does not fit into memory, a part of it can be saved to a [temporary file](#proxy-temp-path) on the disk. Writing to temporary files is controlled by the [proxy_max_temp_file_size](#proxy-max-temp-file-size) and [proxy_temp_file_write_size](#proxy-temp-file-write-size) directives.   |
|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `off`  | The response is passed to a client immediately as it is received. Angie works in a "read — send" loop and does not wait for the buffer to fill completely: for example, 10 bytes read from a 4K buffer are sent right away. At the same time, if the entire response fits into the buffer, Angie can read it in full. The maximum size of the data that Angie can receive from the server at a time is set by the [proxy_buffer_size](#proxy-buffer-size) directive. With `off`, Angie does not cache responses and [proxy_limit_rate](#proxy-limit-rate) does not work.                                                                                                                                                                                                                                                                                                                                                   |

Buffering can also be enabled or disabled by passing "yes" or "no" in the `X-Accel-Buffering` response header field. This capability can be disabled using the [proxy_ignore_headers](#proxy-ignore-headers) directive.

<a id="index-3"></a>

<a id="proxy-buffers"></a>

### proxy_buffers

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_buffers` number size;   |
|------------------------------------------------------------------------------------------|--------------------------------|
| Default                                                                                  | `proxy_buffers 8 4k | 8k;`     |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location         |

Sets the number and size of the buffers used for reading a response from the proxied server, for a single connection.

By default, the buffer size is equal to one memory page. This is either 4K or 8K, depending on a platform.

<a id="index-4"></a>

<a id="proxy-busy-buffers-size"></a>

### proxy_busy_buffers_size

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_busy_buffers_size` size;     |
|------------------------------------------------------------------------------------------|-------------------------------------|
| Default                                                                                  | `proxy_busy_buffers_size 8k | 16k;` |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location              |

When [buffering](#proxy-buffering) of responses from the proxied server is enabled, limits the total size of buffers that can be busy sending a response to the client while the response is not yet fully read. In the meantime, the rest of the buffers can be used for reading the response and, if needed, buffering part of the response to a temporary file.

By default, size is limited by the size of two buffers set by the [proxy_buffer_size](#proxy-buffer-size) and [proxy_buffers](#proxy-buffers) directives.

<a id="index-5"></a>

<a id="proxy-cache"></a>

### proxy_cache

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_cache` zone | `off` [`path=`path];   |
|------------------------------------------------------------------------------------------|---------------------------------------------|
| Default                                                                                  | `proxy_cache off;`                          |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                      |

Defines a shared memory zone used for caching.
The same zone can be used in several places.
Parameter value can contain variables.

| `off`   | disables caching inherited from the previous configuration level.   |
|---------|---------------------------------------------------------------------|

In Angie PRO, you can specify multiple [proxy_cache_path](#proxy-cache-path) directives that
use the same `keys_zone` value to enable cache sharding. When doing so,
you should set the `path` parameter of the [proxy_cache](#proxy-cache) directive
that uses this `keys_zone` value:

| `path=`path   | The value is evaluated at the time of *caching* the response from the backend<br/>and is expected to use variables, including those containing<br/>information from the response.<br/><br/>If the response is taken from the cache, the path is not reevaluated;<br/>thus, a cached response retains its original path<br/>until it is removed from the cache.   |
|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

This allows selecting the needed cache path by applying [map](https://en.angie.software//angie/docs/configuration/modules/http/http_map.md#id1) directives or
scripts to responses from the backend. Example for `Content-Type`:

```nginx
proxy_cache_path /cache/one keys_zone=zone:10m;
proxy_cache_path /cache/two keys_zone=zone;

map $upstream_http_content_type $cache {
   ~^text/  one;
   default  two;
}

server {
   ...
   location / {
       proxy_pass http://backend;
       proxy_cache zone path=/cache/$cache;
       proxy_cache_valid 200 10m;
   }
}
```

Here there are two cache paths and a variable mapping to distinguish between them.
If `Content-Type` starts with `text/`, the first path will be chosen,
otherwise the second.

#### NOTE
When using [proxy_cache](#proxy-cache),
you typically need to also set the [proxy_cache_valid](#proxy-cache-valid) directive
to explicitly specify the caching time for responses.
If it's not set, Angie doesn't use default values
but determines the response caching time
based on HTTP response headers from the server in the following priority order:

1. The `X-Accel-Expires` header (highest priority).
2. The `Cache-Control` header
   with `max-age` or `s-maxage` parameters.
3. The `Expires` header.

If none of these headers contain valid values or are not present at all,
the response will not be cached because its expiration time cannot be determined.

<a id="index-6"></a>

<a id="proxy-cache-background-update"></a>

### proxy_cache_background_update

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_cache_background_update` `on` | `off`;   |
|------------------------------------------------------------------------------------------|-------------------------------------------------|
| Default                                                                                  | `proxy_cache_background_update off;`            |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                          |

Allows starting a background subrequest to update an expired cache item, while a stale cached response is returned to the client.

#### WARNING
The use of a stale cached response while it's being updated must be [allowed](#proxy-cache-use-stale-updating).

<a id="index-7"></a>

<a id="proxy-cache-bypass"></a>

### proxy_cache_bypass

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_cache_bypass` ...;   |
|------------------------------------------------------------------------------------------|-----------------------------|
| Default                                                                                  | —                           |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location      |

Defines conditions under which the response will not be taken from cache. If at least one value of the string parameters is not empty and is not equal to "0", then the response will not be taken from cache:

```nginx
proxy_cache_bypass $cookie_nocache $arg_nocache$arg_comment;
proxy_cache_bypass $http_pragma    $http_authorization;
```

Can be used together with the [proxy_no_cache](#proxy-no-cache) directive.

<a id="index-8"></a>

<a id="proxy-cache-convert-head"></a>

### proxy_cache_convert_head

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_cache_convert_head` `on` | `off`;   |
|------------------------------------------------------------------------------------------|--------------------------------------------|
| Default                                                                                  | `proxy_cache_convert_head on;`             |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                     |

Enables or disables the conversion of the "HEAD" method to "GET" for caching. If conversion is disabled, the [cache key](#proxy-cache-key) must include the [$request_method](https://en.angie.software//angie/docs/configuration/modules/http/index.md#v-request-method).

<a id="index-9"></a>

<a id="proxy-cache-key"></a>

### proxy_cache_key

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_cache_key` string;                         |
|------------------------------------------------------------------------------------------|---------------------------------------------------|
| Default                                                                                  | `proxy_cache_key $scheme$proxy_host$request_uri;` |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                            |

Defines a key for caching, for example,

```nginx
proxy_cache_key "$host$request_uri $cookie_user";
```

By default, the directive's value is close to the string

```nginx
proxy_cache_key $scheme$proxy_host$uri$is_args$args;
```

<a id="index-10"></a>

<a id="proxy-cache-lock"></a>

### proxy_cache_lock

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_cache_lock` `on` | `off`;   |
|------------------------------------------------------------------------------------------|------------------------------------|
| Default                                                                                  | `proxy_cache_lock off;`            |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location             |

When enabled, only one request at a time will be allowed to populate a new cache element identified according to the [proxy_cache_key](#proxy-cache-key) directive by passing a request to the proxied server. Other requests for the same cache element will either wait for a response to appear in cache or for the cache lock for this element to be released, up to the time set by the [proxy_cache_lock_timeout](#proxy-cache-lock-timeout) directive.

<a id="index-11"></a>

<a id="proxy-cache-lock-age"></a>

### proxy_cache_lock_age

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_cache_lock_age` time;   |
|------------------------------------------------------------------------------------------|--------------------------------|
| Default                                                                                  | `proxy_cache_lock_age 5s;`     |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location         |

If the last request passed to the proxied server for populating a new cache element has not completed for the specified time, one more request may be passed to the proxied server.

<a id="index-12"></a>

<a id="proxy-cache-lock-timeout"></a>

### proxy_cache_lock_timeout

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_cache_lock_timeout` time;   |
|------------------------------------------------------------------------------------------|------------------------------------|
| Default                                                                                  | `proxy_cache_lock_timeout 5s;`     |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location             |

Sets a timeout for [proxy_cache_lock](#proxy-cache-lock). When the time expires, the request will be passed to the proxied server, however, the response will not be cached.

<a id="index-13"></a>

<a id="proxy-cache-max-range-offset"></a>

### proxy_cache_max_range_offset

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_cache_max_range_offset` number;   |
|------------------------------------------------------------------------------------------|------------------------------------------|
| Default                                                                                  | —                                        |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                   |

Sets an offset in bytes for byte-range requests. If the range is beyond the specified offset, the range request will be passed to the proxied server and the response will not be cached.

<a id="index-14"></a>

<a id="proxy-cache-methods"></a>

### proxy_cache_methods

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_cache_methods` `GET` | `HEAD` | `POST` ...;   |
|------------------------------------------------------------------------------------------|------------------------------------------------------|
| Default                                                                                  | `proxy_cache_methods GET HEAD;`                      |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                               |

If the client request method is listed in this directive, then the response will be cached. "GET" and "HEAD" methods are always added to the list, but it is recommended to specify them explicitly. See also the [proxy_no_cache](#proxy-no-cache) directive.

<a id="index-15"></a>

<a id="proxy-cache-min-uses"></a>

### proxy_cache_min_uses

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_cache_min_uses` number;   |
|------------------------------------------------------------------------------------------|----------------------------------|
| Default                                                                                  | `proxy_cache_min_uses 1;`        |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location           |

Sets the number of requests after which the response will be cached.

#### WARNING
Cache metadata is stored in shared memory. Manually deleting cache files does
not reset the counters and may lead to unpredictable behavior. For a complete
reset, stop the server, delete the cache directory, and start again.

#### NOTE
Third-party cache purge modules (for example, [Cache Purge](https://en.angie.software//angie/docs/installation/external-modules/cache-purge.md#external-cache-purge)) only delete
files but do not reset the proxy_cache_min_uses counter. The directive
is intended to protect the cache from pollution by infrequent requests, and resetting
the counter on purge may negatively affect performance.

<a id="index-16"></a>

<a id="proxy-cache-path"></a>

### proxy_cache_path

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_cache_path` path [`levels=`levels] [`use_temp_path=``on` | `off`] `keys_zone=`name:size[:`file=`file] [`inactive=`time] [`max_size=`size] [`min_free=`size] [`manager_files=`number] [`manager_sleep=`time] [`manager_threshold=`time] [`loader_files=`number] [`loader_sleep=`time] [`loader_threshold=`time];   |
|------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Default                                                                                  | —                                                                                                                                                                                                                                                                                                                        |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http                                                                                                                                                                                                                                                                                                                     |

Sets the path and other parameters of a cache. Cache data are stored in files. The file name in a cache is a result of applying the MD5 function to the [cache key](#proxy-cache-key).

| `levels`   | defines hierarchy levels of a cache: from 1 to 3, each level accepts values 1 or 2.   |
|------------|---------------------------------------------------------------------------------------|

For example, in the following configuration:

```nginx
proxy_cache_path /data/angie/cache levels=1:2 keys_zone=one:10m;
```

file names in a cache will look like this:

```nginx
/data/angie/cache/c/29/b7f54b2df7773722d382f4809d65029c
```

A cached response is first written to a temporary file, and then the file is renamed. Temporary files and the cache can be put on different file systems. However, be aware that in this case a file is copied across two file systems instead of the cheap renaming operation. It is thus recommended that for any given location both cache and a directory holding temporary files are put on the same file system.

| `use_temp_path=on` | `off`   | determines the directory to be used for temporary files                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `on`                         | If the parameter is not specified or set to `on`, the directory specified by the [proxy_temp_path](#proxy-temp-path) directive for the given location will be used                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `off`                        | temporary files will be placed directly in the cache directory                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `keys_zone`                  | Sets the name and size of the shared memory zone for storing all active keys and information about data. Cache metadata is stored in shared memory.<br/><br/>A zone of 1 megabyte is sufficient to store about 8000 keys.<br/><br/>When an optional file is specified with `keys_zone`,<br/>Angie dumps the contents of this zone to disk<br/>when the main process terminates<br/>and attempts to restore it at the same memory address<br/>on the next [startup](https://en.angie.software//angie/docs/configuration/runtime.md#runtime)<br/>or after [binary upgrade](https://en.angie.software//angie/docs/configuration/runtime.md#service-upgrade),<br/>to ensure more reliable data persistence<br/>and reduce cache loading time.<br/><br/>If the zone cannot be restored due to a change in its size,<br/>binary version incompatibility, or other reasons,<br/>Angie will log a warning (`failed to restore zone at address`)<br/>and will not use the zone restoration mechanism.<br/>Instead, the incompatible file will be renamed to `.old`;<br/>you can either delete it,<br/>or restore its name and revert Angie to the configuration and version<br/>in which this file was originally created.<br/><br/>#### WARNING<br/>Make sure the path to the file is specified correctly<br/>and has the necessary access permissions for Angie to use,<br/>and is protected from unauthorized access;<br/>relative paths are based on the [prefix](https://en.angie.software//angie/docs/installation/sourcebuild.md#paths). |
| `inactive`                   | If cached data is not accessed within the time specified by this parameter, the data is removed, regardless of its freshness.<br/><br/>By default, `inactive` is 10 minutes.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |

#### NOTE
#### Versionadded
Added in version 1.2.0: PRO

In Angie PRO, multiple proxy_cache_path directives can be specified with the same
`keys_zone` value. The shared memory zone size can only be
specified in the first one. Selection between directives will be
made based on the `path` parameter of the corresponding
[proxy_cache](#proxy-cache) directive.

A special **cache manager** process monitors the maximum cache size and the minimum amount of free space on the filesystem with the cache, and removes the least recently used data when the maximum cache size is exceeded or there is insufficient free space. Data removal occurs in iterations.

| `max_size`          | maximum threshold value for cache size                                                   |
|---------------------|------------------------------------------------------------------------------------------|
| `min_free`          | minimum threshold value for free space on the filesystem with the cache                  |
| `manager_files`     | maximum number of cache items to be removed in one iteration<br/><br/>By default: `100`. |
| `manager_threshold` | limits the duration of one iteration<br/><br/>By default: `200` milliseconds.            |
| `manager_sleep`     | configures a pause between iterations<br/><br/>By default: `50` milliseconds.            |

One minute after Angie starts, a special **cache loader** process is activated.
It scans the filesystem for previously cached data
and loads this information into the cache zone.
This process works iteratively;
each iteration processes a limited number of items specified by the `loader_files` parameter,
ensures it doesn't exceed `loader_threshold`,
then takes a short pause defined by `loader_sleep`
before moving to the next batch.
Iterations continue
until the loader has processed all existing cache entries on disk:

| `loader_files`     | maximum number of cache items to load in one iteration<br/><br/>By default: `100`   |
|--------------------|-------------------------------------------------------------------------------------|
| `loader_threshold` | limits the duration of one iteration<br/><br/>By default: `200` milliseconds        |
| `loader_sleep`     | configures a pause between iterations<br/><br/>By default: `50` milliseconds        |

#### NOTE
Specifying the file for the `keys_zone` parameter
does not affect the cache loader operation.

<a id="index-17"></a>

<a id="proxy-cache-revalidate"></a>

### proxy_cache_revalidate

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_cache_revalidate` `on` | `off`;   |
|------------------------------------------------------------------------------------------|------------------------------------------|
| Default                                                                                  | `proxy_cache_revalidate off;`            |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                   |

Enables revalidation of expired cache items using conditional requests with the `If-Modified-Since` and `If-None-Match` header fields.

<a id="index-18"></a>

<a id="proxy-cache-use-stale"></a>

### proxy_cache_use_stale

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_cache_use_stale` `error` | `timeout` | `invalid_header` | `updating` | `http_500` | `http_502` | `http_503` | `http_504` | `http_403` | `http_404` | `http_429` | `off` ...;   |
|------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Default                                                                                  | `proxy_cache_use_stale off;`                                                                                                                                                          |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                                                                                                                                                                |

Determines in which cases a stale cached response can be used. The directive parameters match those of the [proxy_next_upstream](#proxy-next-upstream) directive.

| `error`    | permits using a stale cached response if a proxied server to process a request cannot be selected.                                                                                        |
|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `updating` | additional parameter, permits using a stale cached response if it is currently being updated. This allows minimizing the number of accesses to proxied servers when updating cached data. |

Using a stale cached response can also be enabled directly in the response header for a specified number of seconds after the response became stale:

* The [stale-while-revalidate](https://datatracker.ietf.org/doc/html/rfc5861#section-3) extension of the `Cache-Control` header field permits using a stale cached response if it is currently being updated.
* The [stale-if-error](https://datatracker.ietf.org/doc/html/rfc5861#section-4) extension of the `Cache-Control` header field permits using a stale cached response in case of an error.

#### NOTE
This has lower priority than using the directive parameters.

To minimize the number of accesses to proxied servers when populating a new cache element, the [proxy_cache_lock](#proxy-cache-lock) directive can be used.

<a id="index-19"></a>

<a id="proxy-cache-valid"></a>

### proxy_cache_valid

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_cache_valid` [code ...] time;   |
|------------------------------------------------------------------------------------------|----------------------------------------|
| Default                                                                                  | —                                      |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                 |

Sets caching time for different response codes. For example, the directives

```nginx
proxy_cache_valid 200 302 10m;
proxy_cache_valid 404      1m;
```

set 10 minutes of caching for responses with codes 200 and 302 and 1 minute for responses with code 404.

If only caching time is specified,

```nginx
proxy_cache_valid 5m;
```

then only 200, 301, and 302 responses are cached.

In addition, the `any` parameter can be specified to cache any responses:

```nginx
proxy_cache_valid 200 302 10m;
proxy_cache_valid 301      1h;
proxy_cache_valid any      1m;
```

#### NOTE
Parameters of caching can also be set directly in the response header. This has higher priority than setting of caching time using the directive.

* The `X-Accel-Expires` header field sets caching time of a response in seconds. The zero value disables caching for a response. If the value starts with the `@` prefix, it sets an absolute time in seconds since Epoch, up to which the response may be cached.
* If the header does not include the `X-Accel-Expires` field, parameters of caching may be set in the header fields `Expires` or `Cache-Control`.
* If the header includes the `Set-Cookie` field, such a response will not be cached.
* If the header includes the `Vary` field with the special value "`*`", such a response will not be cached. If the header includes the `Vary` field with another value, such a response will be cached taking into account the corresponding request header fields.

Processing of one or more of these response header fields can be disabled using the [proxy_ignore_headers](#proxy-ignore-headers) directive.

<a id="index-20"></a>

<a id="proxy-connect-timeout"></a>

### proxy_connect_timeout

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_connect_timeout` time;   |
|------------------------------------------------------------------------------------------|---------------------------------|
| Default                                                                                  | `proxy_connect_timeout 60s;`    |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location          |

Defines a timeout for establishing a connection with a proxied server. It should be noted that this timeout cannot usually exceed 75 seconds.

<a id="index-21"></a>

<a id="proxy-connection-drop"></a>

### proxy_connection_drop

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_connection_drop` time | `on` | `off`;   |
|------------------------------------------------------------------------------------------|------------------------------------------------|
| Default                                                                                  | `proxy_connection_drop off;`                   |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                         |

Enables termination of all connections to the proxied server after it has been
removed from the group or marked as permanently unavailable by a [reresolve](https://en.angie.software//angie/docs/configuration/modules/http/http_upstream.md#reresolve)
process or the [API command](https://en.angie.software//angie/docs/configuration/modules/http/http_api.md#api-config-methods) `DELETE`.

A connection is terminated when the next read or write event is processed for
either the client or the proxied server.

Setting time enables a connection termination [timeout](https://en.angie.software//angie/docs/configuration/configfile.md#syntax);
with `on` set, connections are dropped immediately.

<a id="index-22"></a>

<a id="proxy-cookie-domain"></a>

### proxy_cookie_domain

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_cookie_domain` `off`;<br/><br/>`proxy_cookie_domain` domain replacement;   |
|------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------|
| Default                                                                                  | `proxy_cookie_domain off;`                                                        |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                                                            |

Sets a text that should be changed in the domain attribute of the `Set-Cookie` header fields of a proxied server response. Suppose a proxied server returned the `Set-Cookie` header field with the attribute "domain=localhost". The directive

```nginx
proxy_cookie_domain localhost example.org;
```

will rewrite this attribute to "domain=example.org".

The leading dot in the domain and replacement strings, as well as in the domain attribute, is ignored. The value is case-insensitive.

The domain and replacement strings can contain variables:

```nginx
proxy_cookie_domain www.$host $host;
```

The directive can also be specified using regular expressions. In this case, domain should start with the "~" symbol. The regular expression can contain named and positional captures, and replacement can reference them:

```nginx
proxy_cookie_domain ~\.(?P<sl_domain>[-0-9a-z]+\.[a-z]+)$ $sl_domain;
```

Multiple proxy_cookie_domain directives may be specified at the same level:

```nginx
proxy_cookie_domain localhost example.org;
proxy_cookie_domain ~\.([a-z]+\.[a-z]+)$ $1;
```

If several directives can be applied to the cookie, the first one will be chosen.

The `off` parameter cancels the effect of the proxy_cookie_domain directives inherited from the previous configuration level.

<a id="index-23"></a>

<a id="proxy-cookie-flags"></a>

### proxy_cookie_flags

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_cookie_flags` `off` | cookie [flag ...];   |
|------------------------------------------------------------------------------------------|---------------------------------------------------|
| Default                                                                                  | `proxy_cookie_flags off;`                         |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                            |

Sets one or more flags for the cookie. The cookie can contain text, variables, and their combinations. The flag can contain text, variables, and their combinations.

The `secure`, `httponly`, `samesite=strict`,
`samesite=lax`, `samesite=none` parameters add the corresponding
flags.

The `nosecure`, `nohttponly`, `nosamesite` parameters remove
the corresponding flags.

The cookie can also be specified using regular expressions. In this case, cookie should start with a "~" symbol.

Several `proxy_cookie_flags` directives can be specified on the same
configuration level:

```nginx
proxy_cookie_flags one httponly;
proxy_cookie_flags ~ nosecure samesite=strict;
```

If several directives can be applied to the cookie, the first matching directive will be chosen. In the example, the `httponly` flag is added to the cookie `one`, for all other cookies the `samesite=strict` flag is added and the `secure` flag is deleted.

The `off` parameter cancels the effect of the proxy_cookie_flags directives inherited from the previous configuration level.

<a id="index-24"></a>

<a id="proxy-cookie-path"></a>

### proxy_cookie_path

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_cookie_path` `off`;<br/><br/>`proxy_cookie_path` path replacement;   |
|------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------|
| Default                                                                                  | `proxy_cookie_path off;`                                                    |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                                                      |

Sets a text that should be changed in the path attribute of the
`Set-Cookie` header fields of a proxied server response. Suppose a proxied
server returned the `Set-Cookie` header field with the attribute
"path=/two/some/uri/". The directive

```nginx
proxy_cookie_path /two/ /;
```

will rewrite this attribute to "path=/some/uri/".

The path and replacement strings can contain variables:

```nginx
proxy_cookie_path $uri /some$uri;
```

The directive can also be specified using regular expressions. In this case,
path should either start with a "~" symbol for a case-sensitive matching, or
with the "~\*" symbols for case-insensitive matching. The regular expression can
contain named and positional captures, and replacement can reference them:

```nginx
proxy_cookie_path ~*^/user/([^/]+) /u/$1;
```

Several proxy_cookie_path directives can be specified on the same level:

```nginx
proxy_cookie_path /one/ /;
proxy_cookie_path / /two/;
```

If several directives can be applied to the cookie, the first matching directive will be chosen.

The `off` parameter cancels the effect of the proxy_cookie_path directives inherited from the previous configuration level.

<a id="index-25"></a>

<a id="proxy-force-ranges"></a>

### proxy_force_ranges

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_force_ranges` `on` | `off`;   |
|------------------------------------------------------------------------------------------|--------------------------------------|
| Default                                                                                  | `proxy_force_ranges off;`            |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location               |

Enables byte-range support for both cached and uncached responses from the proxied server regardless of the `Accept-Ranges` field in these responses.

<a id="index-26"></a>

<a id="proxy-headers-hash-bucket-size"></a>

### proxy_headers_hash_bucket_size

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_headers_hash_bucket_size` size;   |
|------------------------------------------------------------------------------------------|------------------------------------------|
| Default                                                                                  | `proxy_headers_hash_bucket_size 64;`     |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                   |

Sets the bucket size for hash tables used by the [proxy_hide_header](#proxy-hide-header) and [proxy_set_header](#proxy-set-header) directives. The details of setting up hash tables are provided [separately](https://en.angie.software//angie/docs/configuration/configfile.md#configure-hashes).

<a id="index-27"></a>

<a id="proxy-headers-hash-max-size"></a>

### proxy_headers_hash_max_size

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_headers_hash_max_size` size;   |
|------------------------------------------------------------------------------------------|---------------------------------------|
| Default                                                                                  | `proxy_headers_hash_max_size 512;`    |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                |

Sets the maximum size of hash tables used by the [proxy_hide_header](#proxy-hide-header) and [proxy_set_header](#proxy-set-header) directives. The details of setting up hash tables are provided [separately](https://en.angie.software//angie/docs/configuration/configfile.md#configure-hashes).

<a id="index-28"></a>

<a id="proxy-hide-header"></a>

### proxy_hide_header

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_hide_header` field;   |
|------------------------------------------------------------------------------------------|------------------------------|
| Default                                                                                  | —                            |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location       |

By default, Angie does not pass the header fields `Date`, `Server`, `X-Pad`, and `X-Accel-...` from the response of a proxied server to a client. The proxy_hide_header directive sets additional fields that will not be passed. If, on the contrary, the passing of fields needs to be permitted, the [proxy_pass_header](#proxy-pass-header) directive can be used.

<a id="index-29"></a>

<a id="proxy-http-version"></a>

### proxy_http_version

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_http_version` `1.0` | `1.1` | `3`;            |
|------------------------------------------------------------------------------------------|------------------------------------------------------|
| Default                                                                                  | `proxy_http_version 1.0;`                            |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location, if in location, limit_except |

Sets the HTTP protocol version for proxying.
By default, version 1.0 is used.
Version 1.1 or higher
is recommended for use with
[keepalive connections](https://en.angie.software//angie/docs/configuration/modules/http/http_upstream.md#u-keepalive).

<a id="index-30"></a>

<a id="proxy-http3-hq"></a>

### proxy_http3_hq

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_http3_hq` `on` | `off`;   |
|------------------------------------------------------------------------------------------|----------------------------------|
| Default                                                                                  | `proxy_http3_hq off;`            |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server                     |

Toggles the special `hq-interop` negotiation mode,
which is used for
[QUIC](#proxy-http-version)
[interop tests](https://github.com/marten-seemann/quic-interop-runner)
that Angie relies on.

#### WARNING
Enable this mode only to run specialized tests that explicitly require it.

<a id="index-31"></a>

<a id="proxy-http3-max-concurrent-streams"></a>

### proxy_http3_max_concurrent_streams

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_http3_max_concurrent_streams` number;   |
|------------------------------------------------------------------------------------------|------------------------------------------------|
| Default                                                                                  | `proxy_http3_max_concurrent_streams 128;`      |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server                                   |

Initializes HTTP/3 and QUIC settings
and sets the maximum number of concurrent HTTP/3 request streams in a
[connection](#proxy-http-version).
Requires enabling [keepalive connections](https://en.angie.software//angie/docs/configuration/modules/http/http_upstream.md#u-keepalive).

<a id="index-32"></a>

<a id="proxy-http3-max-table-capacity"></a>

### proxy_http3_max_table_capacity

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_http3_max_table_capacity` number;   |
|------------------------------------------------------------------------------------------|--------------------------------------------|
| Default                                                                                  | `proxy_http3_max_table_capacity 4096;`     |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                     |

Sets the [dynamic table](https://www.ietf.org/archive/id/draft-ietf-quic-qpack-20.html#name-dynamic-table)
capacity for proxy connections.

#### NOTE
A similar directive [http3_max_table_capacity](https://en.angie.software//angie/docs/configuration/modules/http/http_v3.md#http3-max-table-capacity)
sets this value for server connections.
To avoid errors, dynamic table usage
is disabled when caching is enabled in proxy mode.

<a id="index-33"></a>

<a id="proxy-http3-stream-buffer-size"></a>

### proxy_http3_stream_buffer_size

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_http3_stream_buffer_size` size;   |
|------------------------------------------------------------------------------------------|------------------------------------------|
| Default                                                                                  | `proxy_http3_stream_buffer_size 64k;`    |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server                             |

Sets the [size](https://en.angie.software//angie/docs/configuration/configfile.md#syntax) of the buffer used for reading and writing
[QUIC streams](#proxy-http-version).

<a id="index-34"></a>

<a id="proxy-ignore-client-abort"></a>

### proxy_ignore_client_abort

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_ignore_client_abort` `on` | `off`;   |
|------------------------------------------------------------------------------------------|---------------------------------------------|
| Default                                                                                  | `proxy_ignore_client_abort off;`            |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                      |

Determines whether the connection with a proxied server should be closed when a client closes the connection without waiting for a response.

<a id="index-35"></a>

<a id="proxy-ignore-headers"></a>

### proxy_ignore_headers

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_ignore_headers` field ...;   |
|------------------------------------------------------------------------------------------|-------------------------------------|
| Default                                                                                  | —                                   |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location              |

Disables processing of certain response header fields from the proxied server. The following fields can be ignored: `X-Accel-Redirect`, `X-Accel-Expires`, `X-Accel-Limit-Rate`, `X-Accel-Buffering`, `X-Accel-Charset`, `Expires`, `Cache-Control`, `Set-Cookie`, and `Vary`.

If not disabled, processing of these header fields has the following effect:

* `X-Accel-Expires`, `Expires`, `Cache-Control`, `Set-Cookie`, and `Vary` set the parameters of response [caching](#proxy-cache-valid);
* `X-Accel-Redirect` performs an [internal redirect](https://en.angie.software//angie/docs/configuration/modules/http/index.md#internal) to the specified URI;
* `X-Accel-Limit-Rate` sets the [rate limit](https://en.angie.software//angie/docs/configuration/modules/http/index.md#limit-rate) for transmission of a response to a client;
* `X-Accel-Buffering` enables or disables [buffering](#proxy-buffering) of a response;
* `X-Accel-Charset` sets the desired [charset](https://en.angie.software//angie/docs/configuration/modules/http/http_charset.md#id1) of a response.

<a id="index-36"></a>

<a id="proxy-intercept-errors"></a>

### proxy_intercept_errors

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_intercept_errors` `on` | `off`;   |
|------------------------------------------------------------------------------------------|------------------------------------------|
| Default                                                                                  | `proxy_intercept_errors off;`            |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                   |

Determines whether proxied responses with codes greater than or equal to 300 should be passed to a client or be intercepted and redirected to Angie for processing with the [error_page](https://en.angie.software//angie/docs/configuration/modules/http/index.md#error-page) directive.

<a id="index-37"></a>

<a id="proxy-limit-rate"></a>

### proxy_limit_rate

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_limit_rate` rate;   |
|------------------------------------------------------------------------------------------|----------------------------|
| Default                                                                                  | `proxy_limit_rate 0;`      |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location     |

Limits the speed of reading the response from the proxied server.
The rate is specified in bytes per second; variables are allowed.

| `0`   | disables rate limiting   |
|-------|--------------------------|

#### NOTE
The limit is set per a request, so if Angie simultaneously opens two connections to the proxied server, the overall rate will be twice as much as the specified limit. The limitation works only if [buffering](#proxy-buffering) of responses from the proxied server is enabled.

<a id="index-38"></a>

<a id="proxy-max-temp-file-size"></a>

### proxy_max_temp_file_size

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_max_temp_file_size` size;   |
|------------------------------------------------------------------------------------------|------------------------------------|
| Default                                                                                  | `proxy_max_temp_file_size 1024m;`  |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location             |

When [buffering](#proxy-buffering) of responses from the proxied server is enabled, and the whole response does not fit into the buffers set by the [proxy_buffer_size](#proxy-buffer-size) and [proxy_buffers](#proxy-buffers) directives, a part of the response can be saved to a temporary file. This directive sets the maximum size of the temporary file. The size of data written to the temporary file at a time is set by the [proxy_temp_file_write_size](#proxy-temp-file-write-size) directive.

| `0`   | disables buffering of responses to temporary files   |
|-------|------------------------------------------------------|

#### NOTE
This restriction does not apply to responses that will be [cached](#proxy-cache) or [stored](#proxy-store) on disk.

<a id="index-39"></a>

<a id="proxy-method"></a>

### proxy_method

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_method` method;   |
|------------------------------------------------------------------------------------------|--------------------------|
| Default                                                                                  | —                        |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location   |

Specifies the HTTP method to use in requests forwarded to the proxied server instead of the method from the client request. Parameter value can contain variables.

<a id="index-40"></a>

<a id="proxy-next-upstream"></a>

### proxy_next_upstream

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_next_upstream` `error` | `timeout` | `invalid_header` | `http_500` | `http_502` | `http_503` | `http_504` | `http_403` | `http_404` | `http_429` | `non_idempotent` | `off` ...;   |
|------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Default                                                                                  | `proxy_next_upstream error timeout;`                                                                                                                                                      |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                                                                                                                                                                    |

Specifies in which cases a request should be passed to the next server in the [upstream](https://en.angie.software//angie/docs/configuration/modules/http/http_upstream.md#http-upstream) group:

| `error`          | an error occurred while establishing a connection with the server, passing a request to it, or reading the response header;                                                                                                                                                                             |
|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `timeout`        | a timeout has occurred while establishing a connection with the server, passing a request to it, or reading the response header;                                                                                                                                                                        |
| `invalid_header` | a server returned an empty or invalid response;                                                                                                                                                                                                                                                         |
| `http_500`       | a server returned a response with the code 500;                                                                                                                                                                                                                                                         |
| `http_502`       | a server returned a response with the code 502;                                                                                                                                                                                                                                                         |
| `http_503`       | a server returned a response with the code 503;                                                                                                                                                                                                                                                         |
| `http_504`       | a server returned a response with the code 504;                                                                                                                                                                                                                                                         |
| `http_403`       | a server returned a response with the code 403;                                                                                                                                                                                                                                                         |
| `http_404`       | a server returned a response with the code 404;                                                                                                                                                                                                                                                         |
| `http_429`       | a server returned a response with the code 429;                                                                                                                                                                                                                                                         |
| `non_idempotent` | normally, requests with a [non-idempotent](https://datatracker.ietf.org/doc/html/rfc7231#section-4.2.2) method<br/>(`POST`, `LOCK`, `PATCH`) are not passed to the next<br/>server if a request has been sent to an upstream server; enabling this<br/>option explicitly allows retrying such requests; |
| `off`            | disables passing a request to the next server.                                                                                                                                                                                                                                                          |

If all upstream servers are unavailable or return a response with a status
considered an error by `proxy_next_upstream`, Angie returns its own
standard error page instead of the response body from the last upstream server.

#### NOTE
It should be understood that passing a request to the next server is only possible if nothing has been sent to a client yet. That is, if an error or timeout occurs in the middle of the transferring of a response, fixing this is impossible.

The directive also defines what is considered an [unsuccessful attempt](https://en.angie.software//angie/docs/configuration/modules/http/http_upstream.md#max-fails) of communication with a server.

| `error`<br/><br/>`timeout`<br/><br/>`invalid_header`                                       | are always considered unsuccessful attempts, even if they are not specified in the directive   |
|--------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
| `http_500`<br/><br/>`http_502`<br/><br/>`http_503`<br/><br/>`http_504`<br/><br/>`http_429` | are considered unsuccessful attempts only if they are specified in the directive               |
| `http_403`<br/><br/>`http_404`                                                             | are never considered unsuccessful attempts                                                     |

Passing a request to the next server can be limited by the [number of tries](#proxy-next-upstream-tries) and by [time](#proxy-next-upstream-timeout).

<a id="index-41"></a>

<a id="proxy-next-upstream-timeout"></a>

### proxy_next_upstream_timeout

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_next_upstream_timeout` time;   |
|------------------------------------------------------------------------------------------|---------------------------------------|
| Default                                                                                  | `proxy_next_upstream_timeout 0;`      |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                |

Limits the time during which a request can be passed to the [next server](#proxy-next-upstream).

| `0`   | disables this limitation   |
|-------|----------------------------|

<a id="index-42"></a>

<a id="proxy-next-upstream-tries"></a>

### proxy_next_upstream_tries

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_next_upstream_tries` number;   |
|------------------------------------------------------------------------------------------|---------------------------------------|
| Default                                                                                  | `proxy_next_upstream_tries 0;`        |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                |

Limits the number of possible tries for passing a request to the [next server](#proxy-next-upstream).

| `0`   | disables this limitation   |
|-------|----------------------------|

<a id="index-43"></a>

<a id="proxy-no-cache"></a>

### proxy_no_cache

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_no_cache` string ...;   |
|------------------------------------------------------------------------------------------|--------------------------------|
| Default                                                                                  | —                              |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location         |

Defines conditions under which the response will not be saved to a cache. If at least one value of the string parameters is not empty and is not equal to "0" then the response will not be saved:

```nginx
proxy_no_cache $cookie_nocache $arg_nocache$arg_comment;
proxy_no_cache $http_pragma    $http_authorization;
```

Can be used along with the [proxy_cache_bypass](#proxy-cache-bypass) directive.

<a id="index-44"></a>

<a id="proxy-pass"></a>

### proxy_pass

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_pass` uri;                      |
|------------------------------------------------------------------------------------------|----------------------------------------|
| Default                                                                                  | —                                      |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | location, if in location, limit_except |

Sets the protocol and address of a proxied server and an optional URI to which a location should be mapped. As a protocol, `http` or `https` can be specified. The address can be specified as a domain name or IP address, and an optional port:

```nginx
proxy_pass http://localhost:8000/uri/;
```

or as a UNIX-domain socket path specified after the word `unix` and enclosed in colons:

```nginx
proxy_pass http://unix:/tmp/backend.socket:/uri/;
```

If a domain name resolves to several addresses, all of them will be used in a round-robin fashion. In addition, an address can be specified as a [server group](https://en.angie.software//angie/docs/configuration/modules/http/http_upstream.md#http-upstream).

Parameter value can contain variables. In this case, if an address is specified as a domain name, the name is searched among the described server groups, and, if not found, is determined using a [resolver](https://en.angie.software//angie/docs/configuration/modules/http/index.md#resolver).

<a id="proxy-pass-uri"></a>

A request URI is passed to the server as follows:

* If the `proxy_pass` directive is specified **with a URI**, then when a request is passed to the server, the part of a [normalized](https://en.angie.software//angie/docs/configuration/modules/http/index.md#location) request URI matching the location is replaced by a URI specified in the directive:

```nginx
location /name/ {
    proxy_pass http://127.0.0.1/remote/;
}
```

* If `proxy_pass` is specified **without a URI**, the request URI is passed to the server in the same form as sent by a client when the original request is processed, or the full normalized request URI is passed when processing the changed URI:

```nginx
location /some/path/ {
    proxy_pass http://127.0.0.1;
}
```

In some cases, the part of a request URI to be replaced cannot be determined:

* When `location` is specified using a regular expression, and also inside named `location`.

In these cases, `proxy_pass` should be specified without a URI.

* When the URI is changed inside a proxied `location` using the [rewrite](https://en.angie.software//angie/docs/configuration/modules/http/http_rewrite.md#id4) directive, and this same configuration will be used to process a request (break):

```nginx
location /name/ {
    rewrite    /name/([^/]+) /users?name=$1 break;
    proxy_pass http://127.0.0.1;
}
```

In this case, the URI specified in the directive is ignored and the full changed request URI is passed to the server.

* When variables are used in `proxy_pass`:

```nginx
location /name/ {
    proxy_pass http://127.0.0.1$request_uri;
}
```

In this case, if URI is specified in the directive, it is passed to the server as is, replacing the original request URI.

[WebSocket](https://en.angie.software//angie/docs/configuration/processing.md#websocket-proxy) proxying requires special configuration.

#### NOTE
If `proxy_pass` is placed in a `location` with a trailing slash in the prefix
(for example, `location /name/`),
and the [auto_redirect](https://en.angie.software//angie/docs/configuration/modules/http/index.md#auto-redirect) directive is set to `default`,
requests without a trailing slash will be redirected (`/name -> /name/`).

<a id="index-45"></a>

<a id="proxy-pass-header"></a>

### proxy_pass_header

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_pass_header` field ...;   |
|------------------------------------------------------------------------------------------|----------------------------------|
| Default                                                                                  | —                                |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location           |

Permits passing [otherwise disabled](#proxy-hide-header) header fields from a proxied server to a client.

<a id="index-46"></a>

<a id="proxy-pass-request-body"></a>

### proxy_pass_request_body

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_pass_request_body` `on` | `off`;   |
|------------------------------------------------------------------------------------------|-------------------------------------------|
| Default                                                                                  | `proxy_pass_request_body on;`             |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                    |

Indicates whether the original request body is passed to the proxied server.

```nginx
location /x-accel-redirect-here/ {
    proxy_method GET;
    proxy_pass_request_body off;
    proxy_set_header Content-Length "";

    proxy_pass ...;
}
```

See also the [proxy_set_header](#proxy-set-header) and [proxy_pass_request_headers](#proxy-pass-request-headers) directives.

<a id="index-47"></a>

<a id="proxy-pass-request-headers"></a>

### proxy_pass_request_headers

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_pass_request_headers` `on` | `off`;   |
|------------------------------------------------------------------------------------------|----------------------------------------------|
| Default                                                                                  | `proxy_pass_request_headers on;`             |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                       |

Indicates whether the header fields of the original request are passed to the proxied server.

```nginx
location /x-accel-redirect-here/ {
    proxy_method GET;
    proxy_pass_request_headers off;
    proxy_pass_request_body off;

    proxy_pass ...;
}
```

See also the [proxy_set_header](#proxy-set-header) and [proxy_pass_request_body](#proxy-pass-request-body) directives.

<a id="index-48"></a>

<a id="proxy-pass-trailers"></a>

### proxy_pass_trailers

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_pass_trailers` `on` | `off`;   |
|------------------------------------------------------------------------------------------|---------------------------------------|
| Default                                                                                  | `proxy_pass_trailers off;`            |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                |

Allows passing trailer fields from a proxied server to a client.

A trailer section in HTTP/1.1 is [explicitly enabled](https://datatracker.ietf.org/doc/html/rfc9110#section-6.5.1).

```nginx
location / {
    proxy_http_version 1.1;
    proxy_set_header Connection "te";
    proxy_set_header TE "trailers";
    proxy_pass_trailers on;

    proxy_pass ...;
}
```

<a id="index-49"></a>

<a id="proxy-quic-active-connection-id-limit"></a>

### proxy_quic_active_connection_id_limit

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_quic_active_connection_id_limit` number;   |
|------------------------------------------------------------------------------------------|---------------------------------------------------|
| Default                                                                                  | `proxy_quic_active_connection_id_limit 2;`        |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server                                      |

Sets the [QUIC](#proxy-http-version)
`active_connection_id_limit` transport parameter value.
This is the maximum number of active
[connection IDs](https://www.rfc-editor.org/rfc/rfc9000.html#name-connection-id)
that can be maintained per server.

<a id="index-50"></a>

<a id="proxy-quic-gso"></a>

### proxy_quic_gso

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_quic_gso` `on` | `off`;   |
|------------------------------------------------------------------------------------------|----------------------------------|
| Default                                                                                  | `proxy_quic_gso off;`            |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server                     |

Toggles sending data in
[QUIC](#proxy-http-version)-optimized
batch mode using
[generic segmentation offload](https://docs.kernel.org/networking/segmentation-offloads.html#generic-segmentation-offload).

<a id="index-51"></a>

<a id="proxy-quic-host-key"></a>

### proxy_quic_host_key

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_quic_host_key` file;   |
|------------------------------------------------------------------------------------------|-------------------------------|
| Default                                                                                  | —                             |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server                  |

Sets a file with the secret key
used with [QUIC](#proxy-http-version)
to encrypt
[Stateless Reset](https://www.rfc-editor.org/rfc/rfc9000.html#name-stateless-reset)
and
[Address Validation](https://www.rfc-editor.org/rfc/rfc9000.html#address-validation)
tokens.
By default, a random key is generated at each restart.
Tokens generated with old keys are not accepted.

<a id="index-52"></a>

<a id="proxy-read-timeout"></a>

### proxy_read_timeout

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_read_timeout` time;   |
|------------------------------------------------------------------------------------------|------------------------------|
| Default                                                                                  | `proxy_read_timeout 60s;`    |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location       |

Defines a timeout for reading a response from the proxied server. The timeout is set only between two successive read operations, not for the transmission of the whole response. If the proxied server does not transmit anything within this time, the connection is closed.

<a id="index-53"></a>

<a id="proxy-redirect"></a>

### proxy_redirect

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_redirect` `default`;<br/><br/>`proxy_redirect` `off`;<br/><br/>`proxy_redirect` redirect replacement;   |
|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
| Default                                                                                  | `proxy_redirect default;`                                                                                      |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                                                                                         |

Sets the text that should be changed in the "Location" and "Refresh" header fields of a proxied server response.

Suppose a proxied server returned the header field:

```console
Location: http://localhost:8000/two/some/uri/
```

The directive

```nginx
proxy_redirect http://localhost:8000/two/ http://frontend/one/;
```

will rewrite this string to:

```console
Location: http://frontend/one/some/uri/
```

A server name may be omitted in the replacement string:

```nginx
proxy_redirect http://localhost:8000/two/ /;
```

then the primary server's name and port, if different from 80, will be inserted.

The default replacement specified by the `default` parameter uses the parameters of the [location](https://en.angie.software//angie/docs/configuration/modules/http/index.md#location) and [proxy_pass](#proxy-pass) directives. Hence, the two configurations below are equivalent:

```nginx
location /one/ {
    proxy_pass     http://upstream:port/two/;
    proxy_redirect default;
}
```

```nginx
location /one/ {
    proxy_pass     http://upstream:port/two/;
    proxy_redirect http://upstream:port/two/ /one/;
}
```

#### WARNING
The `default` parameter is not permitted if [proxy_pass](#proxy-pass) is specified using variables.

A replacement string can contain variables:

```nginx
proxy_redirect http://localhost:8000/ http://$host:$server_port/;
```

A redirect can also contain variables:

```nginx
proxy_redirect http://$proxy_host:8000/ /;
```

The directive can be specified using regular expressions. In this case, redirect should either start with the "~" symbol for a case-sensitive matching, or with the "~\*" symbols for case-insensitive matching. The regular expression can contain named and positional captures, and replacement can reference them:

```nginx
proxy_redirect ~^(http://[^:]+):\d+(/.+)$ $1$2;
proxy_redirect ~*/user/([^/]+)/(.+)$      http://$1.example.com/$2;
```

Several proxy_redirect directives can be specified on the same level:

```nginx
proxy_redirect default;
proxy_redirect http://localhost:8000/  /;
proxy_redirect http://www.example.com/ /;
```

If several directives can be applied to the header fields of a proxied server response, the first matching directive will be chosen.

The `off` parameter cancels the effect of the proxy_redirect directives inherited from the previous configuration level.

Using this directive, it is also possible to add host names to relative redirects issued by a proxied server:

```nginx
proxy_redirect / /;
```

<a id="index-54"></a>

<a id="proxy-request-buffering"></a>

### proxy_request_buffering

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_request_buffering` `on` | `off`;   |
|------------------------------------------------------------------------------------------|-------------------------------------------|
| Default                                                                                  | `proxy_request_buffering on;`             |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                    |

Enables or disables buffering of a client request body.

| `on`   | the entire request body is [read](https://en.angie.software//angie/docs/configuration/modules/http/index.md#client-body-buffer-size) from the client before sending the request to a proxied server.                   |
|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `off`  | the request body is sent to the proxied server immediately as it is received. In this case, the request cannot be passed to the [next server](#proxy-next-upstream) if Angie already started sending the request body. |

When HTTP/1.1 chunked transfer encoding is used to send the original request body, the request body will be buffered regardless of the directive value unless HTTP/1.1 is [enabled](#proxy-http-version) for proxying.

<a id="index-55"></a>

<a id="proxy-send-lowat"></a>

### proxy_send_lowat

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_send_lowat` size;   |
|------------------------------------------------------------------------------------------|----------------------------|
| Default                                                                                  | `proxy_send_lowat 0;`      |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location     |

If the directive is set to a non-zero value, Angie will try to minimize the number of send operations on outgoing connections to a proxied server by using either NOTE_LOWAT flag of the [kqueue](https://en.angie.software//angie/docs/configuration/processing.md#kqueue) method, or the SO_SNDLOWAT socket option, with the specified size.

#### NOTE
This directive is ignored on Linux, Solaris, and Windows.

<a id="index-56"></a>

<a id="proxy-send-timeout"></a>

### proxy_send_timeout

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_send_timeout` time;   |
|------------------------------------------------------------------------------------------|------------------------------|
| Default                                                                                  | `proxy_send_timeout 60s;`    |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location       |

Sets a timeout for transmitting a request to the proxied server. The timeout is set only between two successive write operations, not for the transmission of the whole request. If the proxied server does not receive anything within this time, the connection is closed.

<a id="index-57"></a>

<a id="proxy-set-body"></a>

### proxy_set_body

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_set_body` value;   |
|------------------------------------------------------------------------------------------|---------------------------|
| Default                                                                                  | —                         |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location    |

Allows redefining the request body passed to the proxied server. The value can contain text, variables, and their combination.

<a id="index-58"></a>

<a id="proxy-set-header"></a>

### proxy_set_header

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_set_header` field value;      |
|------------------------------------------------------------------------------------------|--------------------------------------|
| Default                                                                                  | `proxy_set_header Host $proxy_host;` |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location               |

Allows redefining or appending fields to the request header [passed](#proxy-pass-request-headers) to the proxied server. The value can contain text, variables, and their combinations. These directives are inherited from the previous configuration level if and only if there are no proxy_set_header directives defined on the current level. By default, only two fields are redefined:

```nginx
proxy_set_header Host       $proxy_host;
proxy_set_header Connection close;
```

If caching is enabled, the header fields `If-Modified-Since`, `If-Unmodified-Since`, `If-None-Match`, `If-Match`, `Range`, and `If-Range` from the original request are not passed to the proxied server.

An unchanged "Host" request header field can be passed like this:

```nginx
proxy_set_header Host       $http_host;
```

However, if this field is not present in a client request header then nothing will be passed. In such a case it is better to use the [$host](https://en.angie.software//angie/docs/configuration/modules/http/index.md#v-host) variable - its value equals the server name in the "Host" request header field or the primary server name if this field is not present:

```nginx
proxy_set_header Host       $host;
```

In addition, the server name can be passed together with the port of the proxied server:

```nginx
proxy_set_header Host       $host:$proxy_port;
```

If the value of a header field is an empty string then this field will not be passed to a proxied server:

```nginx
proxy_set_header Accept-Encoding "";
```

<a id="index-59"></a>

<a id="proxy-socket-keepalive"></a>

### proxy_socket_keepalive

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_socket_keepalive` `on` | `off`;   |
|------------------------------------------------------------------------------------------|------------------------------------------|
| Default                                                                                  | `proxy_socket_keepalive off;`            |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                   |

Configures the "TCP keepalive" behavior for outgoing connections to a proxied server.

| `off`   | By default, the operating system's settings are in effect for the socket.   |
|---------|-----------------------------------------------------------------------------|
| `on`    | The SO_KEEPALIVE socket option is turned on for the socket.                 |

<a id="index-60"></a>

<a id="proxy-ssl-certificate"></a>

### proxy_ssl_certificate

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_ssl_certificate` file [file];   |
|------------------------------------------------------------------------------------------|----------------------------------------|
| Default                                                                                  | —                                      |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                 |

Specifies a file with the certificate in the PEM format used for authentication to a proxied HTTPS server. Variables can be used in the file name.

When [proxy_ssl_ntls](#proxy-ssl-ntls) is enabled, the directive accepts two arguments instead of one:

```nginx
location /proxy {
    proxy_ssl_ntls  on;

    proxy_ssl_certificate      sign.crt enc.crt;
    proxy_ssl_certificate_key  sign.key enc.key;

    proxy_ssl_ciphers "ECC-SM2-WITH-SM4-SM3:ECDHE-SM2-WITH-SM4-SM3:RSA";

    proxy_pass https://backend:443;
}
```

<a id="index-61"></a>

<a id="proxy-ssl-certificate-cache"></a>

### proxy_ssl_certificate_cache

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_ssl_certificate_cache` `off`;<br/><br/>`proxy_ssl_certificate_cache` `max=`N [`inactive=`time] [`valid=`time];   |
|------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|
| Default                                                                                  | `proxy_ssl_certificate_cache off;`                                                                                      |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                                                                                                  |

Defines a cache that stores [SSL certificates](#proxy-ssl-certificate) and [secret keys](#proxy-ssl-certificate-key) specified using variables.

The directive supports the following parameters:

- `max` — sets the maximum number of elements in the cache. When the cache overflows, the least recently used (LRU) elements are removed.
- `inactive` — defines the time after which an element is removed if it has not been accessed. The default is 10 seconds.
- `valid` — defines the time during which a cached element is considered valid and can be reused. The default is 60 seconds. After this period, certificates are reloaded or revalidated.
- `off` — disables the cache.

Example:

```nginx
proxy_ssl_certificate       $proxy_ssl_server_name.crt;
proxy_ssl_certificate_key   $proxy_ssl_server_name.key;
proxy_ssl_certificate_cache max=1000 inactive=20s valid=1m;
```

<a id="index-62"></a>

<a id="proxy-ssl-certificate-key"></a>

### proxy_ssl_certificate_key

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_ssl_certificate_key` file [file];   |
|------------------------------------------------------------------------------------------|--------------------------------------------|
| Default                                                                                  | —                                          |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                     |

Specifies a file with the secret key in the PEM format used for authentication to a proxied HTTPS server.

The value `engine:`name`:id` can be specified instead of the file, which loads a secret key with a specified id from the OpenSSL engine name.

The value `store:scheme:id` can be specified instead of the file, which is used to load a secret key with a specified id and OpenSSL provider registered URI scheme, such as [pkcs11](https://datatracker.ietf.org/doc/html/rfc7512).

Variables can be used in the file name.

When [proxy_ssl_ntls](#proxy-ssl-ntls) is enabled, the directive accepts two arguments instead of one:

```nginx
location /proxy {
    proxy_ssl_ntls  on;

    proxy_ssl_certificate      sign.crt enc.crt;
    proxy_ssl_certificate_key  sign.key enc.key;

    proxy_ssl_ciphers "ECC-SM2-WITH-SM4-SM3:ECDHE-SM2-WITH-SM4-SM3:RSA";

    proxy_pass https://backend:443;
}
```

<a id="index-63"></a>

<a id="proxy-ssl-ciphers"></a>

### proxy_ssl_ciphers

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_ssl_ciphers` ciphers;   |
|------------------------------------------------------------------------------------------|--------------------------------|
| Default                                                                                  | `proxy_ssl_ciphers DEFAULT;`   |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location         |

Specifies the enabled ciphers for requests to a proxied HTTPS server. The ciphers are specified in the format understood by the OpenSSL library.

The list of ciphers depends on the version of OpenSSL installed.
The full list can be viewed using the `openssl ciphers` command.

#### WARNING
The `proxy_ssl_ciphers` directive does *not* configure ciphers for TLS
1.3 when using OpenSSL. To tune TLS 1.3 ciphers with OpenSSL, use the
[proxy_ssl_conf_command](#proxy-ssl-conf-command) directive, which was added to support advanced
SSL configuration.

- In LibreSSL, TLS 1.3 ciphers *can* be configured using
  `proxy_ssl_ciphers`.
- In BoringSSL, TLS 1.3 ciphers cannot be configured at all.

<a id="index-64"></a>

<a id="proxy-ssl-conf-command"></a>

### proxy_ssl_conf_command

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_ssl_conf_command` name value;   |
|------------------------------------------------------------------------------------------|----------------------------------------|
| Default                                                                                  | —                                      |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                 |

Sets arbitrary OpenSSL configuration [commands](https://docs.openssl.org/master/man3/SSL_CONF_cmd/) when establishing a connection with the proxied HTTPS server.

#### NOTE
The directive is supported when using OpenSSL 1.0.2 or higher.
To configure TLS 1.3 ciphers with OpenSSL, use the `ciphersuites` command.

Several proxy_ssl_conf_command directives can be specified on the same level. These directives are inherited from the previous configuration level if and only if there are no proxy_ssl_conf_command directives defined on the current level.

#### WARNING
Note that configuring OpenSSL directly might result in unexpected behavior.

<a id="index-65"></a>

<a id="proxy-ssl-crl"></a>

### proxy_ssl_crl

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_ssl_crl` file;   |
|------------------------------------------------------------------------------------------|-------------------------|
| Default                                                                                  | —                       |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location  |

Specifies a file with revoked certificates (CRL) in the PEM format used to [verify](#proxy-ssl-verify) the certificate of the proxied HTTPS server.

<a id="index-66"></a>

<a id="proxy-ssl-name"></a>

### proxy_ssl_name

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_ssl_name` name;        |
|------------------------------------------------------------------------------------------|-------------------------------|
| Default                                                                                  | `proxy_ssl_name $proxy_host;` |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location        |

Allows overriding the server name used to [verify](#proxy-ssl-verify) the certificate of the proxied HTTPS server and to be [passed through SNI](#proxy-ssl-server-name) when establishing a connection with the proxied HTTPS server.

By default, the host part of the [proxy_pass](#proxy-pass) URL is used.

<a id="index-67"></a>

<a id="proxy-ssl-ntls"></a>

### proxy_ssl_ntls

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_ssl_ntls` `on` | `off`;   |
|------------------------------------------------------------------------------------------|----------------------------------|
| Default                                                                                  | `proxy_ssl_ntls off;`            |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server                     |

Enables client-side support for NTLS using the [TongSuo](https://github.com/Tongsuo-Project/Tongsuo) TLS library.

```nginx
location /proxy {
    proxy_ssl_ntls  on;

    proxy_ssl_certificate      sign.crt enc.crt;
    proxy_ssl_certificate_key  sign.key enc.key;

    proxy_ssl_ciphers "ECC-SM2-WITH-SM4-SM3:ECDHE-SM2-WITH-SM4-SM3:RSA";

    proxy_pass https://backend:443;
}
```

#### NOTE
Angie must be built with the `--with-ntls` configuration parameter and the corresponding SSL library with NTLS support

```default
./configure --with-openssl=../Tongsuo-8.3.0 \
            --with-openssl-opt=enable-ntls  \
            --with-ntls
```

<a id="index-68"></a>

<a id="proxy-ssl-password-file"></a>

### proxy_ssl_password_file

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_ssl_password_file` file;   |
|------------------------------------------------------------------------------------------|-----------------------------------|
| Default                                                                                  | —                                 |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location            |

Specifies a file with passphrases for [secret keys](#proxy-ssl-certificate-key) where each passphrase is specified on a separate line. Passphrases are tried in turn when loading the key.

<a id="index-69"></a>

<a id="proxy-ssl-protocols"></a>

### proxy_ssl_protocols

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_ssl_protocols` [`SSLv2`] [`SSLv3`] [`TLSv1`] [`TLSv1.1`] [`TLSv1.2`] [`TLSv1.3`];   |
|------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|
| Default                                                                                  | `proxy_ssl_protocols TLSv1.2 TLSv1.3;`                                                     |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                                                                     |

#### Versionchanged
Changed in version 1.2.0: `TLSv1.3` parameter added to default set.

Enables the specified protocols for requests to a proxied HTTPS server.

<a id="index-70"></a>

<a id="proxy-ssl-server-name"></a>

### proxy_ssl_server_name

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_ssl_server_name` `on` | `off`;   |
|------------------------------------------------------------------------------------------|-----------------------------------------|
| Default                                                                                  | `proxy_ssl_server_name off;`            |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                  |

Enables or disables passing the server name
set by the [proxy_ssl_name](#proxy-ssl-name) directive
via the
[Server Name Indication](http://en.wikipedia.org/wiki/Server_Name_Indication)
TLS extension
(SNI,
[RFC 6066](https://datatracker.ietf.org/doc/html/rfc6066.html))
when establishing a connection with the proxied HTTPS server.

<a id="index-71"></a>

<a id="proxy-ssl-session-reuse"></a>

### proxy_ssl_session_reuse

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_ssl_session_reuse` `on` | `off`;   |
|------------------------------------------------------------------------------------------|-------------------------------------------|
| Default                                                                                  | `proxy_ssl_session_reuse on;`             |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                    |

Determines whether SSL sessions can be reused when working with the proxied server. If the errors "SSL3_GET_FINISHED:digest check failed" appear in the logs, try disabling session reuse.

<a id="index-72"></a>

<a id="proxy-ssl-trusted-certificate"></a>

### proxy_ssl_trusted_certificate

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_ssl_trusted_certificate` file;   |
|------------------------------------------------------------------------------------------|-----------------------------------------|
| Default                                                                                  | —                                       |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                  |

Specifies a file with trusted CA certificates in the PEM format used to [verify](#proxy-ssl-verify) the certificate of the proxied HTTPS server.

<a id="index-73"></a>

<a id="proxy-ssl-verify"></a>

### proxy_ssl_verify

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_ssl_verify` `on` | `off`;   |
|------------------------------------------------------------------------------------------|------------------------------------|
| Default                                                                                  | `proxy_ssl_verify off;`            |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location             |

Enables or disables verification of the proxied HTTPS server certificate.

<a id="index-74"></a>

<a id="proxy-ssl-verify-depth"></a>

### proxy_ssl_verify_depth

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_ssl_verify_depth` number;   |
|------------------------------------------------------------------------------------------|------------------------------------|
| Default                                                                                  | `proxy_ssl_verify_depth 1;`        |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location             |

Sets the verification depth in the proxied HTTPS server certificate chain.

<a id="index-75"></a>

<a id="proxy-store"></a>

### proxy_store

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_store` `on` | `off` | string;   |
|------------------------------------------------------------------------------------------|----------------------------------------|
| Default                                                                                  | `proxy_store off;`                     |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                 |

Enables saving of files to a disk.

| `on`   | saves files according to the paths specified in the [alias](https://en.angie.software//angie/docs/configuration/modules/http/index.md#alias) or [root](https://en.angie.software//angie/docs/configuration/modules/http/index.md#root) directives   |
|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `off`  | disables saving of files                                                                                                                                                                                                                            |

The file name can be set explicitly using a `string` with variables:

```nginx
proxy_store /data/www$original_uri;
```

The modification time of files is set according to the received `Last-Modified` header field in the response. The response is first written to a temporary file, and then the file is renamed. The temporary file and the persistent store for the response can be on different file systems. However, be aware that in this case instead of the cheap rename operation within one file system, the file is copied from one file system to another. It is thus recommended that for any given location both saved files and a directory holding temporary files, set by the [proxy_temp_path](#proxy-temp-path) directive, are put on the same file system.

This directive can be used to create local copies of static unchangeable files, e.g.:

```nginx
location /images/ {
    root               /data/www;
    error_page         404 = /fetch$uri;
}

location /fetch/ {
    internal;

    proxy_pass         http://backend/;
    proxy_store        on;
    proxy_store_access user:rw group:rw all:r;
    proxy_temp_path    /data/temp;

    alias              /data/www/;
}
```

or like this:

```nginx
location /images/ {
    root               /data/www;
    error_page         404 = @fetch;
}

location @fetch {
    internal;

    proxy_pass         http://backend;
    proxy_store        on;
    proxy_store_access user:rw group:rw all:r;
    proxy_temp_path    /data/temp;

    root               /data/www;
}
```

<a id="index-76"></a>

<a id="proxy-store-access"></a>

### proxy_store_access

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_store_access` users:permissions ...;   |
|------------------------------------------------------------------------------------------|-----------------------------------------------|
| Default                                                                                  | `proxy_store_access user:rw;`                 |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                        |

Sets access permissions for newly created files and directories, e.g.:

```nginx
proxy_store_access user:rw group:rw all:r;
```

If any `group` or `all` access permissions are specified, then `user` permissions may be omitted:

```nginx
proxy_store_access group:rw all:r;
```

<a id="index-77"></a>

<a id="proxy-temp-file-write-size"></a>

### proxy_temp_file_write_size

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_temp_file_write_size` size;   |
|------------------------------------------------------------------------------------------|--------------------------------------|
| Default                                                                                  | `proxy_temp_file_write_size 8k|16k;` |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location               |

Limits the size of data written to a temporary file at a time, when buffering of responses from the proxied server to temporary files is enabled. By default, size is limited by two buffers set by the [proxy_buffer_size](#proxy-buffer-size) and [proxy_buffers](#proxy-buffers) directives. The maximum size of a temporary file is set by the [proxy_max_temp_file_size](#proxy-max-temp-file-size) directive.

<a id="index-78"></a>

<a id="proxy-temp-path"></a>

### proxy_temp_path

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `proxy_temp_path` path [level1 [level2 [level3]]]\`;                                                                                                                         |
|------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Default                                                                                  | `proxy_temp_path proxy_temp;`<br/>(the path depends on the [build option](https://en.angie.software//angie/docs/installation/sourcebuild.md#paths) `--http-proxy-temp-path`) |
| [Context](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)  | http, server, location                                                                                                                                                       |

Defines a directory for storing temporary files with data received from proxied servers. Up to three-level subdirectory hierarchy can be used underneath the specified directory. For example, in the following configuration

```nginx
proxy_temp_path /spool/angie/proxy_temp 1 2;
```

a temporary file might look like this:

```nginx
/spool/angie/proxy_temp/7/45/00000123457
```

See also the `use_temp_path` parameter of the [proxy_cache_path](#proxy-cache-path) directive.

<a id="built-in-variables-6"></a>

## Built-in Variables

The http_proxy module supports built-in variables that can be used to compose headers using the [proxy_set_header](#proxy-set-header) directive:

<a id="v-proxy-host"></a>

### `$proxy_host`

name and port of a proxied server as specified in the [proxy_pass](#proxy-pass) directive;

<a id="v-proxy-port"></a>

### `$proxy_port`

port of a proxied server as specified in the [proxy_pass](#proxy-pass) directive, or the protocol's default port;

<a id="v-proxy-add-x-forwarded-for"></a>

### `$proxy_add_x_forwarded_for`

the `X-Forwarded-For` client request header field with the [$remote_addr](https://en.angie.software//angie/docs/configuration/modules/http/index.md#v-remote-addr) variable appended to it, separated by a comma. If the `X-Forwarded-For` field is not present in the client request header, the [$proxy_add_x_forwarded_for](#v-proxy-add-x-forwarded-for) variable is equal to the [$remote_addr](https://en.angie.software//angie/docs/configuration/modules/http/index.md#v-remote-addr) variable.
