<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>Module ngx_http_fastcgi_module</title><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="stylesheet" href="../../../css/style_en.css">

Planning your ingress-nginx migration? Start here:
kubernetes.nginx.org.

<input class="side-menu" type="checkbox" id="side-menu">

english

русский

news

about

download

security

documentation

faq

books

community

enterprise

community forum (new)

x.com

blog

njs

ingress controller

gateway fabric

Module ngx_http_fastcgi_module

Example Configuration
Directives
     fastcgi_allow_upstream
     fastcgi_bind
     fastcgi_bind_dynamic
     fastcgi_buffer_size
     fastcgi_buffering
     fastcgi_buffers
     fastcgi_busy_buffers_size
     fastcgi_cache
     fastcgi_cache_background_update
     fastcgi_cache_bypass
     fastcgi_cache_key
     fastcgi_cache_lock
     fastcgi_cache_lock_age
     fastcgi_cache_lock_timeout
     fastcgi_cache_max_range_offset
     fastcgi_cache_methods
     fastcgi_cache_min_uses
     fastcgi_cache_path
     fastcgi_cache_purge
     fastcgi_cache_revalidate
     fastcgi_cache_use_stale
     fastcgi_cache_valid
     fastcgi_catch_stderr
     fastcgi_connect_timeout
     fastcgi_force_ranges
     fastcgi_hide_header
     fastcgi_ignore_client_abort
     fastcgi_ignore_headers
     fastcgi_index
     fastcgi_intercept_errors
     fastcgi_keep_conn
     fastcgi_limit_rate
     fastcgi_max_temp_file_size
     fastcgi_next_upstream
     fastcgi_next_upstream_timeout
     fastcgi_next_upstream_tries
     fastcgi_no_cache
     fastcgi_param
     fastcgi_pass
     fastcgi_pass_header
     fastcgi_pass_request_body
     fastcgi_pass_request_headers
     fastcgi_read_timeout
     fastcgi_request_buffering
     fastcgi_request_dynamic
     fastcgi_send_lowat
     fastcgi_send_timeout
     fastcgi_socket_keepalive
     fastcgi_split_path_info
     fastcgi_store
     fastcgi_store_access
     fastcgi_temp_file_write_size
     fastcgi_temp_path
Parameters Passed to a FastCGI Server
Embedded Variables

The ngx_http_fastcgi_module module allows passing
requests to a FastCGI server.

Example Configuration

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;
}

Directives

            Syntax:

            fastcgi_allow_upstream string ...;

            Default:

            —

            Context:

            http, server, location

This directive appeared in version 1.29.3.

Defines conditions under which access to a FastCGI server
is allowed or denied.
If all string parameters are not empty
and not equal to “0” then the access is allowed.
The conditions are evaluated each time
before a connection to a FastCGI server is established.
Parameter values can contain variables:

geo $upstream_last_addr $allow {
    volatile;
    10.10.0.0/24        1;
}

server {
    listen 127.0.0.1:8080;

    location / {
        fastcgi_pass           localhost:9000;
        fastcgi_allow_upstream $allow;
        ...
    }
}

This directive is available as part of our
commercial subscription.

            Syntax:

            fastcgi_bind
    address
    [transparent] |
    off;

            Default:

            —

            Context:

            http, server, location

This directive appeared in version 0.8.22.

Makes outgoing connections to a FastCGI server originate
from the specified local IP address with an optional port (1.11.2).
Parameter value can contain variables (1.3.12).
The special value off (1.3.12) 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 (1.11.0) allows
outgoing connections to a FastCGI server originate
from a non-local IP address,
for example, from a real IP address of a client:

fastcgi_bind $remote_addr transparent;

In order for this parameter to work,
it is usually necessary to run nginx worker processes with the
superuser privileges.
On Linux it is not required (1.13.8) as if
the transparent parameter is specified, worker processes
inherit the CAP_NET_RAW capability from the master process.
It is also necessary to configure kernel routing table
to intercept network traffic from the FastCGI server.

            Syntax:

            fastcgi_bind_dynamic on | off;

            Default:

fastcgi_bind_dynamic off;

            Context:

            http, server, location

This directive appeared in version 1.29.3.

When enabled, makes the bind operation
at each connection attempt.

This directive is available as part of our
commercial subscription.

            Syntax:

            fastcgi_buffer_size size;

            Default:

fastcgi_buffer_size 4k|8k;

            Context:

            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;
if it exceeds the buffer size, the response is considered
invalid.
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.

            Syntax:

            fastcgi_buffering on | off;

            Default:

fastcgi_buffering on;

            Context:

            http, server, location

This directive appeared in version 1.5.6.

Enables or disables buffering of responses from the FastCGI server.

When buffering is enabled, nginx receives a response from the FastCGI server
as soon as possible, saving it into the buffers set by the
fastcgi_buffer_size and fastcgi_buffers directives.
If the whole response does not fit into memory, a part of it can be saved
to a temporary file on the disk.
Writing to temporary files is controlled by the
fastcgi_max_temp_file_size and
fastcgi_temp_file_write_size directives.

When buffering is disabled, the response is passed to a client synchronously,
immediately as it is received.
nginx will not try to read the whole response from the FastCGI server.
The maximum size of the data that nginx can receive from the server
at a time is set by the fastcgi_buffer_size directive.

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 directive.

            Syntax:

            fastcgi_buffers number size;

            Default:

fastcgi_buffers 8 4k|8k;

            Context:

            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.

            Syntax:

            fastcgi_busy_buffers_size size;

            Default:

fastcgi_busy_buffers_size 8k|16k;

            Context:

            http, server, location

When 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 and fastcgi_buffers directives.

            Syntax:

            fastcgi_cache zone | off;

            Default:

fastcgi_cache off;

            Context:

            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 (1.7.9).
The off parameter disables caching inherited
from the previous configuration level.

            Syntax:

            fastcgi_cache_background_update on | off;

            Default:

fastcgi_cache_background_update off;

            Context:

            http, server, location

This directive appeared in version 1.11.10.

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
the usage of a stale cached response when it is being updated.

            Syntax:

            fastcgi_cache_bypass string ...;

            Default:

            —

            Context:

            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:

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

Can be used along with the fastcgi_no_cache directive.

            Syntax:

            fastcgi_cache_key string;

            Default:

            —

            Context:

            http, server, location

Defines a key for caching, for example

fastcgi_cache_key localhost:9000$request_uri;

            Syntax:

            fastcgi_cache_lock on | off;

            Default:

fastcgi_cache_lock off;

            Context:

            http, server, location

This directive appeared in version 1.1.12.

When enabled, only one request at a time will be allowed to populate
a new cache element identified according to the 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 directive.

            Syntax:

            fastcgi_cache_lock_age time;

            Default:

fastcgi_cache_lock_age 5s;

            Context:

            http, server, location

This directive appeared in version 1.7.8.

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.

            Syntax:

            fastcgi_cache_lock_timeout time;

            Default:

fastcgi_cache_lock_timeout 5s;

            Context:

            http, server, location

This directive appeared in version 1.1.12.

Sets a timeout for fastcgi_cache_lock.
When the time expires,
the request will be passed to the FastCGI server,
however, the response will not be cached.

Before 1.7.8, the response could be cached.

            Syntax:

            fastcgi_cache_max_range_offset number;

            Default:

            —

            Context:

            http, server, location

This directive appeared in version 1.11.6.

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.

            Syntax:

            fastcgi_cache_methods
    GET |
    HEAD |
    POST
    ...;

            Default:

fastcgi_cache_methods GET HEAD;

            Context:

            http, server, location

This directive appeared in version 0.7.59.

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 directive.

            Syntax:

            fastcgi_cache_min_uses number;

            Default:

fastcgi_cache_min_uses 1;

            Context:

            http, server, location

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

            Syntax:

            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]
    [purger=on|off]
    [purger_files=number]
    [purger_sleep=time]
    [purger_threshold=time];

            Default:

            —

            Context:

            http

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

fastcgi_cache_path /data/nginx/cache levels=1:2 keys_zone=one:10m;

file names in a cache will look like this:

/data/nginx/cache/c/29/b7f54b2df7773722d382f4809d65029c

A cached response is first written to a temporary file,
and then the file is renamed.
Starting from version 0.8.9, 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 (1.7.10).
If this parameter is omitted or set to the value on,
the directory set by the fastcgi_temp_path directive
for the given location will be used.
If the value is set to 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.

