“?” if a request line has arguments,\nor an empty string otherwise
“:” if\n$request_port is non-empty,\nor an empty string otherwise (1.29.3)
request method, usually\n“GET” or “POST”
in this order of precedence:\nport number from the\nURI\nauthority component, or\nport number from the “Host” request header field (1.29.3)
\n" + }, { "name": "$request_time", "description_md": "request processing time in seconds with a milliseconds resolution\n(1.3.9, 1.2.6);\ntime elapsed since the first bytes were read from the client", @@ -3724,8 +3734,8 @@ "[$address] $variable {...}
Describes the dependency of values of the specified variable\non the client IP address.\nBy default, the address is taken from the $remote_addr variable,\nbut it can also be taken from another variable (0.7.27), for example:
geo $arg_remote_addr $geo {\n ...;\n}\n\n\n\nSince variables are evaluated only when used, the mere existence\nof even a large number of declared “
\ngeo” variables\ndoes not cause any extra costs for request processing.
If the value of a variable does not represent a valid IP address\nthen the “255.255.255.255” address is used.
Addresses are specified either as prefixes in CIDR notation\n(including individual addresses) or as ranges (0.7.23).
\n\n\n\n\nIPv6 prefixes are supported starting from versions 1.3.10 and 1.2.7.
\n
The following special parameters are also supported:
\n\ndelete
deletes the specified network (0.7.23).
default
a value set to the variable if the client address does not\nmatch any of the specified addresses.\nWhen addresses are specified in CIDR notation,\n“0.0.0.0/0” and “::/0”\ncan be used instead of default.\nWhen default is not specified, the default\nvalue will be an empty string.
include
includes a file with addresses and values.\nThere can be several inclusions.
proxy
defines trusted addresses (0.8.7, 0.7.63).\nWhen a request comes from a trusted address,\nan address from the “X-Forwarded-For” request\nheader field will be used instead.\nIn contrast to the regular addresses, trusted addresses are\nchecked sequentially.
\n\n\n\nTrusted IPv6 addresses are supported starting from versions 1.3.0 and 1.2.1.
\n
proxy_recursive
enables recursive address search (1.3.0, 1.2.1).\nIf recursive search is disabled then instead of the original client\naddress that matches one of the trusted addresses, the last\naddress sent in “X-Forwarded-For” will be used.\nIf recursive search is enabled then instead of the original client\naddress that matches one of the trusted addresses, the last\nnon-trusted address sent in “X-Forwarded-For” will be used.
ranges
indicates that addresses are specified as ranges (0.7.23).\nThis parameter should be the first.\nTo speed up loading of a geo base, addresses should be put in ascending order.
Example:
\n\ngeo $country {\n default ZZ;\n include conf/geo.conf;\n delete 127.0.0.0/16;\n proxy 192.168.100.0/24;\n proxy 2001:0db8::/32;\n\n 127.0.0.0/24 US;\n 127.0.0.1/32 RU;\n 10.1.0.0/16 RU;\n 192.168.1.0/24 UK;\n}\nThe conf/geo.conf file could contain the following lines:
10.2.0.0/16 RU;\n192.168.2.0/24 RU;\nA value of the most specific match is used.\nFor example, for the 127.0.0.1 address the value “RU”\nwill be chosen, not “US”.
Example with ranges:
\n\ngeo $country {\n ranges;\n default ZZ;\n 127.0.0.0-127.0.0.0 US;\n 127.0.0.1-127.0.0.1 RU;\n 127.0.0.1-127.0.0.255 US;\n 10.1.0.0-10.1.255.255 RU;\n 192.168.1.0-192.168.1.255 UK;\n}\nDescribes the dependency of values of the specified variable\non the client IP address.\nBy default, the address is taken from the $remote_addr variable,\nbut it can also be taken from another variable (0.7.27), for example:
geo $arg_remote_addr $geo {\n ...;\n}\n\n\n\nSince variables are evaluated only when used, the mere existence\nof even a large number of declared “
\ngeo” variables\ndoes not cause any extra costs for request processing.
If the value of a variable does not represent a valid IP address\nthen the “255.255.255.255” address is used.
Addresses are specified either as prefixes in CIDR notation\n(including individual addresses) or as ranges (0.7.23).
\n\n\n\n\nIPv6 prefixes are supported starting from versions 1.3.10 and 1.2.7.
\n
The following special parameters are also supported:
\n\ndelete
deletes the specified network (0.7.23).
default
a value set to the variable if the client address does not\nmatch any of the specified addresses.\nWhen addresses are specified in CIDR notation,\n“0.0.0.0/0” and “::/0”\ncan be used instead of default.\nWhen default is not specified, the default\nvalue will be an empty string.
include
includes a file with addresses and values.\nThere can be several inclusions.
proxy
defines trusted addresses (0.8.7, 0.7.63).\nWhen a request comes from a trusted address,\nan address from the “X-Forwarded-For” request\nheader field will be used instead.\nIn contrast to the regular addresses, trusted addresses are\nchecked sequentially.
\n\n\n\nTrusted IPv6 addresses are supported starting from versions 1.3.0 and 1.2.1.
\n
proxy_recursive
enables recursive address search (1.3.0, 1.2.1).\nIf recursive search is disabled then instead of the original client\naddress that matches one of the trusted addresses, the last\naddress sent in “X-Forwarded-For” will be used.\nIf recursive search is enabled then instead of the original client\naddress that matches one of the trusted addresses, the last\nnon-trusted address sent in “X-Forwarded-For” will be used.
ranges
indicates that addresses are specified as ranges (0.7.23).\nThis parameter should be the first.\nTo 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:
\n\ngeo $country {\n default ZZ;\n include conf/geo.conf;\n delete 127.0.0.0/16;\n proxy 192.168.100.0/24;\n proxy 2001:0db8::/32;\n\n 127.0.0.0/24 US;\n 127.0.0.1/32 RU;\n 10.1.0.0/16 RU;\n 192.168.1.0/24 UK;\n}\nThe conf/geo.conf file could contain the following lines:
10.2.0.0/16 RU;\n192.168.2.0/24 RU;\nA value of the most specific match is used.\nFor example, for the 127.0.0.1 address the value “RU”\nwill be chosen, not “US”.
Example with ranges:
\n\ngeo $country {\n ranges;\n default ZZ;\n 127.0.0.0-127.0.0.0 US;\n 127.0.0.1-127.0.0.1 RU;\n 127.0.0.1-127.0.0.255 US;\n 10.1.0.0-10.1.255.255 RU;\n 192.168.1.0-192.168.1.255 UK;\n}\nname value [always]
Adds the specified field to a response header provided that\nthe response code equals 200, 201 (1.3.10), 204, 206, 301, 302, 303, 304,\n307 (1.1.16, 1.0.13), or 308 (1.13.0).\nParameter value can contain variables.
\n\nThere could be several add_header directives.\nThese directives are inherited from the previous configuration level\nif and only if there are no add_header directives\ndefined on the current level.
If the always parameter is specified (1.7.5),\nthe header field will be added regardless of the response code.
Adds the specified field to a response header provided that\nthe response code equals 200, 201 (1.3.10), 204, 206, 301, 302, 303, 304,\n307 (1.1.16, 1.0.13), or 308 (1.13.0).\nParameter value can contain variables.
\n\nThere could be several add_header directives.\nThese directives are inherited from the previous configuration level\nif and only if there are no add_header directives\ndefined on the current level.\nInheritance rules can be redefined with the\nadd_header_inherit directive (1.29.3).
If the always parameter is specified (1.7.5),\nthe header field will be added regardless of the response code.
on | off | merge
Allows altering inheritance rules for the values specified in the\nadd_header directives.\nBy default, the\nstandard inheritance model is used.
The merge parameter enables appending values\nfrom the previous level to the values defined at the current level.
The off parameter cancels inheritance of the values\nfrom the previous configuration level.
The inheritance rules themselves are inherited in a standard way.\nFor example, add_header_inherit merge;\nspecified at the top level will\nbe inherited in all nested levels recursively unless redefined later.
name value [always]
Adds the specified field to the end of a response provided that\nthe response code equals 200, 201, 206, 301, 302, 303, 307, or 308.\nParameter value can contain variables.
\n\nThere could be several add_trailer directives.\nThese directives are inherited from the previous configuration level\nif and only if there are no add_trailer directives\ndefined on the current level.
If the always parameter is specified\nthe specified field will be added regardless of the response code.
Adds the specified field to the end of a response provided that\nthe response code equals 200, 201, 206, 301, 302, 303, 307, or 308.\nParameter value can contain variables.
\n\nThere could be several add_trailer directives.\nThese directives are inherited from the previous configuration level\nif and only if there are no add_trailer directives\ndefined on the current level.\nInheritance rules can be redefined with the\nadd_trailer_inherit directive (1.29.3).
If the always parameter is specified\nthe specified field will be added regardless of the response code.
on | off | merge
Allows altering inheritance rules for the values specified in the\nadd_trailer directives.\nBy default, the\nstandard inheritance model is used.
The merge parameter enables appending values\nfrom the previous level to the values defined at the current level.
The off parameter cancels inheritance of the values\nfrom the previous configuration level.
The inheritance rules themselves are inherited in a standard way.\nFor example, add_trailer_inherit merge;\nspecified at the top level will\nbe inherited in all nested levels recursively unless redefined later.
Sets the verification depth in the HTTPS server certificates chain\nwith Fetch API.
\n" }, + { + "name": "js_fetch_proxy", + "default": "", + "contexts": [ + "http", + "server", + "location" + ], + "syntax_md": [ + "*`url`*" + ], + "syntax_html": [ + "url
Configures a forward proxy URL\nwith Fetch API.\nThe url supports the HTTP scheme only\nand can contain optional user credentials\nin the format http://[user:password@]host:port\nfor Basic authentication.\nSupports both HTTP and HTTPS connections to destination servers.\nIf the url is empty, proxy routing is disabled.\nThe parameter value can contain variables.
Example:
\n\nlocation /fetch {\n js_fetch_proxy http://user:pass@proxy.example.com:3128;\n js_content main.fetch_handler;\n}\nreturns the serial number of the client certificate\nfor an established SSL connection;
\n" }, + { + "name": "$ssl_client_sigalg", + "description_md": "returns the\n[signature algorithm](https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-16)\nfor the client certificate for an established SSL connection (1.29.3).", + "description_html": "returns the\nsignature algorithm\nfor the client certificate for an established SSL connection (1.29.3).
\n" + }, { "name": "$ssl_client_v_end", "description_md": "returns the end date of the client certificate (1.11.7);", @@ -9964,6 +10035,11 @@ "name": "$ssl_session_reused", "description_md": "returns “`r`” if an SSL session was reused,\nor “`.`” otherwise (1.5.11).", "description_html": "returns “r” if an SSL session was reused,\nor “.” otherwise (1.5.11).
returns the\nsignature algorithm\nfor the server certificate for an established SSL connection (1.29.3).
\n" } ] }, @@ -14591,8 +14667,8 @@ "[$address] $variable {...}
Describes the dependency of values of the specified variable\non the client IP address.\nBy default, the address is taken from the $remote_addr variable,\nbut it can also be taken from another variable, for example:
geo $arg_remote_addr $geo {\n ...;\n}\n\n\n\nSince variables are evaluated only when used, the mere existence\nof even a large number of declared “
\ngeo” variables\ndoes not cause any extra costs for connection processing.
If the value of a variable does not represent a valid IP address\nthen the “255.255.255.255” address is used.
Addresses are specified either as prefixes in CIDR notation\n(including individual addresses) or as ranges.
\n\nThe following special parameters are also supported:
\n\ndelete
deletes the specified network.
default
a value set to the variable if the client address does not\nmatch any of the specified addresses.\nWhen addresses are specified in CIDR notation,\n“0.0.0.0/0” and “::/0”\ncan be used instead of default.\nWhen default is not specified, the default\nvalue will be an empty string.
include
includes a file with addresses and values.\nThere can be several inclusions.
ranges
indicates that addresses are specified as ranges.\nThis parameter should be the first.\nTo speed up loading of a geo base, addresses should be put in ascending order.
Example:
\n\ngeo $country {\n default ZZ;\n include conf/geo.conf;\n delete 127.0.0.0/16;\n\n 127.0.0.0/24 US;\n 127.0.0.1/32 RU;\n 10.1.0.0/16 RU;\n 192.168.1.0/24 UK;\n}\nThe conf/geo.conf file could contain the following lines:
10.2.0.0/16 RU;\n192.168.2.0/24 RU;\nA value of the most specific match is used.\nFor example, for the 127.0.0.1 address the value “RU”\nwill be chosen, not “US”.
Example with ranges:
\n\ngeo $country {\n ranges;\n default ZZ;\n 127.0.0.0-127.0.0.0 US;\n 127.0.0.1-127.0.0.1 RU;\n 127.0.0.1-127.0.0.255 US;\n 10.1.0.0-10.1.255.255 RU;\n 192.168.1.0-192.168.1.255 UK;\n}\nDescribes the dependency of values of the specified variable\non the client IP address.\nBy default, the address is taken from the $remote_addr variable,\nbut it can also be taken from another variable, for example:
geo $arg_remote_addr $geo {\n ...;\n}\n\n\n\nSince variables are evaluated only when used, the mere existence\nof even a large number of declared “
\ngeo” variables\ndoes not cause any extra costs for connection processing.
If the value of a variable does not represent a valid IP address\nthen the “255.255.255.255” address is used.
Addresses are specified either as prefixes in CIDR notation\n(including individual addresses) or as ranges.
\n\nThe following special parameters are also supported:
\n\ndelete
deletes the specified network.
default
a value set to the variable if the client address does not\nmatch any of the specified addresses.\nWhen addresses are specified in CIDR notation,\n“0.0.0.0/0” and “::/0”\ncan be used instead of default.\nWhen default is not specified, the default\nvalue will be an empty string.
include
includes a file with addresses and values.\nThere can be several inclusions.
ranges
indicates that addresses are specified as ranges.\nThis parameter should be the first.\nTo 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:
\n\ngeo $country {\n default ZZ;\n include conf/geo.conf;\n delete 127.0.0.0/16;\n\n 127.0.0.0/24 US;\n 127.0.0.1/32 RU;\n 10.1.0.0/16 RU;\n 192.168.1.0/24 UK;\n}\nThe conf/geo.conf file could contain the following lines:
10.2.0.0/16 RU;\n192.168.2.0/24 RU;\nA value of the most specific match is used.\nFor example, for the 127.0.0.1 address the value “RU”\nwill be chosen, not “US”.
Example with ranges:
\n\ngeo $country {\n ranges;\n default ZZ;\n 127.0.0.0-127.0.0.0 US;\n 127.0.0.1-127.0.0.1 RU;\n 127.0.0.1-127.0.0.255 US;\n 10.1.0.0-10.1.255.255 RU;\n 192.168.1.0-192.168.1.255 UK;\n}\nSets the verification depth in the HTTPS server certificates chain\nwith Fetch API.
\n" }, + { + "name": "js_fetch_proxy", + "default": "", + "contexts": [ + "stream", + "server" + ], + "syntax_md": [ + "*`url`*" + ], + "syntax_html": [ + "url
Configures a forward proxy URL\nwith Fetch API.\nThe url supports the HTTP scheme only\nand can contain optional user credentials\nin the format http://[user:password@]host:port\nfor Basic authentication.\nSupports both HTTP and HTTPS connections to destination servers.\nIf the url is empty, proxy routing is disabled.\nThe parameter value can contain variables.
Example:
\n\nserver {\n listen 12345;\n js_fetch_proxy http://user:pass@proxy.example.com:3128;\n js_preread main.fetch_handler;\n}\nreturns the serial number of the client certificate\nfor an established SSL connection (1.11.8);
\n" }, + { + "name": "$ssl_client_sigalg", + "description_md": "returns the\n[signature algorithm](https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-16)\nfor the client certificate for an established SSL connection (1.29.3).", + "description_html": "returns the\nsignature algorithm\nfor the client certificate for an established SSL connection (1.29.3).
\n" + }, { "name": "$ssl_client_v_end", "description_md": "returns the end date of the client certificate (1.11.8);", @@ -16720,6 +16818,11 @@ "name": "$ssl_session_reused", "description_md": "returns “`r`” if an SSL session was reused,\nor “`.`” otherwise.", "description_html": "returns “r” if an SSL session was reused,\nor “.” otherwise.
returns the\nsignature algorithm\nfor the server certificate for an established SSL connection (1.29.3).
\n" } ] }, @@ -17378,5 +17481,5 @@ ] } ], - "version": "https://github.com/nginx/nginx.org/commit/a42f51d66b765d47e9048b9d9646aaf1084a2b09" + "version": "https://github.com/nginx/nginx.org/commit/ea784af4d7792b9117e29e257c2a325cc8265fe5" }