Skip to content

Commit f4a84d8

Browse files
y82y82
committed
Updated docs for the upcoming NGINX Plus release.
1 parent 2a1517c commit f4a84d8

23 files changed

+1618
-12
lines changed

‎xml/en/GNUmakefile‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ REFS = \
7474
http/ngx_http_memcached_module \
7575
http/ngx_http_mirror_module \
7676
http/ngx_http_mp4_module \
77+
http/ngx_http_num_map_module \
7778
http/ngx_http_oidc_module \
7879
http/ngx_http_perl_module \
7980
http/ngx_http_proxy_module \
@@ -93,6 +94,7 @@ REFS = \
9394
http/ngx_http_status_module \
9495
http/ngx_http_stub_status_module \
9596
http/ngx_http_sub_module \
97+
http/ngx_http_tunnel_module \
9698
http/ngx_http_upstream_module \
9799
http/ngx_http_upstream_conf_module \
98100
http/ngx_http_upstream_hc_module \
@@ -121,6 +123,7 @@ REFS = \
121123
stream/ngx_stream_map_module \
122124
stream/ngx_stream_mqtt_filter_module \
123125
stream/ngx_stream_mqtt_preread_module \
126+
stream/ngx_stream_num_map_module \
124127
stream/ngx_stream_pass_module \
125128
stream/ngx_stream_proxy_module \
126129
stream/ngx_stream_proxy_protocol_vendor_module \

‎xml/en/docs/http/ngx_http_fastcgi_module.xml‎