As part of
commercial subscription,
the shared memory zone also stores extended
cache information,
thus, it is required to specify a larger zone size for the same number of keys.
For example,
one megabyte zone can store about 4 thousand keys.

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.

The special “cache manager” process monitors the maximum cache size set
by the max_size parameter,
and the minimum amount of free space set
by the min_free (1.19.1) parameter
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 configured by
manager_files,
manager_threshold, and
manager_sleep parameters (1.11.5).
During one iteration no more than manager_files items
are deleted (by default, 100).
The duration of one iteration is limited by the
manager_threshold parameter (by default, 200 milliseconds).
Between iterations, a pause configured by the manager_sleep
parameter (by default, 50 milliseconds) is made.

A minute after the start 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.
During one iteration no more than loader_files items
are loaded (by default, 100).
Besides, the duration of one iteration is limited by the
loader_threshold parameter (by default, 200 milliseconds).
Between iterations, a pause configured by the loader_sleep
parameter (by default, 50 milliseconds) is made.

Additionally,
the following parameters are available as part of our
commercial subscription:

purger=on|off

Instructs whether cache entries that match a
wildcard key
will be removed from the disk by the cache purger (1.7.12).
Setting the parameter to on
(default is off)
will activate the “cache purger” process that
permanently iterates through all cache entries
and deletes the entries that match the wildcard key.

purger_files=number

Sets the number of items that will be scanned during one iteration (1.7.12).
By default, purger_files is set to 10.

purger_threshold=number

Sets the duration of one iteration (1.7.12).
By default, purger_threshold is set to 50 milliseconds.

purger_sleep=number

Sets a pause between iterations (1.7.12).
By default, purger_sleep is set to 50 milliseconds.

In versions 1.7.3, 1.7.7, and 1.11.10 cache header format has been changed.
Previously cached responses will be considered invalid
after upgrading to a newer nginx version.

            Syntax:

            fastcgi_cache_purge string ...;

            Default:

            —

            Context:

            http, server, location

This directive appeared in version 1.5.7.

Defines conditions under which the request will be considered a cache
purge request.
If at least one value of the string parameters is not empty and is not equal
to “0” then the cache entry with a corresponding
cache key is removed.
The result of successful operation is indicated by returning
the 204 (No Content) response.

If the cache key of a purge request ends
with an asterisk (“*”), all cache entries matching the
wildcard key will be removed from the cache.
However, these entries will remain on the disk until they are deleted
for either inactivity,
or processed by the cache purger (1.7.12),
or a client attempts to access them.

Example configuration:

fastcgi_cache_path /data/nginx/cache keys_zone=cache_zone:10m;

map $request_method $purge_method {
    PURGE   1;
    default 0;
}

server {
    ...
    location / {
        fastcgi_pass        backend;
        fastcgi_cache       cache_zone;
        fastcgi_cache_key   $uri;
        fastcgi_cache_purge $purge_method;
    }
}

This functionality is available as part of our
commercial subscription.

            Syntax:

            fastcgi_cache_revalidate on | off;

            Default:

fastcgi_cache_revalidate off;

            Context:

            http, server, location

This directive appeared in version 1.5.7.

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

            Syntax:

            fastcgi_cache_use_stale
    error |
    timeout |
    invalid_header |
    updating |
    http_500 |
    http_503 |
    http_403 |
    http_404 |
    http_429 |
    off
    ...;

            Default:

fastcgi_cache_use_stale off;

            Context:

            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 directive.

The error parameter also permits
using a stale cached response if a FastCGI server to process a request
cannot be selected.

Additionally, the updating parameter 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.

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 (1.11.10).
This has lower priority than using the directive parameters.

The
“stale-while-revalidate”
extension of the “Cache-Control” header field permits
using a stale cached response if it is currently being updated.

The
“stale-if-error”
extension of the “Cache-Control” header field permits
using a stale cached response in case of an error.

To minimize the number of accesses to FastCGI servers when
populating a new cache element, the fastcgi_cache_lock
directive can be used.

            Syntax:

            fastcgi_cache_valid [code ...] time;

            Default:

            —

            Context:

            http, server, location

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

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

fastcgi_cache_valid 5m;

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

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

fastcgi_cache_valid 200 302 10m;
fastcgi_cache_valid 301      1h;
fastcgi_cache_valid any      1m;

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 (1.7.7).
If the header includes the “Vary” field
with another value, such a response will be cached
taking into account the corresponding request header fields (1.7.7).

Processing of one or more of these response header fields can be disabled
using the fastcgi_ignore_headers directive.

            Syntax:

            fastcgi_catch_stderr string;

            Default:

            —

            Context:

            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 response.
This allows handling application errors in nginx, for example:

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

            Syntax:

            fastcgi_connect_timeout time;

            Default:

fastcgi_connect_timeout 60s;

            Context:

            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.

            Syntax:

            fastcgi_force_ranges on | off;

            Default:

fastcgi_force_ranges off;

            Context:

            http, server, location

This directive appeared in version 1.7.7.

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

            Syntax:

            fastcgi_hide_header field;

            Default:

            —

            Context:

            http, server, location

By default,
nginx 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 directive can be used.

            Syntax:

            fastcgi_ignore_client_abort on | off;

            Default:

fastcgi_ignore_client_abort off;

            Context:

            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.

            Syntax:

            fastcgi_ignore_headers field ...;

            Default:

            —

            Context:

            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” (1.1.6),
“X-Accel-Buffering” (1.1.6),
“X-Accel-Charset” (1.1.6), “Expires”,
“Cache-Control”, “Set-Cookie” (0.8.44),
and “Vary” (1.7.7).

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;

“X-Accel-Redirect” performs an
internal
redirect to the specified URI;

“X-Accel-Limit-Rate” sets the
rate
limit for transmission of a response to a client;

“X-Accel-Buffering” enables or disables
buffering of a response;

“X-Accel-Charset” sets the desired
charset
of a response.

            Syntax:

            fastcgi_index name;

            Default:

            —

            Context:

            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 variable.
For example, with these settings

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”.

            Syntax:

            fastcgi_intercept_errors on | off;

            Default:

fastcgi_intercept_errors off;

            Context:

            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 nginx for processing
with the error_page directive.

            Syntax:

            fastcgi_keep_conn on | off;

            Default:

fastcgi_keep_conn off;

            Context:

            http, server, location

This directive appeared in version 1.1.4.

By default, a FastCGI server will close a connection right after
sending the response.
However, when this directive is set to the value on,
nginx will instruct a FastCGI server to keep connections open.
This is necessary, in particular, for
keepalive
connections to FastCGI servers to function.

            Syntax:

            fastcgi_limit_rate rate;

            Default:

fastcgi_limit_rate 0;

            Context:

            http, server, location

This directive appeared in version 1.7.7.

Limits the speed of reading the response from the FastCGI server.
The rate is specified in bytes per second.
The zero value disables rate limiting.
The limit is set per a request, and so if nginx simultaneously opens
two connections to the FastCFI server,
the overall rate will be twice as much as the specified limit.
The limitation works only if
buffering of responses from the FastCGI
server is enabled.
Parameter value can contain variables (1.27.0).

            Syntax:

            fastcgi_max_temp_file_size size;

            Default:

fastcgi_max_temp_file_size 1024m;

            Context:

            http, server, location

When buffering of responses from the FastCGI
server is enabled, and the whole response does not fit into the buffers
set by the fastcgi_buffer_size and 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 directive.

The zero value disables buffering of responses to temporary files.

This restriction does not apply to responses
that will be cached
or stored on disk.

            Syntax:

            fastcgi_next_upstream
    error |
    timeout |
    denied |
    invalid_header |
    http_500 |
    http_503 |
    http_403 |
    http_404 |
    http_429 |
    non_idempotent |
    off
    ...;

            Default:

fastcgi_next_upstream error timeout;

            Context:

            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;

denied

the server denied
the connection (1.29.3);

This parameter is available as part of our
commercial subscription.

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 (1.11.13);

non_idempotent

normally, requests with a
non-idempotent
method
(POST, LOCK, PATCH)
are not passed to the next server
if a request has been sent to an upstream server (1.9.13);
enabling this option explicitly allows retrying such requests;

off

