Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_v2_module.xml @ 3018:58f0d9d7fe1d
Corrected contexts in js_periodic directive.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Thu, 05 Oct 2023 10:06:03 +0100 |
parents | c1b9ab38ff09 |
children |
rev | line source |
---|---|
1566 | 1 <?xml version="1.0"?> |
2 | |
3 <!-- | |
4 Copyright (C) Nginx, Inc. | |
5 --> | |
6 | |
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> | |
8 | |
9 <module name="Module ngx_http_v2_module" | |
10 link="/en/docs/http/ngx_http_v2_module.html" | |
11 lang="en" | |
2979
c1b9ab38ff09
Updated link to HTTP/2 RFC.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2977
diff
changeset
|
12 rev="18"> |
1566 | 13 |
14 <section id="summary"> | |
15 | |
16 <para> | |
17 The <literal>ngx_http_v2_module</literal> module (1.9.5) provides | |
2972
9a8d15333a58
Removed obsolete SPDY documentation.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2831
diff
changeset
|
18 support for |
9a8d15333a58
Removed obsolete SPDY documentation.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2831
diff
changeset
|
19 <link url="https://datatracker.ietf.org/doc/html/rfc7540">HTTP/2</link>. |
1566 | 20 </para> |
21 | |
22 <para> | |
23 This module is not built by default, it should be enabled with | |
24 the <literal>--with-http_v2_module</literal> | |
25 configuration parameter. | |
26 </para> | |
27 | |
28 </section> | |
29 | |
30 | |
1580
c711a8a1a8f9
Changed ID from "bugs" to "issues" for http/2, perl, spdy.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1577
diff
changeset
|
31 <section id="issues" name="Known Issues"> |
1577
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
32 |
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
33 <para> |
1671
5154b356a1b2
Unbuffered request body upload support in http2.
Ruslan Ermilov <ru@nginx.com>
parents:
1666
diff
changeset
|
34 Before version 1.9.14, |
5154b356a1b2
Unbuffered request body upload support in http2.
Ruslan Ermilov <ru@nginx.com>
parents:
1666
diff
changeset
|
35 buffering of a client request body could not be disabled |
1577
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
36 regardless of |
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
37 <link doc="ngx_http_proxy_module.xml" id="proxy_request_buffering"/>, |
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
38 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_request_buffering"/>, |
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
39 <link doc="ngx_http_uwsgi_module.xml" id="uwsgi_request_buffering"/>, and |
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
40 <link doc="ngx_http_scgi_module.xml" id="scgi_request_buffering"/> |
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
41 directive values. |
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
42 </para> |
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
43 |
2567
4f3494d80949
Documented support for HTTP/2 in lingering_close.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2450
diff
changeset
|
44 <para> |
4f3494d80949
Documented support for HTTP/2 in lingering_close.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2450
diff
changeset
|
45 Before version 1.19.1, |
4f3494d80949
Documented support for HTTP/2 in lingering_close.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2450
diff
changeset
|
46 the <link doc="ngx_http_core_module.xml" id="lingering_close"/> mechanism |
4f3494d80949
Documented support for HTTP/2 in lingering_close.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2450
diff
changeset
|
47 was not used to control closing HTTP/2 connections. |
4f3494d80949
Documented support for HTTP/2 in lingering_close.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2450
diff
changeset
|
48 </para> |
4f3494d80949
Documented support for HTTP/2 in lingering_close.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2450
diff
changeset
|
49 |
1577
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
50 </section> |
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
51 |
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
52 |
1566 | 53 <section id="example" name="Example Configuration"> |
54 | |
55 <para> | |
56 <example> | |
57 server { | |
2976
cbd963190c15
Documented the http2 directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2972
diff
changeset
|
58 listen 443 ssl; |
cbd963190c15
Documented the http2 directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2972
diff
changeset
|
59 |
cbd963190c15
Documented the http2 directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2972
diff
changeset
|
60 http2 on; |
1566 | 61 |
62 ssl_certificate server.crt; | |
63 ssl_certificate_key server.key; | |
64 } | |
65 </example> | |
1568
61a3285d77aa
Paraphrased the ALPN/NPN requirements note so it makes sense.
Ruslan Ermilov <ru@nginx.com>
parents:
1566
diff
changeset
|
66 Note that accepting HTTP/2 connections over TLS requires |
1566 | 67 the “Application-Layer Protocol Negotiation” (ALPN) TLS extension |
2794
b74f2038f2b5
Removed support of NPN for http/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2654
diff
changeset
|
68 support, which is available since |
1568
61a3285d77aa
Paraphrased the ALPN/NPN requirements note so it makes sense.
Ruslan Ermilov <ru@nginx.com>
parents:
1566
diff
changeset
|
69 <link url="http://www.openssl.org">OpenSSL</link> version 1.0.2. |
1566 | 70 </para> |
71 | |
1609
887ce78207ac
Added note about ssl_prefer_server_ciphers in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1596
diff
changeset
|
72 <para> |
887ce78207ac
Added note about ssl_prefer_server_ciphers in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1596
diff
changeset
|
73 Also note that if the |
887ce78207ac
Added note about ssl_prefer_server_ciphers in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1596
diff
changeset
|
74 <link doc="ngx_http_ssl_module.xml" id="ssl_prefer_server_ciphers"/> directive |
1659
680cbf783efe
Fixed some misuses of "value".
Ruslan Ermilov <ru@nginx.com>
parents:
1636
diff
changeset
|
75 is set to the value “<literal>on</literal>”, |
1609
887ce78207ac
Added note about ssl_prefer_server_ciphers in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1596
diff
changeset
|
76 the <link doc="ngx_http_ssl_module.xml" id="ssl_ciphers">ciphers</link> |
887ce78207ac
Added note about ssl_prefer_server_ciphers in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1596
diff
changeset
|
77 should be configured to comply with |
2979
c1b9ab38ff09
Updated link to HTTP/2 RFC.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2977
diff
changeset
|
78 <link url="https://datatracker.ietf.org/doc/html/rfc9113#appendix-A">RFC 9113, Appendix A</link> |
1609
887ce78207ac
Added note about ssl_prefer_server_ciphers in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1596
diff
changeset
|
79 black list and supported by clients. |
887ce78207ac
Added note about ssl_prefer_server_ciphers in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1596
diff
changeset
|
80 </para> |
887ce78207ac
Added note about ssl_prefer_server_ciphers in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1596
diff
changeset
|
81 |
1566 | 82 </section> |
83 | |
84 | |
85 <section id="directives" name="Directives"> | |
86 | |
2976
cbd963190c15
Documented the http2 directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2972
diff
changeset
|
87 <directive name="http2"> |
cbd963190c15
Documented the http2 directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2972
diff
changeset
|
88 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
cbd963190c15
Documented the http2 directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2972
diff
changeset
|
89 <default>off</default> |
cbd963190c15
Documented the http2 directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2972
diff
changeset
|
90 <context>http</context> |
cbd963190c15
Documented the http2 directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2972
diff
changeset
|
91 <context>server</context> |
cbd963190c15
Documented the http2 directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2972
diff
changeset
|
92 <appeared-in>1.25.1</appeared-in> |
cbd963190c15
Documented the http2 directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2972
diff
changeset
|
93 |
cbd963190c15
Documented the http2 directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2972
diff
changeset
|
94 <para> |
cbd963190c15
Documented the http2 directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2972
diff
changeset
|
95 Enables |
cbd963190c15
Documented the http2 directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2972
diff
changeset
|
96 the <link url="https://datatracker.ietf.org/doc/html/rfc9113">HTTP/2</link> |
cbd963190c15
Documented the http2 directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2972
diff
changeset
|
97 protocol. |
cbd963190c15
Documented the http2 directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2972
diff
changeset
|
98 </para> |
cbd963190c15
Documented the http2 directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2972
diff
changeset
|
99 |
cbd963190c15
Documented the http2 directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2972
diff
changeset
|
100 </directive> |
cbd963190c15
Documented the http2 directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2972
diff
changeset
|
101 |
cbd963190c15
Documented the http2 directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2972
diff
changeset
|
102 |
2142
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
103 <directive name="http2_body_preread_size"> |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
104 <syntax><value>size</value></syntax> |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
105 <default>64k</default> |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
106 <context>http</context> |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
107 <context>server</context> |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
108 <appeared-in>1.11.0</appeared-in> |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
109 |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
110 <para> |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
111 Sets the <value>size</value> of the buffer per each request |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
112 in which the request body may be saved |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
113 before it is started to be processed. |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
114 </para> |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
115 |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
116 </directive> |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
117 |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
118 |
1566 | 119 <directive name="http2_chunk_size"> |
120 <syntax><value>size</value></syntax> | |
121 <default>8k</default> | |
122 <context>http</context> | |
123 <context>server</context> | |
124 <context>location</context> | |
125 | |
126 <para> | |
127 Sets the maximum size of chunks | |
128 into which the response body is sliced. | |
129 A too low value results in higher overhead. | |
130 A too high value impairs prioritization due to | |
131 <link url="http://en.wikipedia.org/wiki/Head-of-line_blocking"> | |
132 HOL blocking</link>. | |
133 </para> | |
134 | |
135 </directive> | |
136 | |
137 | |
138 <directive name="http2_idle_timeout"> | |
139 <syntax><value>time</value></syntax> | |
140 <default>3m</default> | |
141 <context>http</context> | |
142 <context>server</context> | |
143 | |
144 <para> | |
2654
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
145 <note> |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
146 This directive is obsolete since version 1.19.7. |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
147 The <link doc="ngx_http_core_module.xml" id="keepalive_timeout"/> |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
148 directive should be used instead. |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
149 </note> |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
150 </para> |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
151 |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
152 <para> |
1566 | 153 Sets the timeout of inactivity after which the connection is closed. |
154 </para> | |
155 | |
156 </directive> | |
157 | |
158 | |
2105
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
159 <directive name="http2_max_concurrent_pushes"> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
160 <syntax><value>number</value></syntax> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
161 <default>10</default> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
162 <context>http</context> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
163 <context>server</context> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
164 <appeared-in>1.13.9</appeared-in> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
165 |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
166 <para> |
2977
e4718be70b33
Deprecated HTTP/2 Server Push directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2976
diff
changeset
|
167 <note> |
e4718be70b33
Deprecated HTTP/2 Server Push directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2976
diff
changeset
|
168 This directive is obsolete since version 1.25.1. |
e4718be70b33
Deprecated HTTP/2 Server Push directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2976
diff
changeset
|
169 </note> |
e4718be70b33
Deprecated HTTP/2 Server Push directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2976
diff
changeset
|
170 </para> |
e4718be70b33
Deprecated HTTP/2 Server Push directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2976
diff
changeset
|
171 |
e4718be70b33
Deprecated HTTP/2 Server Push directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2976
diff
changeset
|
172 <para> |
2105
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
173 Limits the maximum number of concurrent |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
174 <link id="http2_push">push</link> requests in a connection. |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
175 </para> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
176 |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
177 </directive> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
178 |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
179 |
1566 | 180 <directive name="http2_max_concurrent_streams"> |
181 <syntax><value>number</value></syntax> | |
182 <default>128</default> | |
183 <context>http</context> | |
184 <context>server</context> | |
185 | |
186 <para> | |
187 Sets the maximum number of concurrent HTTP/2 streams | |
188 in a connection. | |
189 </para> | |
190 | |
191 </directive> | |
192 | |
193 | |
1596
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
194 <directive name="http2_max_field_size"> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
195 <syntax><value>size</value></syntax> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
196 <default>4k</default> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
197 <context>http</context> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
198 <context>server</context> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
199 |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
200 <para> |
2654
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
201 <note> |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
202 This directive is obsolete since version 1.19.7. |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
203 The <link doc="ngx_http_core_module.xml" id="large_client_header_buffers"/> |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
204 directive should be used instead. |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
205 </note> |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
206 </para> |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
207 |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
208 <para> |
1596
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
209 Limits the maximum size of |
2831
4add6ae1296f
Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2794
diff
changeset
|
210 an <link url="https://datatracker.ietf.org/doc/html/rfc7541">HPACK</link>-compressed |
1596
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
211 request header field. |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
212 The limit applies equally to both name and value. |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
213 Note that if Huffman encoding is applied, |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
214 the actual size of decompressed name and value strings may be larger. |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
215 For most requests, the default limit should be enough. |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
216 </para> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
217 |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
218 </directive> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
219 |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
220 |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
221 <directive name="http2_max_header_size"> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
222 <syntax><value>size</value></syntax> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
223 <default>16k</default> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
224 <context>http</context> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
225 <context>server</context> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
226 |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
227 <para> |
2654
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
228 <note> |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
229 This directive is obsolete since version 1.19.7. |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
230 The <link doc="ngx_http_core_module.xml" id="large_client_header_buffers"/> |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
231 directive should be used instead. |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
232 </note> |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
233 </para> |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
234 |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
235 <para> |
1596
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
236 Limits the maximum size of the entire request header list after |
2831
4add6ae1296f
Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2794
diff
changeset
|
237 <link url="https://datatracker.ietf.org/doc/html/rfc7541">HPACK</link> decompression. |
1596
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
238 For most requests, the default limit should be enough. |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
239 </para> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
240 |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
241 </directive> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
242 |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
243 |
1834
1d0811707e09
Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1707
diff
changeset
|
244 <directive name="http2_max_requests"> |
1d0811707e09
Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1707
diff
changeset
|
245 <syntax><value>number</value></syntax> |
1d0811707e09
Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1707
diff
changeset
|
246 <default>1000</default> |
1d0811707e09
Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1707
diff
changeset
|
247 <context>http</context> |
1d0811707e09
Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1707
diff
changeset
|
248 <context>server</context> |
1d0811707e09
Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1707
diff
changeset
|
249 <appeared-in>1.11.6</appeared-in> |
1d0811707e09
Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1707
diff
changeset
|
250 |
1d0811707e09
Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1707
diff
changeset
|
251 <para> |
2654
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
252 <note> |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
253 This directive is obsolete since version 1.19.7. |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
254 The <link doc="ngx_http_core_module.xml" id="keepalive_requests"/> |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
255 directive should be used instead. |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
256 </note> |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
257 </para> |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
258 |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
259 <para> |
2105
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
260 Sets the maximum number of requests (including |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
261 <link id="http2_push">push</link> requests) that can be served |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
262 through one HTTP/2 connection, |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
263 after which the next client request will lead to connection closing |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
264 and the need of establishing a new connection. |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
265 </para> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
266 |
2450
a26a42699207
Added note about max number of keepalive requests.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2142
diff
changeset
|
267 <para> |
a26a42699207
Added note about max number of keepalive requests.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2142
diff
changeset
|
268 Closing connections periodically is necessary to free |
a26a42699207
Added note about max number of keepalive requests.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2142
diff
changeset
|
269 per-connection memory allocations. |
a26a42699207
Added note about max number of keepalive requests.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2142
diff
changeset
|
270 Therefore, using too high maximum number of requests |
a26a42699207
Added note about max number of keepalive requests.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2142
diff
changeset
|
271 could result in excessive memory usage and not recommended. |
a26a42699207
Added note about max number of keepalive requests.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2142
diff
changeset
|
272 </para> |
a26a42699207
Added note about max number of keepalive requests.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2142
diff
changeset
|
273 |
2105
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
274 </directive> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
275 |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
276 |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
277 <directive name="http2_push"> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
278 <syntax><value>uri</value> | <literal>off</literal></syntax> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
279 <default>off</default> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
280 <context>http</context> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
281 <context>server</context> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
282 <context>location</context> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
283 <appeared-in>1.13.9</appeared-in> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
284 |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
285 <para> |
2977
e4718be70b33
Deprecated HTTP/2 Server Push directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2976
diff
changeset
|
286 <note> |
e4718be70b33
Deprecated HTTP/2 Server Push directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2976
diff
changeset
|
287 This directive is obsolete since version 1.25.1. |
e4718be70b33
Deprecated HTTP/2 Server Push directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2976
diff
changeset
|
288 </note> |
e4718be70b33
Deprecated HTTP/2 Server Push directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2976
diff
changeset
|
289 </para> |
e4718be70b33
Deprecated HTTP/2 Server Push directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2976
diff
changeset
|
290 |
e4718be70b33
Deprecated HTTP/2 Server Push directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2976
diff
changeset
|
291 <para> |
2105
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
292 Pre-emptively sends |
2979
c1b9ab38ff09
Updated link to HTTP/2 RFC.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2977
diff
changeset
|
293 (<link url="https://datatracker.ietf.org/doc/html/rfc9113#section-8.4">pushes</link>) |
2105
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
294 a request to the specified <value>uri</value> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
295 along with the response to the original request. |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
296 Only relative URIs with absolute path will be processed, |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
297 for example: |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
298 <example> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
299 http2_push /static/css/main.css; |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
300 </example> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
301 The <value>uri</value> value can contain variables. |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
302 </para> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
303 |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
304 <para> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
305 Several <literal>http2_push</literal> directives |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
306 can be specified on the same configuration level. |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
307 The <literal>off</literal> parameter cancels the effect |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
308 of the <literal>http2_push</literal> directives |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
309 inherited from the previous configuration level. |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
310 </para> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
311 |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
312 </directive> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
313 |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
314 |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
315 <directive name="http2_push_preload"> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
316 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
317 <default>off</default> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
318 <context>http</context> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
319 <context>server</context> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
320 <context>location</context> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
321 <appeared-in>1.13.9</appeared-in> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
322 |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
323 <para> |
2977
e4718be70b33
Deprecated HTTP/2 Server Push directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2976
diff
changeset
|
324 <note> |
e4718be70b33
Deprecated HTTP/2 Server Push directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2976
diff
changeset
|
325 This directive is obsolete since version 1.25.1. |
e4718be70b33
Deprecated HTTP/2 Server Push directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2976
diff
changeset
|
326 </note> |
e4718be70b33
Deprecated HTTP/2 Server Push directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2976
diff
changeset
|
327 </para> |
e4718be70b33
Deprecated HTTP/2 Server Push directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2976
diff
changeset
|
328 |
e4718be70b33
Deprecated HTTP/2 Server Push directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2976
diff
changeset
|
329 <para> |
2105
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
330 Enables automatic conversion of |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
331 <link url="https://www.w3.org/TR/preload/#server-push-http-2">preload |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
332 links</link> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
333 specified in the <header>Link</header> response header fields into |
2979
c1b9ab38ff09
Updated link to HTTP/2 RFC.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2977
diff
changeset
|
334 <link url="https://datatracker.ietf.org/doc/html/rfc9113#section-8.4">push</link> |
2105
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
335 requests. |
1834
1d0811707e09
Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1707
diff
changeset
|
336 </para> |
1d0811707e09
Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1707
diff
changeset
|
337 |
1d0811707e09
Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1707
diff
changeset
|
338 </directive> |
1d0811707e09
Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1707
diff
changeset
|
339 |
1d0811707e09
Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1707
diff
changeset
|
340 |
1566 | 341 <directive name="http2_recv_buffer_size"> |
342 <syntax><value>size</value></syntax> | |
343 <default>256k</default> | |
344 <context>http</context> | |
345 | |
346 <para> | |
1666
08f48ecb13ba
Added a hyperlink to http2_recv_buffer_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
347 Sets the size of the per |
08f48ecb13ba
Added a hyperlink to http2_recv_buffer_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
348 <link doc="../ngx_core_module.xml" id="worker_processes">worker</link> |
08f48ecb13ba
Added a hyperlink to http2_recv_buffer_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
349 input buffer. |
1566 | 350 </para> |
351 | |
352 </directive> | |
353 | |
354 | |
355 <directive name="http2_recv_timeout"> | |
356 <syntax><value>time</value></syntax> | |
357 <default>30s</default> | |
358 <context>http</context> | |
359 <context>server</context> | |
360 | |
361 <para> | |
2654
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
362 <note> |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
363 This directive is obsolete since version 1.19.7. |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
364 The <link doc="ngx_http_core_module.xml" id="client_header_timeout"/> |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
365 directive should be used instead. |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
366 </note> |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
367 </para> |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
368 |
d13341d3c54a
Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2567
diff
changeset
|
369 <para> |
1566 | 370 Sets the timeout for expecting more data from the client, |
371 after which the connection is closed. | |
372 </para> | |
373 | |
374 </directive> | |
375 | |
376 </section> | |
377 | |
378 | |
379 <section id="variables" name="Embedded Variables"> | |
380 | |
381 <para> | |
382 The <literal>ngx_http_v2_module</literal> module | |
383 supports the following embedded variables: | |
384 <list type="tag" compact="no"> | |
385 | |
386 <tag-name id="var_http2"><var>$http2</var></tag-name> | |
387 <tag-desc> | |
388 negotiated protocol identifier: | |
389 “<literal>h2</literal>” for HTTP/2 over TLS, | |
390 “<literal>h2c</literal>” for HTTP/2 over cleartext TCP, | |
391 or an empty string otherwise. | |
392 </tag-desc> | |
393 | |
394 </list> | |
395 </para> | |
396 | |
397 </section> | |
398 | |
399 </module> |