Lines changed: 91 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,50 @@ location / {
4444

4545
<section id="directives" name="Directives">
4646

47+
<directive name="fastcgi_allow_upstream">
48+
<syntax><value>string</value> ...</syntax>
49+
<default/>
50+
<context>http</context>
51+
<context>server</context>
52+
<context>location</context>
53+
<appeared-in>1.29.3</appeared-in>
54+
55+
<para>
56+
Defines conditions under which access to a FastCGI server
57+
is allowed or <link id="denied">denied</link>.
58+
If all string parameters are not empty
59+
and not equal to “0” then the access is allowed.
60+
The conditions are evaluated each time
61+
before a connection to a FastCGI server is established.
62+
Parameter values can contain variables:
63+
<example>
64+
geo $upstream_last_addr $allow {
65+
volatile;
66+
10.10.0.0/24 1;
67+
}
68+
69+
server {
70+
listen 127.0.0.1:8080;
71+
72+
location / {
73+
fastcgi_pass localhost:9000;
74+
fastcgi_allow_upstream $allow;
75+
...
76+
}
77+
}
78+
</example>
79+
</para>
80+
81+
<para>
82+
<note>
83+
This directive is available as part of our
84+
<commercial_version>commercial subscription</commercial_version>.
85+
</note>
86+
</para>
87+
88+
</directive>
89+
90+
4791
<directive name="fastcgi_bind">
4892
<syntax>
4993
<value>address</value>
@@ -1053,6 +1097,7 @@ or <link id="fastcgi_store">stored</link> on disk.
10531097
<syntax>
10541098
<literal>error</literal> |
10551099
<literal>timeout</literal> |
1100+
<literal>denied</literal> |
10561101
<literal>invalid_header</literal> |
10571102
<literal>http_500</literal> |
10581103
<literal>http_503</literal> |
@@ -1079,6 +1124,17 @@ server, passing a request to it, or reading the response header;</tag-desc>
10791124
<tag-desc>a timeout has occurred while establishing a connection with the
10801125
server, passing a request to it, or reading the response header;</tag-desc>
10811126

1127+
<tag-name id="denied"><literal>denied</literal></tag-name>
1128+
<tag-desc>the server <link id="fastcgi_allow_upstream">denied</link>
1129+
the connection (1.29.3);
1130+
<para>
1131+
<note>
1132+
This parameter is available as part of our
1133+
<commercial_version>commercial subscription</commercial_version>.
1134+
</note>
1135+
</para>
1136+
</tag-desc>
1137+
10821138
<tag-name><literal>invalid_header</literal></tag-name>
10831139
<tag-desc>a server returned an empty or invalid response;</tag-desc>
10841140

@@ -1124,7 +1180,8 @@ transferring of a response, fixing this is impossible.
11241180
The directive also defines what is considered an
11251181
<link doc="ngx_http_upstream_module.xml" id="max_fails">unsuccessful
11261182
attempt</link> of communication with a server.
1127-
The cases of <literal>error</literal>, <literal>timeout</literal> and
1183+
The cases of <literal>error</literal>, <literal>timeout</literal>,
1184+
<literal>denied</literal> and
11281185
<literal>invalid_header</literal> are always considered unsuccessful attempts,
11291186
even if they are not specified in the directive.
11301187
The cases of <literal>http_500</literal>, <literal>http_503</literal>,
@@ -1391,6 +1448,39 @@ if nginx already started sending the request body.
13911448
</directive>
13921449

13931450

1451+
<directive name="fastcgi_request_dynamic">
1452+
<syntax><literal>on</literal> | <literal>off</literal></syntax>
1453+
<default>off</default>
1454+
<context>http</context>
1455+
<context>server</context>
1456+
<context>location</context>
1457+
<appeared-in>1.29.3</appeared-in>
1458+
1459+
<para>
1460+
Enables or disables creation of a separate request instance
1461+
for each FastCGI server.
1462+
By default, a single request is used for all FastCGI servers.
1463+
If the directive is set to the value “<literal>on</literal>”,
1464+
a separate request instance is created,
1465+
allowing per-server request customization.
1466+
For example, the server-specific <header>Host</header> request header field
1467+
can be set:
1468+
<example>
1469+
proxy_request_dynamic on;
1470+
proxy_set_header Host $upstream_last_server_name;
1471+
</example>
1472+
</para>
1473+
1474+
<para>
1475+
<note>
1476+
This directive is available as part of our
1477+
<commercial_version>commercial subscription</commercial_version>.
1478+
</note>
1479+
</para>
1480+
1481+
</directive>
1482+
1483+
13941484
<directive name="fastcgi_send_lowat">
13951485
<syntax><value>size</value></syntax>
13961486
<default>0</default>

‎xml/en/docs/http/ngx_http_grpc_module.xml‎

Lines changed: 92 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,51 @@ server {
4545

4646
<section id="directives" name="Directives">
4747

48+
<directive name="grpc_allow_upstream">
49+
<syntax><value>address</value></syntax>
50+
<default/>
51+
<context>http</context>
52+
<context>server</context>
53+
<context>location</context>
54+
<appeared-in>1.29.3</appeared-in>
55+
56+
<para>
57+
Defines conditions under which access to a gRPC server
58+
is allowed or <link id="denied">denied</link>.
59+
If all string parameters are not empty
60+
and not equal to “0” then the access is allowed.
61+
The conditions are evaluated each time
62+
before a connection to a gRPC server is established.
63+
Parameter values can contain variables:
64+
<example>
65+
geo $upstream_last_addr $allow {
66+
volatile;
67+
10.10.0.0/24 1;
68+
}
69+
70+
server {
71+
listen 127.0.0.1:8080;
72+
http2 on;
73+
74+
location / {
75+
grpc_pass localhost:9000;
76+
grpc_allow_upstream $allow;
77+
...
78+
}
79+
}
80+
</example>
81+
</para>
82+
83+
<para>
84+
<note>
85+
This directive is available as part of our
86+
<commercial_version>commercial subscription</commercial_version>.
87+
</note>
88+
</para>
89+
90+
</directive>
91+
92+
4893
<directive name="grpc_bind">
4994
<syntax>
5095
<value>address</value>
@@ -196,6 +241,7 @@ with the <link doc="ngx_http_core_module.xml" id="error_page"/> directive.
196241
<syntax>
197242
<literal>error</literal> |
198243
<literal>timeout</literal> |
244+
<literal>denied</literal> |
199245
<literal>invalid_header</literal> |
200246
<literal>http_500</literal> |
201247
<literal>http_502</literal> |
@@ -224,6 +270,17 @@ server, passing a request to it, or reading the response header;</tag-desc>
224270
<tag-desc>a timeout has occurred while establishing a connection with the
225271
server, passing a request to it, or reading the response header;</tag-desc>
226272

273+
<tag-name id="denied"><literal>denied</literal></tag-name>
274+
<tag-desc>the server <link id="grpc_allow_upstream">denied</link>
275+
the connection (1.29.3);
276+
<para>
277+
<note>
278+
This parameter is available as part of our
279+
<commercial_version>commercial subscription</commercial_version>.
280+
</note>
281+
</para>
282+
</tag-desc>
283+
227284
<tag-name><literal>invalid_header</literal></tag-name>
228285
<tag-desc>a server returned an empty or invalid response;</tag-desc>
229286

@@ -275,7 +332,8 @@ transferring of a response, fixing this is impossible.
275332
The directive also defines what is considered an
276333
<link doc="ngx_http_upstream_module.xml" id="max_fails">unsuccessful
277334
attempt</link> of communication with a server.
278-
The cases of <literal>error</literal>, <literal>timeout</literal> and
335+
The cases of <literal>error</literal>, <literal>timeout</literal>,
336+
<literal>denied</literal> and
279337
<literal>invalid_header</literal> are always considered unsuccessful attempts,
280338
even if they are not specified in the directive.
281339
The cases of <literal>http_500</literal>, <literal>http_502</literal>,
@@ -406,6 +464,39 @@ the connection is closed.
406464
</directive>
407465

408466

467+
<directive name="grpc_request_dynamic">
468+
<syntax><literal>on</literal> | <literal>off</literal></syntax>
469+
<default>off</default>
470+
<context>http</context>
471+
<context>server</context>
472+
<context>location</context>
473+
<appeared-in>1.29.3</appeared-in>
474+
475+
<para>
476+
Enables or disables creation of a separate request instance
477+
for each gRPC server.
478+
By default, a single request is used for all gRPC servers.
479+
If the directive is set to the value “<literal>on</literal>”,
480+
a separate request instance is created,
481+
allowing per-server request customization.
482+
For example, the server-specific <header>Host</header> request header field
483+
can be set:
484+
<example>
485+
proxy_request_dynamic on;
486+
proxy_set_header Host $upstream_last_server_name;
487+
</example>
488+
</para>
489+
490+
<para>
491+
<note>
492+
This directive is available as part of our
493+
<commercial_version>commercial subscription</commercial_version>.
494+
</note>
495+
</para>
496+
497+
</directive>
498+
499+
409500
<directive name="grpc_send_timeout">
410501
<syntax><value>time</value></syntax>
411502
<default>60s</default>

‎xml/en/docs/http/ngx_http_memcached_module.xml‎

Lines changed: 58 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,50 @@ server {
4848

4949
<section id="directives" name="Directives">
5050

51+
<directive name="memcached_allow_upstream">
52+
<syntax><value>string</value> ...</syntax>
53+
<default/>
54+
<context>http</context>
55+
<context>server</context>
56+
<context>location</context>
57+
<appeared-in>1.29.3</appeared-in>
58+
59+
<para>
60+
Defines conditions under which access to a memcached server
61+
is allowed or <link id="denied">denied</link>.
62+
If all string parameters are not empty
63+
and not equal to “0” then the access is allowed.
64+
The conditions are evaluated each time
65+
before a connection to a memcached server is established.
66+
Parameter values can contain variables:
67+
<example>
68+
geo $upstream_last_addr $allow {
69+
volatile;
70+
10.10.0.0/24 1;
71+
}
72+
73+
server {
74+
listen 127.0.0.1:8080;
75+
76+
location / {
77+
memcached_pass host:11211;
78+
memcached_allow_upstream $allow;
79+
...
80+
}
81+
}
82+
</example>
83+
</para>
84+
85+
<para>
86+
<note>
87+
This directive is available as part of our
88+
<commercial_version>commercial subscription</commercial_version>.
89+
</note>
90+
</para>
91+
92+
</directive>
93+
94+
5195
<directive name="memcached_bind">
5296
<syntax>
5397
<value>address</value>
@@ -143,6 +187,7 @@ if the flag is set.
143187
<syntax>
144188
<literal>error</literal> |
145189
<literal>timeout</literal> |
190+
<literal>denied</literal> |
146191
<literal>invalid_response</literal> |
147192
<literal>not_found</literal> |
148193
<literal>off</literal>
@@ -164,6 +209,17 @@ server, passing a request to it, or reading the response header;</tag-desc>
164209
<tag-desc>a timeout has occurred while establishing a connection with the
165210
server, passing a request to it, or reading the response header;</tag-desc>
166211

212+
<tag-name id="denied"><literal>denied</literal></tag-name>
213+
<tag-desc>the server <link id="memcached_allow_upstream">denied</link>
214+
the connection (1.29.3);
215+
<para>
216+
<note>
217+
This parameter is available as part of our
218+
<commercial_version>commercial subscription</commercial_version>.
219+
</note>
220+
</para>
221+
</tag-desc>
222+
167223
<tag-name><literal>invalid_response</literal></tag-name>
168224
<tag-desc>a server returned an empty or invalid response;</tag-desc>
169225

@@ -187,7 +243,8 @@ transferring of a response, fixing this is impossible.
187243
The directive also defines what is considered an
188244
<link doc="ngx_http_upstream_module.xml" id="max_fails">unsuccessful
189245
attempt</link> of communication with a server.
190-
The cases of <literal>error</literal>, <literal>timeout</literal> and
246+
The cases of <literal>error</literal>, <literal>timeout</literal>,
247+
<literal>denied</literal> and
191248
<literal>invalid_response</literal> are always considered unsuccessful attempts,
192249
even if they are not specified in the directive.
193250
The case of <literal>not_found</literal>

0 commit comments

Comments
 (0)