disables passing a request to the next server.

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 of communication with a server.
The cases of error, timeout,
denied and
invalid_header are always considered unsuccessful attempts,
even if they are not specified in the directive.
The cases of http_500, http_503,
and http_429 are
considered unsuccessful attempts only if they are specified in the directive.
The cases of http_403 and http_404
are never considered unsuccessful attempts.

Passing a request to the next server can be limited by
the number of tries
and by time.

            Syntax:

            fastcgi_next_upstream_timeout time;

            Default:

fastcgi_next_upstream_timeout 0;

            Context:

            http, server, location

This directive appeared in version 1.7.5.

Limits the time during which a request can be passed to the
next server.
The 0 value turns off this limitation.

            Syntax:

            fastcgi_next_upstream_tries number;

            Default:

fastcgi_next_upstream_tries 0;

            Context:

            http, server, location

This directive appeared in version 1.7.5.

Limits the number of possible tries for passing a request to the
next server.
The 0 value turns off this limitation.

            Syntax:

            fastcgi_no_cache string ...;

            Default:

            —

            Context:

            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:

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 directive.

            Syntax:

            fastcgi_param
    parameter value
    [if_not_empty];

            Default:

fastcgi_param HTTP_HOST $host$is_request_port$request_port;

            Context:

            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.

The following example shows the minimum required settings for PHP:

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:

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”:

fastcgi_param REDIRECT_STATUS 200;

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

fastcgi_param HTTPS           $https if_not_empty;

            Syntax:

            fastcgi_pass address;

            Default:

            —

            Context:

            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:

fastcgi_pass localhost:9000;

or as a UNIX-domain socket path:

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.

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.

            Syntax:

            fastcgi_pass_header field;

            Default:

            —

            Context:

            http, server, location

Permits passing otherwise disabled header
fields from a FastCGI server to a client.

            Syntax:

            fastcgi_pass_request_body on | off;

            Default:

fastcgi_pass_request_body on;

            Context:

            http, server, location

Indicates whether the original request body is passed
to the FastCGI server.
See also the fastcgi_pass_request_headers directive.

            Syntax:

            fastcgi_pass_request_headers on | off;

            Default:

fastcgi_pass_request_headers on;

            Context:

            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 directive.

            Syntax:

            fastcgi_read_timeout time;

            Default:

fastcgi_read_timeout 60s;

            Context:

            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.

            Syntax:

            fastcgi_request_buffering on | off;

            Default:

fastcgi_request_buffering on;

            Context:

            http, server, location

This directive appeared in version 1.7.11.

Enables or disables buffering of a client request body.

When buffering is enabled, the entire request body is
read
from the client before sending the request to a FastCGI server.

When buffering is disabled, 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
if nginx already started sending the request body.

            Syntax:

            fastcgi_request_dynamic on | off;

            Default:

fastcgi_request_dynamic off;

            Context:

            http, server, location

This directive appeared in version 1.29.3.

Enables or disables creation of a separate request instance
for each FastCGI server.
By default, a single request is used for all FastCGI servers.
If enabled, a separate request instance is created,
allowing per-server request customization.

This directive is available as part of our
commercial subscription.

            Syntax:

            fastcgi_send_lowat size;

            Default:

fastcgi_send_lowat 0;

            Context:

            http, server, location

If the directive is set to a non-zero value, nginx 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 method,
or the SO_SNDLOWAT socket option,
with the specified size.

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

            Syntax:

            fastcgi_send_timeout time;

            Default:

fastcgi_send_timeout 60s;

            Context:

            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.

            Syntax:

            fastcgi_socket_keepalive on | off;

            Default:

fastcgi_socket_keepalive off;

            Context:

            http, server, location

This directive appeared in version 1.15.6.

Configures the “TCP keepalive” behavior
for outgoing connections to a FastCGI server.
By default, the operating system’s settings are in effect for the socket.
If the directive is set to the value “on”, the
SO_KEEPALIVE socket option is turned on for the socket.

            Syntax:

            fastcgi_split_path_info regex;

            Default:

            —

            Context:

            location

Defines a regular expression that captures a value for the
$fastcgi_path_info variable.
The regular expression should have two captures: the first becomes
a value of the $fastcgi_script_name variable, the second
becomes a value of the $fastcgi_path_info variable.
For example, with these settings

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”.

            Syntax:

            fastcgi_store
    on |
    off |
    string;

            Default:

fastcgi_store off;

            Context:

            http, server, location

Enables saving of files to a disk.
The on parameter saves files with paths
corresponding to the directives
alias or
root.
The off parameter disables saving of files.
In addition, the file name can be set explicitly using the
string with variables:

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.
Starting from version 0.8.9, 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
directive, are put on the same file system.

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

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/;
}

            Syntax:

            fastcgi_store_access users:permissions ...;

            Default:

fastcgi_store_access user:rw;

            Context:

            http, server, location

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

fastcgi_store_access user:rw group:rw all:r;

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

fastcgi_store_access group:rw all:r;

            Syntax:

            fastcgi_temp_file_write_size size;

            Default:

fastcgi_temp_file_write_size 8k|16k;

            Context:

            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 and fastcgi_buffers directives.
The maximum size of a temporary file is set by the
fastcgi_max_temp_file_size directive.

            Syntax:

            fastcgi_temp_path
    path
    [level1
    [level2
    [level3]]];

            Default:

fastcgi_temp_path fastcgi_temp;

            Context:

            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 underneath the specified
directory.
For example, in the following configuration

fastcgi_temp_path /spool/nginx/fastcgi_temp 1 2;

a temporary file might look like this:

/spool/nginx/fastcgi_temp/7/45/00000123457

See also the use_temp_path parameter of the
fastcgi_cache_path directive.

Parameters Passed to a FastCGI Server

HTTP request header fields are passed to a FastCGI server as parameters.
In applications and scripts running as FastCGI servers,
these parameters are usually made available as environment variables.
For example, the “User-Agent” header field is passed as the
HTTP_USER_AGENT parameter.
In addition to HTTP request header fields, it is possible to pass arbitrary
parameters using the fastcgi_param directive.

Embedded Variables

The ngx_http_fastcgi_module module supports embedded
variables that can be used to set parameters using the
fastcgi_param directive:

$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 directive appended to it.
This variable can be used to set the
SCRIPT_FILENAME and PATH_TRANSLATED
parameters that determine the script name in PHP.
For example, for the “/info/” request with the
following directives

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 directive,
the $fastcgi_script_name variable equals the value of
the first capture set by the directive.

$fastcgi_path_info

the value of the second capture set by the
fastcgi_split_path_info directive.
This variable can be used to set the
PATH_INFO parameter.


<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>Module ngx_http_flv_module</title><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="stylesheet" href="../../../css/style_en.css">

Planning your ingress-nginx migration? Start here:
kubernetes.nginx.org.

<input class="side-menu" type="checkbox" id="side-menu">

english

русский

news

about

download

security

documentation

faq

books

community

enterprise

community forum (new)

x.com

blog

njs

ingress controller

gateway fabric

Module ngx_http_flv_module

Example Configuration
Directives
     flv

The ngx_http_flv_module module provides pseudo-streaming
server-side support for Flash Video (FLV) files.

It handles requests with the start argument in
the request URI’s query string specially, by sending back the contents
of a file starting from the requested byte offset and with the prepended FLV
header.

This module is not built by default, it should be enabled with the
--with-http_flv_module
configuration parameter.

Example Configuration

location ~ \.flv$ {
    flv;
}

Directives

            Syntax:

            flv;

            Default:

            —

            Context:

            location

Turns on module processing in a surrounding location.


<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>Module ngx_http_geoip_module</title><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="stylesheet" href="../../../css/style_en.css">

Planning your ingress-nginx migration? Start here:
kubernetes.nginx.org.

<input class="side-menu" type="checkbox" id="side-menu">

english

русский

news

about

download

security

documentation

faq

books

community

enterprise

community forum (new)

x.com

blog

njs

ingress controller

gateway fabric

Module ngx_http_geoip_module

Example Configuration
Directives
     geoip_country
     geoip_city
     geoip_org
     geoip_proxy
     geoip_proxy_recursive

The ngx_http_geoip_module module (0.8.6+) creates variables
with values depending on the client IP address, using the precompiled
MaxMind databases.

When using the databases with IPv6 support (1.3.12, 1.2.7),
IPv4 addresses are looked up as IPv4-mapped IPv6 addresses.

This module is not built by default, it should be enabled with the
--with-http_geoip_module
configuration parameter.

