<!-- review: finished -->

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

# FastCGI

The module allows passing requests to a FastCGI server.

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

## Configuration Example

```nginx
location / {
    fastcgi_pass  localhost:9000;
    fastcgi_index index.php;

    fastcgi_param SCRIPT_FILENAME /home/www/scripts/php$fastcgi_script_name;
    fastcgi_param QUERY_STRING    $query_string;
    fastcgi_param REQUEST_METHOD  $request_method;
    fastcgi_param CONTENT_TYPE    $content_type;
    fastcgi_param CONTENT_LENGTH  $content_length;
}
```

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

## Directives

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

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

### fastcgi_bind

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

Makes outgoing connections to a FastCGI 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 fastcgi_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 FastCGI server originate from a non-local IP address, for example, from a real IP address of a client:

```nginx
fastcgi_bind $remote_addr transparent;
```

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

#### NOTE
The kernel routing table should also be configured
to intercept network traffic from the FastCGI server.

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

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

### fastcgi_buffer_size

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_buffer_size` size;   |
|------------------------------------------------------------------------------------------|-------------------------------|
| Default                                                                                  | `fastcgi_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 FastCGI 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="fastcgi-buffering"></a>

### fastcgi_buffering

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

Enables or disables buffering of responses from the FastCGI server.

| `on`   | Angie receives a response from the FastCGI server as soon as possible, saving it into the buffers set by the [fastcgi_buffer_size](#fastcgi-buffer-size) and [fastcgi_buffers](#fastcgi-buffers) directives. Sending to the client is performed in parallel: filled buffers are passed for sending, but their total size is limited by [fastcgi_busy_buffers_size](#fastcgi-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](#fastcgi-temp-path) on the disk. Writing to temporary files is controlled by the [fastcgi_max_temp_file_size](#fastcgi-max-temp-file-size) and [fastcgi_temp_file_write_size](#fastcgi-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 [fastcgi_buffer_size](#fastcgi-buffer-size) directive. With `off`, [fastcgi_limit_rate](#fastcgi-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 [fastcgi_ignore_headers](#fastcgi-ignore-headers) directive.

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

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

### fastcgi_buffers

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_buffers` number size;   |
|------------------------------------------------------------------------------------------|----------------------------------|
| Default                                                                                  | `fastcgi_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 FastCGI 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="fastcgi-busy-buffers-size"></a>

### fastcgi_busy_buffers_size

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

When [buffering](#fastcgi-buffering) of responses from the FastCGI 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 [fastcgi_buffer_size](#fastcgi-buffer-size) and [fastcgi_buffers](#fastcgi-buffers) directives.

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

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

### fastcgi_cache

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_cache` zone | `off`;   |
|------------------------------------------------------------------------------------------|---------------------------------|
| Default                                                                                  | `fastcgi_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. The `off` parameter disables caching inherited from the previous configuration level.

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

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

### fastcgi_cache_background_update

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_cache_background_update` `on` | `off`;   |
|------------------------------------------------------------------------------------------|---------------------------------------------------|
| Default                                                                                  | `fastcgi_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. Note that it is necessary to [allow](#fastcgi-cache-use-stale-updating) the usage of a stale cached response when it is being updated.

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

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

### fastcgi_cache_bypass

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_cache_bypass` 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 taken from 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 taken from the cache:

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

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

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

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

### fastcgi_cache_key

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

Defines a key for caching, for example

```nginx
fastcgi_cache_key localhost:9000$request_uri;
```

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

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

### fastcgi_cache_lock

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_cache_lock` `on` | `off`;   |
|------------------------------------------------------------------------------------------|--------------------------------------|
| Default                                                                                  | `fastcgi_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 [fastcgi_cache_key](#fastcgi-cache-key) directive by passing a request to a FastCGI server. Other requests of the same cache element will either wait for a response to appear in the cache or the cache lock for this element to be released, up to the time set by the [fastcgi_cache_lock_timeout](#fastcgi-cache-lock-timeout) directive.

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

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

### fastcgi_cache_lock_age

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_cache_lock_age` time;   |
|------------------------------------------------------------------------------------------|----------------------------------|
| Default                                                                                  | `fastcgi_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 FastCGI server for populating a new cache element has not completed for the specified time, one more request may be passed to the FastCGI server.

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

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

### fastcgi_cache_lock_timeout

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

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

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

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

### fastcgi_cache_max_range_offset

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_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 offset, the range request will be passed to the FastCGI server and the response will not be cached.

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

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

### fastcgi_cache_methods

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_cache_methods` `GET` | `HEAD` | `POST` ...;   |
|------------------------------------------------------------------------------------------|--------------------------------------------------------|
| Default                                                                                  | `fastcgi_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, though it is recommended to specify them explicitly. See also the [fastcgi_no_cache](#fastcgi-no-cache) directive.

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

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

### fastcgi_cache_min_uses

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_cache_min_uses` number;   |
|------------------------------------------------------------------------------------------|------------------------------------|
| Default                                                                                  | `fastcgi_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. To
completely reset the cache, stop the server, delete the cache directory, and start again.

#### NOTE
Third-party cache purge modules (e.g., [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 fastcgi_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-15"></a>

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

### fastcgi_cache_path

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_cache_path` path [`levels=`levels] [`use_temp_path=``on` | `off`] `keys_zone=`name:size [`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, server, location                                                                                                                                                                                                                                                                                       |

Sets the path and other parameters of a cache. Cache data are stored in files. Both the key and file name in a cache are a result of applying the MD5 function to the proxied URL.

The `levels` parameter defines hierarchy levels of a cache: from 1 to 3, each level accepts values 1 or 2. For example, in the following configuration

```nginx
fastcgi_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.

A directory for temporary files is set based on the `use_temp_path` parameter.

| `on`   | If this parameter is omitted or set to the value `on`, the directory set by the [fastcgi_temp_path](#fastcgi-temp-path) directive for the given location will be used.   |
|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `off`  | temporary files will be put directly in the cache directory.                                                                                                             |

In addition, all active keys and information about data are stored in a shared memory zone, whose name and size are configured by the `keys_zone` parameter. One megabyte zone can store about 8 thousand keys. Cache metadata is stored in shared memory.

Cached data that are not accessed during the time specified by the `inactive` parameter get removed from the cache regardless of their freshness.

By default, `inactive` is set to 10 minutes.

A special **cache manager** process monitors the maximum cache size, and the minimum amount of free space on the file system with cache. When the size is exceeded or there is not enough free space, it removes the least recently used data. The data is removed in iterations.

| `max_size`          | maximum cache size                                                                        |
|---------------------|-------------------------------------------------------------------------------------------|
| `min_free`          | minimum amount of free space on the file system with cache                                |
| `manager_files`     | limits the number of items to be deleted during 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              |

A minute after Angie starts, the special **cache loader** process is activated. It loads information about previously cached data stored on file system into a cache zone. The loading is also done in iterations.

| `loader_files`     | maximum number of cache items to load in one iteration<br/><br/>Default: `100`              |
|--------------------|---------------------------------------------------------------------------------------------|
| `loader_threshold` | limits the time of one iteration<br/><br/>Default: `200` milliseconds                       |
| `loader_sleep`     | time for which a pause is maintained between iterations<br/><br/>Default: `50` milliseconds |

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

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

### fastcgi_cache_revalidate

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_cache_revalidate` `on` | `off`;   |
|------------------------------------------------------------------------------------------|--------------------------------------------|
| Default                                                                                  | `fastcgi_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-17"></a>

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

### fastcgi_cache_use_stale

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_cache_use_stale` `error` | `timeout` | `invalid_header` | `updating` | `http_500` | `http_503` | `http_403` | `http_429` | `off` ...;   |
|------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|
| Default                                                                                  | `fastcgi_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 when an error occurs during communication with the FastCGI server. The directive's parameters match the parameters of the [fastcgi_next_upstream](#fastcgi-next-upstream) directive.

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

The use of a stale cached response can also be permitted 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 method has lower priority than setting the directive parameters.

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

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

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

### fastcgi_cache_valid

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_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 following directives

```nginx
fastcgi_cache_valid 200 302 10m;
fastcgi_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
fastcgi_cache_valid 5m;
```

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

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

```nginx
fastcgi_cache_valid 200 302 10m;
fastcgi_cache_valid 301      1h;
fastcgi_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 [fastcgi_ignore_headers](#fastcgi-ignore-headers) directive.

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

<a id="fastcgi-catch-stderr"></a>

### fastcgi_catch_stderr

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

Sets a string to search for in the error stream of a response received from a FastCGI server. If the string is found then it is considered that the FastCGI server has returned an [invalid](#fastcgi-next-upstream) response. This allows handling application errors in Angie, for example:

```nginx
location /php/ {
    fastcgi_pass backend:9000;
    ...
    fastcgi_catch_stderr "PHP Fatal error";
    fastcgi_next_upstream error timeout invalid_header;
}
```

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

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

### fastcgi_connect_timeout

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_connect_timeout` time;   |
|------------------------------------------------------------------------------------------|-----------------------------------|
| Default                                                                                  | `fastcgi_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 FastCGI server. It should be noted that this timeout cannot usually exceed 75 seconds.

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

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

### fastcgi_connection_drop

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_connection_drop` time | `on` | `off`;   |
|------------------------------------------------------------------------------------------|--------------------------------------------------|
| Default                                                                                  | `fastcgi_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="fastcgi-force-ranges"></a>

### fastcgi_force_ranges

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_force_ranges` `on` | `off`;   |
|------------------------------------------------------------------------------------------|----------------------------------------|
| Default                                                                                  | `fastcgi_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 FastCGI server regardless of the `Accept-Ranges` field in these responses.

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

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

### fastcgi_hide_header

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_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 `Status` and `X-Accel-...` from the response of a FastCGI server to a client. The `fastcgi_hide_header` directive sets additional fields that will not be passed. If, on the contrary, the passing of fields needs to be permitted, the [fastcgi_pass_header](#fastcgi-pass-header) directive can be used.

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

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

### fastcgi_ignore_client_abort

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

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

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

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

### fastcgi_ignore_headers

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_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 FastCGI 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](#fastcgi-cache-valid) of response caching;
* `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](#fastcgi-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-26"></a>

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

### fastcgi_index

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

Sets a file name that will be appended after a URI that ends with a slash, in the value of the [$fastcgi_script_name](#v-fastcgi-script-name) variable. For example, with these settings

```nginx
fastcgi_index index.php;
fastcgi_param SCRIPT_FILENAME /home/www/scripts/php$fastcgi_script_name;
```

and the `/page.php` request, the `SCRIPT_FILENAME` parameter will be equal to `/home/www/scripts/php/page.php`, and with the `/` request it will be equal to `/home/www/scripts/php/index.php`.

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

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

### fastcgi_intercept_errors

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

Determines whether FastCGI server 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-28"></a>

<a id="fastcgi-keep-conn"></a>

### fastcgi_keep_conn

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

By default, a FastCGI server will close a connection right after sending the response. However, when this directive is set to the value `on`, Angie will instruct a FastCGI server to keep connections open. This is necessary, in particular, for [keepalive](https://en.angie.software//angie/docs/configuration/modules/http/http_upstream.md#u-keepalive) connections to FastCGI servers to function.

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

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

### fastcgi_limit_rate

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_limit_rate` rate;   |
|------------------------------------------------------------------------------------------|------------------------------|
| Default                                                                                  | `fastcgi_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 can be used.

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

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

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

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

### fastcgi_max_temp_file_size

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

When [buffering](#fastcgi-buffering) of responses from the FastCGI server is enabled, and the entire response does not fit into the buffers set by the [fastcgi_buffer_size](#fastcgi-buffer-size) and [fastcgi_buffers](#fastcgi-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 [fastcgi_temp_file_write_size](#fastcgi-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](#fastcgi-cache) or [stored](#fastcgi-store) on disk.

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

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

### fastcgi_next_upstream

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_next_upstream` `error` | `timeout` | `invalid_header` | `http_500` | `http_503` | `http_403` | `http_404` | `http_429` | `non_idempotent` | `off` ...;   |
|------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Default                                                                                  | `fastcgi_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:

| `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_503`       | a server returned a response with the code 503;                                                                                                                                                                                                                                                         |
| `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.                                                                                                                                                                                                                                                          |

#### NOTE
One should bear in mind 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`   | always considered unsuccessful attempts, even if they are not specified in the directive   |
|--------------------------------------------------------|--------------------------------------------------------------------------------------------|
| `http_500`<br/><br/>`http_503`<br/><br/>`http_429`     | considered unsuccessful attempts only if they are specified in the directive               |
| `http_403`<br/><br/>`http_404`                         | never considered unsuccessful attempts                                                     |

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

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

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

### fastcgi_next_upstream_timeout

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_next_upstream_timeout` time;   |
|------------------------------------------------------------------------------------------|-----------------------------------------|
| Default                                                                                  | `fastcgi_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](#fastcgi-next-upstream).

| `0`   | turns off this limitation   |
|-------|-----------------------------|

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

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

### fastcgi_next_upstream_tries

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_next_upstream_tries` number;   |
|------------------------------------------------------------------------------------------|-----------------------------------------|
| Default                                                                                  | `fastcgi_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](#fastcgi-next-upstream).

| `0`   | turns off this limitation   |
|-------|-----------------------------|

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

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

### fastcgi_no_cache

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_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
fastcgi_no_cache $cookie_nocache $arg_nocache$arg_comment;
fastcgi_no_cache $http_pragma    $http_authorization;
```

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

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

<a id="fastcgi-param"></a>

### fastcgi_param

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

Sets a parameter that should be passed to the FastCGI server. The value can contain text, variables, and their combination. These directives are inherited from the previous configuration level if and only if there are no fastcgi_param directives defined on the current level.

#### NOTE
In the standard `fastcgi.conf` and `fastcgi_params` files shipped
with Angie, `REQUEST_METHOD` is set to `$upstream_request_method`.
This ensures that when caching converts `HEAD` to `GET`, the
upstream request method reflects that conversion.

The following example shows the minimum required settings for PHP:

```nginx
fastcgi_param SCRIPT_FILENAME /home/www/scripts/php$fastcgi_script_name;
fastcgi_param QUERY_STRING    $query_string;
```

The SCRIPT_FILENAME parameter is used in PHP for determining the script name, and the QUERY_STRING parameter is used to pass request parameters.

For scripts that process POST requests, the following three parameters are also required:

```nginx
fastcgi_param REQUEST_METHOD  $request_method;
fastcgi_param CONTENT_TYPE    $content_type;
fastcgi_param CONTENT_LENGTH  $content_length;
```

If PHP was built with the `--enable-force-cgi-redirect` configuration parameter, the REDIRECT_STATUS parameter should also be passed with the value "200":

```nginx
fastcgi_param REDIRECT_STATUS 200;
```

If the directive is specified with `if_not_empty` then such a parameter will be passed to the server only if its value is not empty:

```nginx
fastcgi_param HTTPS           $https if_not_empty;
```

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

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

### fastcgi_pass

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

Sets the address of a FastCGI server. The address can be specified as a domain name or IP address, and a port:

```nginx
fastcgi_pass localhost:9000;
```

or as a UNIX-domain socket path:

```nginx
fastcgi_pass unix:/tmp/fastcgi.socket;
```

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](https://en.angie.software//angie/docs/configuration/modules/http/http_upstream.md#http-upstream), and, if not found, is determined using a [resolver](https://en.angie.software//angie/docs/configuration/modules/http/index.md#resolver).

#### NOTE
If `fastcgi_pass` is placed in a `location` whose prefix ends with a slash
(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-37"></a>

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

### fastcgi_pass_header

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

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

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

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

### fastcgi_pass_request_body

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_pass_request_body` `on` | `off`;   |
|------------------------------------------------------------------------------------------|---------------------------------------------|
| Default                                                                                  | `fastcgi_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 FastCGI server. See also the [fastcgi_pass_request_headers](#fastcgi-pass-request-headers) directive.

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

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

### fastcgi_pass_request_headers

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_pass_request_headers` `on` | `off`;   |
|------------------------------------------------------------------------------------------|------------------------------------------------|
| Default                                                                                  | `fastcgi_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 FastCGI server. See also the [fastcgi_pass_request_body](#fastcgi-pass-request-body) directive.

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

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

### fastcgi_read_timeout

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_read_timeout` time;   |
|------------------------------------------------------------------------------------------|--------------------------------|
| Default                                                                                  | `fastcgi_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 FastCGI server. The timeout is set only between two successive read operations, not for the transmission of the whole response. If the FastCGI server does not transmit anything within this time, the connection is closed.

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

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

### fastcgi_request_buffering

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_request_buffering` `on` | `off`;   |
|------------------------------------------------------------------------------------------|---------------------------------------------|
| Default                                                                                  | `fastcgi_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 FastCGI server.                     |
|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `off`  | the request body is sent to the FastCGI server immediately as it is received. In this case, the request cannot be passed to the [next server](#fastcgi-next-upstream) if Angie already started sending the request body. |

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

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

### fastcgi_send_lowat

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_send_lowat` size;   |
|------------------------------------------------------------------------------------------|------------------------------|
| Default                                                                                  | `fastcgi_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 FastCGI 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-43"></a>

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

### fastcgi_send_timeout

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_send_timeout` time;   |
|------------------------------------------------------------------------------------------|--------------------------------|
| Default                                                                                  | `fastcgi_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 FastCGI server. The timeout is set only between two successive write operations, not for the transmission of the whole request. If the FastCGI server does not receive anything within this time, the connection is closed.

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

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

### fastcgi_socket_keepalive

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_socket_keepalive` `on` | `off`;   |
|------------------------------------------------------------------------------------------|--------------------------------------------|
| Default                                                                                  | `fastcgi_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 FastCGI 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-45"></a>

<a id="fastcgi-split-path-info"></a>

### fastcgi_split_path_info

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

Defines a regular expression that captures a value for the [$fastcgi_path_info](#v-fastcgi-path-info) variable. The regular expression should have two captures: the first becomes a value of the [$fastcgi_script_name](#v-fastcgi-script-name) variable, the second becomes a value of the [$fastcgi_path_info](#v-fastcgi-path-info) variable. For example, with these settings

```default
location ~ ^(.+\.php)(.*)$ {
    fastcgi_split_path_info       ^(.+\.php)(.*)$;
    fastcgi_param SCRIPT_FILENAME /path/to/php$fastcgi_script_name;
    fastcgi_param PATH_INFO       $fastcgi_path_info;
```

and the `/show.php/article/0001` request, the SCRIPT_FILENAME parameter will be equal to `/path/to/php/show.php`,
and the PATH_INFO parameter will be equal to `/article/0001`.

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

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

### fastcgi_store

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_store` `on` | `off` | string;   |
|------------------------------------------------------------------------------------------|------------------------------------------|
| Default                                                                                  | `fastcgi_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 with paths corresponding to the directives [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).   |
|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `off`  | disables saving of files                                                                                                                                                                                                                     |

In addition, the file name can be set explicitly using the string with variables:

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

The modification time of files is set according to the received `Last-Modified` response header field. The response is first written to a temporary file, and then the file is renamed. Temporary files and the persistent store 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 saved files and a directory holding temporary files, set by the [fastcgi_temp_path](#fastcgi-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;

    fastcgi_pass         backend:9000;
    ...

    fastcgi_store        on;
    fastcgi_store_access user:rw group:rw all:r;
    fastcgi_temp_path    /data/temp;

    alias                /data/www/;
}
```

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

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

### fastcgi_store_access

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_store_access` users:permissions ...;   |
|------------------------------------------------------------------------------------------|-------------------------------------------------|
| Default                                                                                  | `fastcgi_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
fastcgi_store_access user:rw group:rw all:r;
```

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

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

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

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

### fastcgi_temp_file_write_size

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_temp_file_write_size` size;   |
|------------------------------------------------------------------------------------------|----------------------------------------|
| Default                                                                                  | `fastcgi_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 FastCGI server to temporary files is enabled. By default, size is limited by two buffers set by the [fastcgi_buffer_size](#fastcgi-buffer-size) and [fastcgi_buffers](#fastcgi-buffers) directives. The maximum size of a temporary file is set by the [fastcgi_max_temp_file_size](#fastcgi-max-temp-file-size) directive.

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

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

### fastcgi_temp_path

| [Syntax](https://en.angie.software//angie/docs/configuration/configfile.md#configfile)   | `fastcgi_temp_path` path [level1 [level2 [level3]]]\`;                                                                                                                                |
|------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Default                                                                                  | `fastcgi_temp_path fastcgi_temp;`<br/>(the path depends on the `--http-fastcgi-temp-path` [build parameter](https://en.angie.software//angie/docs/installation/sourcebuild.md#paths)) |
| [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 FastCGI servers. Up to three-level subdirectory hierarchy can be used under the specified directory. For example, in the following configuration

```nginx
fastcgi_temp_path /spool/angie/fastcgi_temp 1 2;
```

a temporary file might look like this:

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

See also the use_temp_path parameter of the [fastcgi_cache_path](#fastcgi-cache-path) directive.

<a id="parameters-passed-to-a-fastcgi-server"></a>

## Parameters Passed to a FastCGI Server

HTTP request header fields are passed to a FastCGI server as parameters. In applications and scripts run as FastCGI servers, these parameters are usually available as environment variables. For example, the `User-Agent` header field is passed as the HTTP_USER_AGENT parameter. Besides HTTP request header fields, arbitrary parameters can be passed using the [fastcgi_param](#fastcgi-param) directive.

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

## Built-in Variables

The http_fastcgi module supports built-in variables that can be used to set parameters using the [fastcgi_param](#fastcgi-param) directive:

<a id="v-fastcgi-script-name"></a>

### `$fastcgi_script_name`

Request URI or, if a URI ends with a slash, request URI with an index file name configured by the [fastcgi_index](#fastcgi-index) directive appended to it. This variable can be used to set the SCRIPT_FILENAME and PATH_TRANSLATED parameters that are used, in particular, to determine the script name in PHP. For example, for the `/info/` request with the following directives

```nginx
fastcgi_index index.php;
fastcgi_param SCRIPT_FILENAME /home/www/scripts/php$fastcgi_script_name;
```

the SCRIPT_FILENAME parameter will be equal to `/home/www/scripts/php/info/index.php`.

When using the [fastcgi_split_path_info](#fastcgi-split-path-info) directive, the $fastcgi_script_name variable equals the value of the first capture group set by this directive.

<a id="v-fastcgi-path-info"></a>

### `$fastcgi_path_info`

The value of the second capture group set by the [fastcgi_split_path_info](#fastcgi-split-path-info) directive. This variable can be used to set the PATH_INFO parameter.