This module requires the
MaxMind GeoIP library.

Example Configuration

http {
    geoip_country         GeoIP.dat;
    geoip_city            GeoLiteCity.dat;
    geoip_proxy           192.168.100.0/24;
    geoip_proxy           2001:0db8::/32;
    geoip_proxy_recursive on;
    ...

Directives

            Syntax:

            geoip_country file;

            Default:

            —

            Context:

            http

Specifies a database used to determine the country
depending on the client IP address.
The following variables are available when using this database:

$geoip_country_code

two-letter country code, for example,
“RU”, “US”.

$geoip_country_code3

three-letter country code, for example,
“RUS”, “USA”.

$geoip_country_name

country name, for example,
“Russian Federation”, “United States”.

            Syntax:

            geoip_city file;

            Default:

            —

            Context:

            http

Specifies a database used to determine the country, region, and city
depending on the client IP address.
The following variables are available when using this database:

$geoip_area_code

telephone area code (US only).

This variable may contain outdated information since
the corresponding database field is deprecated.

$geoip_city_continent_code

two-letter continent code, for example,
“EU”, “NA”.

$geoip_city_country_code

two-letter country code, for example,
“RU”, “US”.

$geoip_city_country_code3

three-letter country code, for example,
“RUS”, “USA”.

$geoip_city_country_name

country name, for example,
“Russian Federation”, “United States”.

$geoip_dma_code

DMA region code in US (also known as “metro code”), according to the
geotargeting
in Google AdWords API.

$geoip_latitude

latitude.

$geoip_longitude

longitude.

$geoip_region

two-symbol country region code (region, territory, state, province, federal land
and the like), for example,
“48”, “DC”.

$geoip_region_name

country region name (region, territory, state, province, federal land
and the like), for example,
“Moscow City”, “District of Columbia”.

$geoip_city

city name, for example,
“Moscow”, “Washington”.

$geoip_postal_code

postal code.

            Syntax:

            geoip_org file;

            Default:

            —

            Context:

            http

This directive appeared in version 1.0.3.

Specifies a database used to determine the organization
depending on the client IP address.
The following variable is available when using this database:

$geoip_org

organization name, for example, “The University of Melbourne”.

            Syntax:

            geoip_proxy address | CIDR;

            Default:

            —

            Context:

            http

                    This directive appeared in versions 1.3.0 and 1.2.1.

Defines trusted addresses.
When a request comes from a trusted address,
an address from the “X-Forwarded-For” request
header field will be used instead.

            Syntax:

            geoip_proxy_recursive on | off;

            Default:

geoip_proxy_recursive off;

            Context:

            http

                    This directive appeared in versions 1.3.0 and 1.2.1.

If recursive search is disabled then instead of the original client
address that matches one of the trusted addresses, the last
address sent in “X-Forwarded-For” will be used.
If recursive search is enabled then instead of the original client
address that matches one of the trusted addresses, the last
non-trusted address sent in “X-Forwarded-For” will be used.


<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>Module ngx_http_geo_module</title><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="stylesheet" href="../../../css/style_en.css">

Planning your ingress-nginx migration? Start here:
kubernetes.nginx.org.

<input class="side-menu" type="checkbox" id="side-menu">

english

русский

news

about

download

security

documentation

faq

books

community

enterprise

community forum (new)

x.com

blog

njs

ingress controller

gateway fabric

Module ngx_http_geo_module

Example Configuration
Directives
     geo

The ngx_http_geo_module module creates variables
with values depending on the client IP address.

Example Configuration

geo $geo {
    default        0;

    127.0.0.1      2;
    192.168.1.0/24 1;
    10.1.0.0/16    1;

    ::1            2;
    2001:0db8::/32 1;
}

Directives

            Syntax:

            geo [$address] $variable { ... }

            Default:

            —

            Context:

            http

Describes the dependency of values of the specified variable
on the client IP address.
By default, the address is taken from the $remote_addr variable,
but it can also be taken from another variable (0.7.27), for example:

geo $arg_remote_addr $geo {
    ...;
}

Since variables are evaluated only when used, the mere existence
of even a large number of declared “geo” variables
does not cause any extra costs for request processing.

If the value of a variable does not represent a valid IP address
then the “255.255.255.255” address is used.

Addresses are specified either as prefixes in CIDR notation
(including individual addresses) or as ranges (0.7.23).

IPv6 prefixes are supported starting from versions 1.3.10 and 1.2.7.

The following special parameters are also supported:

delete

deletes the specified network (0.7.23).

default

a value set to the variable if the client address does not
match any of the specified addresses.
When addresses are specified in CIDR notation,
“0.0.0.0/0” and “::/0”
can be used instead of default.
When default is not specified, the default
value will be an empty string.

include

includes a file with addresses and values.
There can be several inclusions.

proxy

defines trusted addresses (0.8.7, 0.7.63).
When a request comes from a trusted address,
an address from the “X-Forwarded-For” request
header field will be used instead.
In contrast to the regular addresses, trusted addresses are
checked sequentially.

Trusted IPv6 addresses are supported starting from versions 1.3.0 and 1.2.1.

proxy_recursive

enables recursive address search (1.3.0, 1.2.1).
If recursive search is disabled then instead of the original client
address that matches one of the trusted addresses, the last
address sent in “X-Forwarded-For” will be used.
If recursive search is enabled then instead of the original client
address that matches one of the trusted addresses, the last
non-trusted address sent in “X-Forwarded-For” will be used.

ranges

indicates that addresses are specified as ranges (0.7.23).
This parameter should be the first.
To speed up loading of a geo base, addresses should be put in ascending order.

volatile

indicates that the variable is not cacheable (1.29.3).

Example:

geo $country {
    default        ZZ;
    include        conf/geo.conf;
    delete         127.0.0.0/16;
    proxy          192.168.100.0/24;
    proxy          2001:0db8::/32;

    127.0.0.0/24   US;
    127.0.0.1/32   RU;
    10.1.0.0/16    RU;
    192.168.1.0/24 UK;
}

The conf/geo.conf file could contain the following lines:

10.2.0.0/16    RU;
192.168.2.0/24 RU;

A value of the most specific match is used.
For example, for the 127.0.0.1 address the value “RU”
will be chosen, not “US”.

Example with ranges:

geo $country {
    ranges;
    default                   ZZ;
    127.0.0.0-127.0.0.0       US;
    127.0.0.1-127.0.0.1       RU;
    127.0.0.1-127.0.0.255     US;
    10.1.0.0-10.1.255.255     RU;
    192.168.1.0-192.168.1.255 UK;
}


<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>Module ngx_http_grpc_module</title><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="stylesheet" href="../../../css/style_en.css">

Planning your ingress-nginx migration? Start here:
kubernetes.nginx.org.

<input class="side-menu" type="checkbox" id="side-menu">

english

русский

news

about

download

security

documentation

faq

books

community

enterprise

community forum (new)

x.com

blog

njs

ingress controller

gateway fabric

Module ngx_http_grpc_module

Example Configuration
Directives
     grpc_allow_upstream
     grpc_bind
     grpc_bind_dynamic
     grpc_buffer_size
     grpc_connect_timeout
     grpc_hide_header
     grpc_ignore_headers
     grpc_intercept_errors
     grpc_next_upstream
     grpc_next_upstream_timeout
     grpc_next_upstream_tries
     grpc_pass
     grpc_pass_header
     grpc_read_timeout
     grpc_request_dynamic
     grpc_send_timeout
     grpc_set_header
     grpc_socket_keepalive
     grpc_ssl_certificate
     grpc_ssl_certificate_cache
     grpc_ssl_certificate_key
     grpc_ssl_ciphers
     grpc_ssl_conf_command
     grpc_ssl_crl
     grpc_ssl_key_log
     grpc_ssl_name
     grpc_ssl_password_file
     grpc_ssl_protocols
     grpc_ssl_server_name
     grpc_ssl_session_reuse
     grpc_ssl_trusted_certificate
     grpc_ssl_verify
     grpc_ssl_verify_depth

The ngx_http_grpc_module module allows passing requests
to a gRPC server (1.13.10).
The module requires the
ngx_http_v2_module module.

Example Configuration

server {
    listen 9000;

    http2 on;

    location / {
        grpc_pass 127.0.0.1:9000;
    }
}

Directives

            Syntax:

            grpc_allow_upstream address;

            Default:

            —

            Context:

            http, server, location

This directive appeared in version 1.29.3.

Defines conditions under which access to a gRPC server
is allowed or denied.
If all string parameters are not empty
and not equal to “0” then the access is allowed.
The conditions are evaluated each time
before a connection to a gRPC server is established.
Parameter values can contain variables:

geo $upstream_last_addr $allow {
    volatile;
    10.10.0.0/24        1;
}

server {
    listen 127.0.0.1:8080;
    http2 on;

    location / {
        grpc_pass           localhost:9000;
        grpc_allow_upstream $allow;
        ...
    }
}

This directive is available as part of our
commercial subscription.

            Syntax:

            grpc_bind
    address
    [transparent ] |
    off;

            Default:

            —

            Context:

            http, server, location

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

grpc_bind $remote_addr transparent;

In order for this parameter to work,
it is usually necessary to run nginx worker processes with the
superuser 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.
It is also necessary to configure kernel routing table
to intercept network traffic from the gRPC server.

            Syntax:

            grpc_bind_dynamic on | off;

            Default:

grpc_bind_dynamic off;

            Context:

            http, server, location

This directive appeared in version 1.29.3.

When enabled, makes the bind operation
at each connection attempt.

This directive is available as part of our
commercial subscription.

            Syntax:

            grpc_buffer_size size;

            Default:

grpc_buffer_size 4k|8k;

            Context:

            http, server, location

Sets the size of the buffer used for reading the response
received from the gRPC server.
The first part of the response usually contains a small header;
if it exceeds the buffer size, the response is considered
invalid.
The response is passed to the client synchronously, as soon as it is received.
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.

            Syntax:

            grpc_connect_timeout time;

            Default:

grpc_connect_timeout 60s;

            Context:

            http, server, location

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

            Syntax:

            grpc_hide_header field;

            Default:

            —

            Context:

            http, server, location

By default,
nginx does not pass the header fields “Date”,
“Server”, and
“X-Accel-...” from the response of a gRPC
server to a client.
The grpc_hide_header directive sets additional fields
that will not be passed.
If, on the contrary, the passing of fields needs to be permitted,
the grpc_pass_header directive can be used.

            Syntax:

            grpc_ignore_headers field ...;

            Default:

            —

            Context:

            http, server, location

Disables processing of certain response header fields from the gRPC server.
The following fields can be ignored: “X-Accel-Redirect”
and “X-Accel-Charset”.

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

“X-Accel-Redirect” performs an
internal
redirect to the specified URI;

“X-Accel-Charset” sets the desired
charset
of a response.

            Syntax:

            grpc_intercept_errors on | off;

            Default:

grpc_intercept_errors off;

            Context:

            http, server, location

Determines whether gRPC server responses with codes greater than or equal
to 300 should be passed to a client
or be intercepted and redirected to nginx for processing
with the error_page directive.

            Syntax:

            grpc_next_upstream
    error |
    timeout |
    denied |
    invalid_header |
    http_500 |
    http_502 |
    http_503 |
    http_504 |
    http_403 |
    http_404 |
    http_429 |
    non_idempotent |
    off
    ...;

            Default:

grpc_next_upstream error timeout;

            Context:

            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;

denied

the server denied
the connection (1.29.3);

This parameter is available as part of our
commercial subscription.

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
method
(POST, LOCK, PATCH)
are not passed to the next server
if a request has been sent to an upstream server;
enabling this option explicitly allows retrying such requests;

off

disables passing a request to the next server.

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 of communication with a server.
The cases of error, timeout,
denied and
invalid_header are always considered unsuccessful attempts,
even if they are not specified in the directive.
The cases of http_500, http_502,
http_503, http_504,
and http_429 are
considered unsuccessful attempts only if they are specified in the directive.
The cases of http_403 and http_404
are never considered unsuccessful attempts.

Passing a request to the next server can be limited by
the number of tries
and by time.

            Syntax:

            grpc_next_upstream_timeout time;

            Default:

grpc_next_upstream_timeout 0;

            Context:

            http, server, location

Limits the time during which a request can be passed to the
next server.
The 0 value turns off this limitation.

            Syntax:

            grpc_next_upstream_tries number;

            Default:

grpc_next_upstream_tries 0;

            Context:

            http, server, location

Limits the number of possible tries for passing a request to the
next server.
The 0 value turns off this limitation.

            Syntax:

            grpc_pass address;

            Default:

            —

            Context:

            location, if in location

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

grpc_pass localhost:9000;

or as a UNIX-domain socket path:

grpc_pass unix:/tmp/grpc.socket;

Alternatively, the “grpc://” scheme can be used:

grpc_pass grpc://127.0.0.1:9000;

To use gRPC over SSL, the “grpcs://” scheme should be used:

grpc_pass grpcs://127.0.0.1:443;

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.

Parameter value can contain variables (1.17.8).
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.

            Syntax:

            grpc_pass_header field;

            Default:

            —

            Context:

            http, server, location

Permits passing otherwise disabled header
fields from a gRPC server to a client.

            Syntax:

            grpc_read_timeout time;

            Default:

grpc_read_timeout 60s;

            Context:

            http, server, location

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

            Syntax:

            grpc_request_dynamic on | off;

            Default:

grpc_request_dynamic off;

            Context:

            http, server, location

This directive appeared in version 1.29.3.

Enables or disables creation of a separate request instance
for each gRPC server.
By default, a single request is used for all gRPC servers.
If enabled, a separate request instance is created,
allowing per-server request customization.
For example, the server-specific “Host” request header field
can be set:

grpc_request_dynamic on;
grpc_set_header      Host $upstream_last_server_name;

This directive is available as part of our
commercial subscription.

            Syntax:

            grpc_send_timeout time;

            Default:

grpc_send_timeout 60s;

            Context:

            http, server, location

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

            Syntax:

            grpc_set_header field value;

            Default:

grpc_set_header Content-Length $content_length;

            Context:

            http, server, location

Allows redefining or appending fields to the request header
passed to the gRPC 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 grpc_set_header directives
defined on the current level.

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

grpc_set_header Accept-Encoding "";

            Syntax:

            grpc_socket_keepalive on | off;

            Default:

grpc_socket_keepalive off;

            Context:

            http, server, location

This directive appeared in version 1.15.6.

Configures the “TCP keepalive” behavior
for outgoing connections to a gRPC server.
By default, the operating system’s settings are in effect for the socket.
If the directive is set to the value “on”, the
SO_KEEPALIVE socket option is turned on for the socket.

            Syntax:

            grpc_ssl_certificate file;

            Default:

            —

            Context:

            http, server, location

Specifies a file with the certificate in the PEM format
used for authentication to a gRPC SSL server.

Since version 1.21.0, variables can be used in the file name.

            Syntax:

            grpc_ssl_certificate_cache off;
grpc_ssl_certificate_cache
    max=N
    [inactive=time]
    [valid=time];

            Default:

grpc_ssl_certificate_cache off;

            Context:

            http, server, location

This directive appeared in version 1.27.4.

Defines a cache that stores
SSL certificates and
secret keys
specified with variables.

The directive has the following parameters:

max

sets the maximum number of elements in the cache;
on cache overflow the least recently used (LRU) elements are removed;

inactive

defines a time after which an element is removed from the cache
if it has not been accessed during this time;
by default, it is 10 seconds;

valid

defines a time during which
an element in the cache is considered valid
and can be reused;
by default, it is 60 seconds.
Certificates that exceed this time will be reloaded or revalidated;

off

disables the cache.

Example:

grpc_ssl_certificate       $grpc_ssl_server_name.crt;
grpc_ssl_certificate_key   $grpc_ssl_server_name.key;
grpc_ssl_certificate_cache max=1000 inactive=20s valid=1m;

            Syntax:

            grpc_ssl_certificate_key file;

            Default:

            —

            Context:

            http, server, location

Specifies a file with the secret key in the PEM format
used for authentication to a gRPC SSL 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 (1.29.0),
which is used to load a secret key with a specified id
and OpenSSL provider registered URI scheme, such as
pkcs11.

Since version 1.21.0, variables can be used in the file name.

            Syntax:

            grpc_ssl_ciphers ciphers;

            Default:

grpc_ssl_ciphers DEFAULT;

            Context:

            http, server, location

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

The full list can be viewed using the
“openssl ciphers” command.

            Syntax:

            grpc_ssl_conf_command name value;

            Default:

            —

            Context:

            http, server, location

This directive appeared in version 1.19.4.

Sets arbitrary OpenSSL configuration
commands
when establishing a connection with the gRPC SSL server.

The directive is supported when using OpenSSL 1.0.2 or higher.

Several grpc_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 grpc_ssl_conf_command directives
defined on the current level.

Note that configuring OpenSSL directly
might result in unexpected behavior.

            Syntax:

            grpc_ssl_crl file;

            Default:

            —

            Context:

            http, server, location

Specifies a file with revoked certificates (CRL)
in the PEM format used to verify
the certificate of the gRPC SSL server.
When using intermediate certificates, their CRLs should be
specified in the same file.

            Syntax:

            grpc_ssl_key_log path;

            Default:

            —

            Context:

            http, server, location

This directive appeared in version 1.27.2.

Enables logging of gRPC SSL server connection SSL keys
and specifies the path to the key log file.
Keys are logged in the
SSLKEYLOGFILE
format compatible with Wireshark.

This directive is available as part of our
commercial subscription.

            Syntax:

            grpc_ssl_name name;

            Default:

grpc_ssl_name host from grpc_pass;

            Context:

            http, server, location

Allows overriding the server name used to
verify
the certificate of the gRPC SSL server and to be
passed through SNI
when establishing a connection with the gRPC SSL server.

By default, the host part from grpc_pass is used.

            Syntax:

            grpc_ssl_password_file file;

            Default:

            —

            Context:

            http, server, location

Specifies a file with passphrases for
secret keys
where each passphrase is specified on a separate line.
Passphrases are tried in turn when loading the key.

            Syntax:

            grpc_ssl_protocols
    [SSLv2]
    [SSLv3]
    [TLSv1]
    [TLSv1.1]
    [TLSv1.2]
    [TLSv1.3];

            Default:

grpc_ssl_protocols TLSv1.2 TLSv1.3;

            Context:

            http, server, location

Enables the specified protocols for requests to a gRPC SSL server.

The TLSv1.3 parameter is used by default
since 1.23.4.

            Syntax:

            grpc_ssl_server_name on | off;

            Default:

grpc_ssl_server_name off;

            Context:

            http, server, location

Enables or disables passing of the server name through
TLS
Server Name Indication extension (SNI, RFC 6066)
when establishing a connection with the gRPC SSL server.

            Syntax:

            grpc_ssl_session_reuse on | off;

            Default:

grpc_ssl_session_reuse on;

            Context:

            http, server, location

Determines whether SSL sessions can be reused when working with
the gRPC server.
If the errors
“digest check failed”
appear in the logs, try disabling session reuse.

            Syntax:

            grpc_ssl_trusted_certificate file;

            Default:

            —

            Context:

            http, server, location

Specifies a file with trusted CA certificates in the PEM format
used to verify
the certificate of the gRPC SSL server.

            Syntax:

            grpc_ssl_verify on | off;

            Default:

grpc_ssl_verify off;

            Context:

            http, server, location

Enables or disables verification of the gRPC SSL server certificate.

            Syntax:

            grpc_ssl_verify_depth number;

            Default:

grpc_ssl_verify_depth 1;

            Context:

            http, server, location

Sets the verification depth in the gRPC SSL server certificates chain.


<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>Module ngx_http_gunzip_module</title><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="stylesheet" href="../../../css/style_en.css">

Planning your ingress-nginx migration? Start here:
kubernetes.nginx.org.

<input class="side-menu" type="checkbox" id="side-menu">

english

русский

news

about

download

security

documentation

faq

books

community

enterprise

community forum (new)

x.com

blog

njs

ingress controller

gateway fabric

Module ngx_http_gunzip_module

Example Configuration
Directives
     gunzip
     gunzip_buffers

The ngx_http_gunzip_module module is a filter that
decompresses responses with “Content-Encoding: gzip”
for clients that do not support “gzip” encoding method.
The module will be useful when it is desirable to store
data compressed to save space and reduce I/O costs.

This module is not built by default, it should be enabled with the
--with-http_gunzip_module
configuration parameter.

Example Configuration

location /storage/ {
    gunzip on;
    ...
}

Directives

            Syntax:

            gunzip on | off;

            Default:

gunzip off;

            Context:

            http, server, location

Enables or disables decompression of gzipped responses
for clients that lack gzip support.
If enabled, the following directives are also taken into account
when determining if clients support gzip:
gzip_http_version,
gzip_proxied, and
gzip_disable.
See also the gzip_vary directive.

            Syntax:

            gunzip_buffers number size;

            Default:

gunzip_buffers 32 4k|16 8k;

            Context:

            http, server, location

Sets the number and size of buffers
used to decompress a response.
By default, the buffer size is equal to one memory page.
This is either 4K or 8K, depending on a platform.


<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>Module ngx_http_gzip_module</title><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="stylesheet" href="../../../css/style_en.css">

Planning your ingress-nginx migration? Start here:
kubernetes.nginx.org.

<input class="side-menu" type="checkbox" id="side-menu">

english

русский

news

about

download

security

documentation

faq

books

community

enterprise

community forum (new)

x.com

blog

njs

ingress controller

gateway fabric

Module ngx_http_gzip_module

Example Configuration
Directives
     gzip
     gzip_buffers
     gzip_comp_level
     gzip_disable
     gzip_http_version
     gzip_min_length
     gzip_proxied
     gzip_types
     gzip_vary
Embedded Variables

The ngx_http_gzip_module module is a filter
that compresses responses using the “gzip” method.
This often helps to reduce the size of transmitted data by half or even more.

When using the SSL/TLS protocol, compressed responses may be subject to
BREACH attacks.

Example Configuration

gzip            on;
gzip_min_length 1000;
gzip_proxied    expired no-cache no-store private auth;
gzip_types      text/plain application/xml;

The $gzip_ratio variable can be used to log the
achieved compression ratio.

Directives

            Syntax:

            gzip on | off;

            Default:

gzip off;

            Context:

            http, server, location, if in location

Enables or disables gzipping of responses.

            Syntax:

            gzip_buffers number size;

            Default:

gzip_buffers 32 4k|16 8k;

            Context:

            http, server, location

Sets the number and size of buffers
used to compress a response.
By default, the buffer size is equal to one memory page.
This is either 4K or 8K, depending on a platform.

Until version 0.7.28, four 4K or 8K buffers were used by default.

            Syntax:

            gzip_comp_level level;

            Default:

gzip_comp_level 1;

            Context:

            http, server, location

Sets a gzip compression level of a response.
Acceptable values are in the range from 1 to 9.

            Syntax:

            gzip_disable regex ...;

            Default:

            —

            Context:

            http, server, location

This directive appeared in version 0.6.23.

Disables gzipping of responses for requests with
“User-Agent” header fields matching
any of the specified regular expressions.

The special mask “msie6” (0.7.12) corresponds to
the regular expression “MSIE [4-6]\.”, but works faster.
Starting from version 0.8.11, “MSIE 6.0; ... SV1”
is excluded from this mask.

            Syntax:

            gzip_http_version 1.0 | 1.1;

            Default:

gzip_http_version 1.1;

            Context:

            http, server, location

Sets the minimum HTTP version of a request required to compress a response.

            Syntax:

            gzip_min_length length;

            Default:

gzip_min_length 20;

            Context:

            http, server, location

Sets the minimum length of a response that will be gzipped.
The length is determined only from the “Content-Length”
response header field.

            Syntax:

            gzip_proxied
    off |
    expired |
    no-cache |
    no-store |
    private |
    no_last_modified |
    no_etag |
    auth |
    any
    ...;

            Default:

gzip_proxied off;

            Context:

            http, server, location

Enables or disables gzipping of responses for proxied
requests depending on the request and response.
The fact that the request is proxied is determined by
the presence of the “Via” request header field.
The directive accepts multiple parameters:

off

disables compression for all proxied requests,
ignoring other parameters;

expired

enables compression if a response header includes the
“Expires” field with a value that disables caching;

no-cache

enables compression if a response header includes the
“Cache-Control” field with the
“no-cache” parameter;

no-store

enables compression if a response header includes the
“Cache-Control” field with the
“no-store” parameter;

private

enables compression if a response header includes the
“Cache-Control” field with the
“private” parameter;

no_last_modified

enables compression if a response header does not include the
“Last-Modified” field;

no_etag

enables compression if a response header does not include the
“ETag” field;

auth

enables compression if a request header includes the
“Authorization” field;

any

enables compression for all proxied requests.

            Syntax:

            gzip_types mime-type ...;

            Default:

gzip_types text/html;

            Context:

            http, server, location

Enables gzipping of responses for the specified MIME types in addition
to “text/html”.
The special value “*” matches any MIME type (0.8.29).
Responses with the “text/html” type are always compressed.

            Syntax:

            gzip_vary on | off;

            Default:

gzip_vary off;

            Context:

            http, server, location

Enables or disables inserting the “Vary: Accept-Encoding”
response header field if the directives
gzip,
gzip_static, or
gunzip
are active.

Embedded Variables

$gzip_ratio

achieved compression ratio, computed as the ratio between the
original and compressed response sizes.


<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>Module ngx_http_gzip_static_module</title><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="stylesheet" href="../../../css/style_en.css">

Planning your ingress-nginx migration? Start here:
kubernetes.nginx.org.

<input class="side-menu" type="checkbox" id="side-menu">

english

русский

news

about

download

security

documentation

faq

books

community

enterprise

community forum (new)

x.com

blog

njs

ingress controller

gateway fabric

Module ngx_http_gzip_static_module

Example Configuration
Directives
     gzip_static

The ngx_http_gzip_static_module module allows
sending precompressed files with the “.gz”
filename extension instead of regular files.

This module is not built by default, it should be enabled with the
--with-http_gzip_static_module
configuration parameter.

Example Configuration

gzip_static  on;
gzip_proxied expired no-cache no-store private auth;

Directives

            Syntax:

            gzip_static
    on |
    off |
    always;

            Default:

gzip_static off;

            Context:

            http, server, location

Enables (“on”) or disables (“off”)
checking the existence of precompressed files.
The following directives are also taken into account:
gzip_http_version,
gzip_proxied,
gzip_disable,
and gzip_vary.

With the “always” value (1.3.6), gzipped file is used
in all cases, without checking if the client supports it.
It is useful if there are no uncompressed files on the disk anyway
or the ngx_http_gunzip_module
is used.

The files can be compressed using the gzip command,
or any other compatible one.
It is recommended that the modification date and time of original and
compressed files be the same.


<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>Module ngx_http_headers_module</title><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="stylesheet" href="../../../css/style_en.css">

Planning your ingress-nginx migration? Start here:
kubernetes.nginx.org.

<input class="side-menu" type="checkbox" id="side-menu">

english

русский

news

about

download

security

documentation

faq

books

community

enterprise

community forum (new)

x.com

blog

njs

ingress controller

gateway fabric

Module ngx_http_headers_module

Example Configuration
Directives
     add_header
     add_header_inherit
     add_trailer
     add_trailer_inherit
     expires

The ngx_http_headers_module module allows adding
the “Expires” and “Cache-Control” header
fields, and arbitrary fields, to a response header.

Example Configuration

expires    24h;
expires    modified +24h;
expires    @24h;
expires    0;
expires    -1;
expires    epoch;
expires    $expires;
add_header Cache-Control private;

Directives

            Syntax:

            add_header
name value
[always];

            Default:

            —

            Context:

            http, server, location, if in location

Adds the specified field to a response header provided that
the response code equals 200, 201 (1.3.10), 204, 206, 301, 302, 303, 304,
307 (1.1.16, 1.0.13), or 308 (1.13.0).
Parameter value can contain variables.

There could be several add_header directives.
These directives are inherited from the previous configuration level
if and only if there are no add_header directives
defined on the current level.
Inheritance rules can be redefined with the
add_header_inherit directive (1.29.3).

If the always parameter is specified (1.7.5),
the header field will be added regardless of the response code.

            Syntax:

            add_header_inherit
    on |
    off |
    merge;

            Default:

add_header_inherit on;

            Context:

            http, server, location, if in location

This directive appeared in version 1.29.3.

Allows altering inheritance rules for the values specified in the
add_header directives.
By default, the
standard inheritance model is used.

The merge parameter enables appending values
from the previous level to the values defined at the current level.

The off parameter cancels inheritance of the values
from the previous configuration level.

The inheritance rules themselves are inherited in a standard way.
For example, add_header_inherit merge;
specified at the top level will
be inherited in all nested levels recursively unless redefined later.

            Syntax:

            add_trailer
name value
[always];

            Default:

            —

            Context:

            http, server, location, if in location

This directive appeared in version 1.13.2.

Adds the specified field to the end of a response provided that
the response code equals 200, 201, 206, 301, 302, 303, 307, or 308.
Parameter value can contain variables.

There could be several add_trailer directives.
These directives are inherited from the previous configuration level
if and only if there are no add_trailer directives
defined on the current level.
Inheritance rules can be redefined with the
add_trailer_inherit directive (1.29.3).

If the always parameter is specified
the specified field will be added regardless of the response code.

            Syntax:

            add_trailer_inherit
    on |
    off |
    merge;

            Default:

add_trailer_inherit on;

            Context:

            http, server, location, if in location

This directive appeared in version 1.29.3.

Allows altering inheritance rules for the values specified in the
add_trailer directives.
By default, the
standard inheritance model is used.

The merge parameter enables appending values
from the previous level to the values defined at the current level.

The off parameter cancels inheritance of the values
from the previous configuration level.

The inheritance rules themselves are inherited in a standard way.
For example, add_trailer_inherit merge;
specified at the top level will
be inherited in all nested levels recursively unless redefined later.

            Syntax:

            expires [modified] time;
expires
    epoch |
    max |
    off;

            Default:

expires off;

            Context:

            http, server, location, if in location

Enables or disables adding or modifying the “Expires”
and “Cache-Control” response header fields provided that
the response code equals 200, 201 (1.3.10), 204, 206, 301, 302, 303, 304,
307 (1.1.16, 1.0.13), or 308 (1.13.0).
The parameter can be a positive or negative
time.

The time in the “Expires” field is computed as a sum of the
current time and time specified in the directive.
If the modified parameter is used (0.7.0, 0.6.32)
then the time is computed as a sum of the file’s modification time and
the time specified in the directive.

In addition, it is possible to specify a time of day using
the “@” prefix (0.7.9, 0.6.34):

expires @15h30m;

The contents of the “Cache-Control” field depends
on the sign of the specified time:

time is negative — “Cache-Control: no-cache”.

time is positive or zero —
“Cache-Control: max-age=t”,
where t is a time specified in the directive, in seconds.

The epoch parameter sets “Expires”
to the value “Thu, 01 Jan 1970 00:00:01 GMT”,
and “Cache-Control” to “no-cache”.

The max parameter sets “Expires”
to the value “Thu, 31 Dec 2037 23:55:55 GMT”,
and “Cache-Control” to 10 years.

The off parameter disables adding or modifying the
“Expires” and “Cache-Control” response
header fields.

The last parameter value can contain variables (1.7.9):

map $sent_http_content_type $expires {
    default         off;
    application/pdf 42d;
    ~image/         max;
}

expires $expires;


<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>Module ngx_http_hls_module</title><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="stylesheet" href="../../../css/style_en.css">

Planning your ingress-nginx migration? Start here:
kubernetes.nginx.org.

<input class="side-menu" type="checkbox" id="side-menu">

english

русский

news

about

download

security

documentation

faq

books

community

enterprise

community forum (new)

x.com

blog

njs

ingress controller

gateway fabric

Module ngx_http_hls_module

Example Configuration
Directives
     hls
     hls_buffers
     hls_forward_args
     hls_fragment
     hls_mp4_buffer_size
     hls_mp4_max_buffer_size

The ngx_http_hls_module module provides HTTP Live Streaming
(HLS) server-side support for MP4 and MOV media files.
Such files typically have the .mp4, .m4v,
.m4a, .mov, or .qt filename extensions.
The module supports H.264 video codec, AAC and MP3 audio codecs.

For each media file, two URIs are supported:

A playlist URI with the “.m3u8” filename extension.
The URI can accept optional arguments:

“start” and “end”
define playlist boundaries in seconds (1.9.0).

“offset” shifts an initial playback position
to the time offset in seconds (1.9.0).
A positive value sets a time offset from the beginning of the playlist.
A negative value sets a time offset
from the end of the last fragment in the playlist.

“len” defines the fragment length in seconds.

A fragment URI with the “.ts” filename extension.
The URI can accept optional arguments:

“start” and “end”
define fragment boundaries in seconds.

This module is available as part of our
commercial subscription.

Example Configuration

location / {
    hls;
    hls_fragment            5s;
    hls_buffers             10 10m;
    hls_mp4_buffer_size     1m;
    hls_mp4_max_buffer_size 5m;
    root /var/video/;
}

With this configuration, the following URIs are supported for
the “/var/video/test.mp4” file:

http://hls.example.com/test.mp4.m3u8?offset=1.000&start=1.000&end=2.200
http://hls.example.com/test.mp4.m3u8?len=8.000
http://hls.example.com/test.mp4.ts?start=1.000&end=2.200

Directives

            Syntax:

            hls;

            Default:

            —

            Context:

            location

Turns on HLS streaming in the surrounding location.

            Syntax:

            hls_buffers number size;

            Default:

hls_buffers 8 2m;

            Context:

            http, server, location

Sets the maximum number and size of buffers
that are used for reading and writing data frames.

            Syntax:

            hls_forward_args on | off;

            Default:

hls_forward_args off;

            Context:

            http, server, location

This directive appeared in version 1.5.12.

Adds arguments from a playlist request to URIs of fragments.
This may be useful for performing client authorization at the moment of
requesting a fragment, or when protecting an HLS stream with the
ngx_http_secure_link_module
module.

For example, if a client requests a playlist
http://example.com/hls/test.mp4.m3u8?a=1&b=2,
the arguments a=1 and b=2
will be added to URIs of fragments after the arguments
start and end:

#EXTM3U
#EXT-X-VERSION:3
#EXT-X-TARGETDURATION:15
#EXT-X-PLAYLIST-TYPE:VOD

#EXTINF:9.333,
test.mp4.ts?start=0.000&end=9.333&a=1&b=2
#EXTINF:7.167,
test.mp4.ts?start=9.333&end=16.500&a=1&b=2
#EXTINF:5.416,
test.mp4.ts?start=16.500&end=21.916&a=1&b=2
#EXTINF:5.500,
test.mp4.ts?start=21.916&end=27.416&a=1&b=2
#EXTINF:15.167,
test.mp4.ts?start=27.416&end=42.583&a=1&b=2
#EXTINF:9.626,
test.mp4.ts?start=42.583&end=52.209&a=1&b=2

#EXT-X-ENDLIST

If an HLS stream is protected with the
ngx_http_secure_link_module
module, $uri should not be used in the
secure_link_md5
expression because this will cause errors when requesting the fragments.
Base URI should be used
instead of $uri
($hls_uri in the example):

http {
    ...

    map $uri $hls_uri {
        ~^(?<base_uri>.*).m3u8$ $base_uri;
        ~^(?<base_uri>.*).ts$   $base_uri;
        default                 $uri;
    }

    server {
        ...

        location /hls/ {
            hls;
            hls_forward_args on;

            alias /var/videos/;

            secure_link $arg_md5,$arg_expires;
            secure_link_md5 "$secure_link_expires$hls_uri$remote_addr secret";

            if ($secure_link = "") {
                return 403;
            }

            if ($secure_link = "0") {
                return 410;
            }
        }
    }
}

            Syntax:

            hls_fragment time;

            Default:

hls_fragment 5s;

            Context:

            http, server, location

Defines the default fragment length for playlist URIs requested without the
“len” argument.

            Syntax:

            hls_mp4_buffer_size size;

            Default:

hls_mp4_buffer_size 512k;

            Context:

            http, server, location

Sets the initial size of the buffer used for
processing MP4 and MOV files.

            Syntax:

            hls_mp4_max_buffer_size size;

            Default:

hls_mp4_max_buffer_size 10m;

            Context:

            http, server, location

During metadata processing, a larger buffer may become necessary.
Its size cannot exceed the specified size,
or else nginx will return the server error
500 (Internal Server Error),
and log the following message:

"/some/movie/file.mp4" mp4 moov atom is too large:
12583268, you may want to increase hls_mp4_max_buffer_size


<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>Module ngx_http_image_filter_module</title><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="stylesheet" href="../../../css/style_en.css">

Planning your ingress-nginx migration? Start here:
kubernetes.nginx.org.

<input class="side-menu" type="checkbox" id="side-menu">

english

русский

news

about

download

security

documentation

faq

books

community

enterprise

community forum (new)

x.com

blog

njs

ingress controller

gateway fabric

Module ngx_http_image_filter_module

Example Configuration
Directives
     image_filter
     image_filter_buffer
     image_filter_interlace
     image_filter_jpeg_quality
     image_filter_sharpen
     image_filter_transparency
     image_filter_webp_quality

The ngx_http_image_filter_module module (0.7.54+) is a filter
that transforms images in JPEG, GIF, PNG, and WebP formats.

This module is not built by default, it should be enabled with the
--with-http_image_filter_module
configuration parameter.

This module utilizes the
libgd library.
It is recommended to use the latest available version of the library.

The WebP format support appeared in version 1.11.6.
To transform images in this format,
the libgd library must be compiled with the WebP support.

Example Configuration

location /img/ {
    proxy_pass   http://backend;
    image_filter resize 150 100;
    image_filter rotate 90;
    error_page   415 = /empty;
}

location = /empty {
    empty_gif;
}

Directives

            Syntax:

            image_filter off;
image_filter test;
image_filter size;
image_filter
    rotate
    90 | 180 |
    270;
image_filter
    resize
    width
    height;
image_filter
    crop
    width
    height;

            Default:

image_filter off;

            Context:

            location

Sets the type of transformation to perform on images:

off

turns off module processing in a surrounding location.

test

ensures that responses are images in either JPEG, GIF, PNG, or WebP format.
Otherwise, the
415 (Unsupported Media Type)
error is returned.

size

outputs information about images in a JSON format, e.g.:

{ "img" : { "width": 100, "height": 100, "type": "gif" } }

In case of an error, the output is as follows:

{}

rotate
90|180|270

rotates images counter-clockwise by the specified number of degrees.
Parameter value can contain variables.
This mode can be used either alone or along with the
resize and crop transformations.

resize
width
height

proportionally reduces an image to the specified sizes.
To reduce by only one dimension, another dimension can be specified as
“-”.
In case of an error, the server will return code
415 (Unsupported Media Type).
Parameter values can contain variables.
When used along with the rotate parameter,
the rotation happens after reduction.

crop
width
height

proportionally reduces an image to the larger side size
and crops extraneous edges by another side.
To reduce by only one dimension, another dimension can be specified as
“-”.
In case of an error, the server will return code
415 (Unsupported Media Type).
Parameter values can contain variables.
When used along with the rotate parameter,
the rotation happens before reduction.

            Syntax:

            image_filter_buffer size;

            Default:

image_filter_buffer 1M;

            Context:

            http, server, location

Sets the maximum size of the buffer used for reading images.
When the size is exceeded the server returns error
415 (Unsupported Media Type).

            Syntax:

            image_filter_interlace on | off;

            Default:

image_filter_interlace off;

            Context:

            http, server, location

This directive appeared in version 1.3.15.

If enabled, final images will be interlaced.
For JPEG, final images will be in “progressive JPEG” format.

            Syntax:

            image_filter_jpeg_quality quality;

            Default:

image_filter_jpeg_quality 75;

            Context:

            http, server, location

Sets the desired quality of the transformed JPEG images.
Acceptable values are in the range from 1 to 100.
Lesser values usually imply both lower image quality and less data to transfer.
The maximum recommended value is 95.
Parameter value can contain variables.

            Syntax:

            image_filter_sharpen percent;

            Default:

image_filter_sharpen 0;

            Context:

            http, server, location

Increases sharpness of the final image.
The sharpness percentage can exceed 100.
The zero value disables sharpening.
Parameter value can contain variables.

            Syntax:

            image_filter_transparency on|off;

            Default:

image_filter_transparency on;

            Context:

            http, server, location

Defines whether transparency should be preserved when transforming
GIF images or PNG images with colors specified by a palette.
The loss of transparency results in images of a better quality.
The alpha channel transparency in PNG is always preserved.

            Syntax:

            image_filter_webp_quality quality;

            Default:

image_filter_webp_quality 80;

            Context:

            http, server, location

This directive appeared in version 1.11.6.

Sets the desired quality of the transformed WebP images.
Acceptable values are in the range from 1 to 100.
Lesser values usually imply both lower image quality and less data to transfer.
Parameter value can contain variables.