Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_v2_module.xml @ 2275:d93c8c32df75
Updated links to CPAN search interface.
See https://www.perl.com/article/saying-goodbye-to-search-cpan-org/ for details.
author | Sergey Kandaurov <pluknet@nginx.com> |
---|---|
date | Tue, 13 Nov 2018 16:28:10 +0300 |
parents | ca7568f67dee |
children | a26a42699207 |
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" | |
2105
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
12 rev="11"> |
1566 | 13 |
14 <section id="summary"> | |
15 | |
16 <para> | |
17 The <literal>ngx_http_v2_module</literal> module (1.9.5) provides | |
18 support for <link url="https://tools.ietf.org/html/rfc7540">HTTP/2</link> | |
19 and supersedes the | |
20 <link doc="ngx_http_spdy_module.xml">ngx_http_spdy_module</link> module. | |
21 </para> | |
22 | |
23 <para> | |
24 This module is not built by default, it should be enabled with | |
25 the <literal>--with-http_v2_module</literal> | |
26 configuration parameter. | |
27 </para> | |
28 | |
29 </section> | |
30 | |
31 | |
1580
c711a8a1a8f9
Changed ID from "bugs" to "issues" for http/2, perl, spdy.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1577
diff
changeset
|
32 <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
|
33 |
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
34 <para> |
1671
5154b356a1b2
Unbuffered request body upload support in http2.
Ruslan Ermilov <ru@nginx.com>
parents:
1666
diff
changeset
|
35 Before version 1.9.14, |
5154b356a1b2
Unbuffered request body upload support in http2.
Ruslan Ermilov <ru@nginx.com>
parents:
1666
diff
changeset
|
36 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
|
37 regardless of |
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_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
|
39 <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
|
40 <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
|
41 <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
|
42 directive values. |
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
43 </para> |
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
44 |
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
45 </section> |
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
46 |
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
47 |
1566 | 48 <section id="example" name="Example Configuration"> |
49 | |
50 <para> | |
51 <example> | |
52 server { | |
53 listen 443 ssl http2; | |
54 | |
55 ssl_certificate server.crt; | |
56 ssl_certificate_key server.key; | |
57 } | |
58 </example> | |
1568
61a3285d77aa
Paraphrased the ALPN/NPN requirements note so it makes sense.
Ruslan Ermilov <ru@nginx.com>
parents:
1566
diff
changeset
|
59 Note that accepting HTTP/2 connections over TLS requires |
1566 | 60 the “Application-Layer Protocol Negotiation” (ALPN) TLS extension |
1568
61a3285d77aa
Paraphrased the ALPN/NPN requirements note so it makes sense.
Ruslan Ermilov <ru@nginx.com>
parents:
1566
diff
changeset
|
61 support, which is available only since |
61a3285d77aa
Paraphrased the ALPN/NPN requirements note so it makes sense.
Ruslan Ermilov <ru@nginx.com>
parents:
1566
diff
changeset
|
62 <link url="http://www.openssl.org">OpenSSL</link> version 1.0.2. |
61a3285d77aa
Paraphrased the ALPN/NPN requirements note so it makes sense.
Ruslan Ermilov <ru@nginx.com>
parents:
1566
diff
changeset
|
63 Using the “Next Protocol Negotiation” (NPN) TLS extension for this purpose |
1835
0ba8d161c354
Clarified the note about NPN and HTTP/2.
Ruslan Ermilov <ru@nginx.com>
parents:
1834
diff
changeset
|
64 (available since OpenSSL version 1.0.1) is not guaranteed to work. |
1566 | 65 </para> |
66 | |
1609
887ce78207ac
Added note about ssl_prefer_server_ciphers in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1596
diff
changeset
|
67 <para> |
887ce78207ac
Added note about ssl_prefer_server_ciphers in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1596
diff
changeset
|
68 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
|
69 <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
|
70 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
|
71 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
|
72 should be configured to comply with |
887ce78207ac
Added note about ssl_prefer_server_ciphers in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1596
diff
changeset
|
73 <link url="https://tools.ietf.org/html/rfc7540#appendix-A">RFC 7540, Appendix A</link> |
887ce78207ac
Added note about ssl_prefer_server_ciphers in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1596
diff
changeset
|
74 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
|
75 </para> |
887ce78207ac
Added note about ssl_prefer_server_ciphers in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1596
diff
changeset
|
76 |
1566 | 77 </section> |
78 | |
79 | |
80 <section id="directives" name="Directives"> | |
81 | |
2142
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
82 <directive name="http2_body_preread_size"> |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
83 <syntax><value>size</value></syntax> |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
84 <default>64k</default> |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
85 <context>http</context> |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
86 <context>server</context> |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
87 <appeared-in>1.11.0</appeared-in> |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
88 |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
89 <para> |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
90 Sets the <value>size</value> of the buffer per each request |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
91 in which the request body may be saved |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
92 before it is started to be processed. |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
93 </para> |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
94 |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
95 </directive> |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
96 |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2105
diff
changeset
|
97 |
1566 | 98 <directive name="http2_chunk_size"> |
99 <syntax><value>size</value></syntax> | |
100 <default>8k</default> | |
101 <context>http</context> | |
102 <context>server</context> | |
103 <context>location</context> | |
104 | |
105 <para> | |
106 Sets the maximum size of chunks | |
107 into which the response body is sliced. | |
108 A too low value results in higher overhead. | |
109 A too high value impairs prioritization due to | |
110 <link url="http://en.wikipedia.org/wiki/Head-of-line_blocking"> | |
111 HOL blocking</link>. | |
112 </para> | |
113 | |
114 </directive> | |
115 | |
116 | |
117 <directive name="http2_idle_timeout"> | |
118 <syntax><value>time</value></syntax> | |
119 <default>3m</default> | |
120 <context>http</context> | |
121 <context>server</context> | |
122 | |
123 <para> | |
124 Sets the timeout of inactivity after which the connection is closed. | |
125 </para> | |
126 | |
127 </directive> | |
128 | |
129 | |
2105
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
130 <directive name="http2_max_concurrent_pushes"> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
131 <syntax><value>number</value></syntax> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
132 <default>10</default> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
133 <context>http</context> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
134 <context>server</context> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
135 <appeared-in>1.13.9</appeared-in> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
136 |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
137 <para> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
138 Limits the maximum number of concurrent |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
139 <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
|
140 </para> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
141 |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
142 </directive> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
143 |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
144 |
1566 | 145 <directive name="http2_max_concurrent_streams"> |
146 <syntax><value>number</value></syntax> | |
147 <default>128</default> | |
148 <context>http</context> | |
149 <context>server</context> | |
150 | |
151 <para> | |
152 Sets the maximum number of concurrent HTTP/2 streams | |
153 in a connection. | |
154 </para> | |
155 | |
156 </directive> | |
157 | |
158 | |
1596
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
159 <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
|
160 <syntax><value>size</value></syntax> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
161 <default>4k</default> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
162 <context>http</context> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
163 <context>server</context> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
164 |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
165 <para> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
166 Limits the maximum size of |
1923
66a30a380fba
Fixed links to tools.ietf.org.
Ruslan Ermilov <ru@nginx.com>
parents:
1835
diff
changeset
|
167 an <link url="https://tools.ietf.org/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
|
168 request header field. |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
169 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
|
170 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
|
171 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
|
172 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
|
173 </para> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
174 |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
175 </directive> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
176 |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
177 |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
178 <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
|
179 <syntax><value>size</value></syntax> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
180 <default>16k</default> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
181 <context>http</context> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
182 <context>server</context> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
183 |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
184 <para> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
185 Limits the maximum size of the entire request header list after |
1923
66a30a380fba
Fixed links to tools.ietf.org.
Ruslan Ermilov <ru@nginx.com>
parents:
1835
diff
changeset
|
186 <link url="https://tools.ietf.org/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
|
187 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
|
188 </para> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
189 |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
190 </directive> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
191 |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
192 |
1834
1d0811707e09
Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1707
diff
changeset
|
193 <directive name="http2_max_requests"> |
1d0811707e09
Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1707
diff
changeset
|
194 <syntax><value>number</value></syntax> |
1d0811707e09
Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1707
diff
changeset
|
195 <default>1000</default> |
1d0811707e09
Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1707
diff
changeset
|
196 <context>http</context> |
1d0811707e09
Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1707
diff
changeset
|
197 <context>server</context> |
1d0811707e09
Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1707
diff
changeset
|
198 <appeared-in>1.11.6</appeared-in> |
1d0811707e09
Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1707
diff
changeset
|
199 |
1d0811707e09
Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1707
diff
changeset
|
200 <para> |
2105
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
201 Sets the maximum number of requests (including |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
202 <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
|
203 through one HTTP/2 connection, |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
204 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
|
205 and the need of establishing a new connection. |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
206 </para> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
207 |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
208 </directive> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
209 |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
210 |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
211 <directive name="http2_push"> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
212 <syntax><value>uri</value> | <literal>off</literal></syntax> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
213 <default>off</default> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
214 <context>http</context> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
215 <context>server</context> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
216 <context>location</context> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
217 <appeared-in>1.13.9</appeared-in> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
218 |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
219 <para> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
220 Pre-emptively sends |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
221 (<link url="https://tools.ietf.org/html/rfc7540#section-8.2">pushes</link>) |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
222 a request to the specified <value>uri</value> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
223 along with the response to the original request. |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
224 Only relative URIs with absolute path will be processed, |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
225 for example: |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
226 <example> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
227 http2_push /static/css/main.css; |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
228 </example> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
229 The <value>uri</value> value can contain variables. |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
230 </para> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
231 |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
232 <para> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
233 Several <literal>http2_push</literal> directives |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
234 can be specified on the same configuration level. |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
235 The <literal>off</literal> parameter cancels the effect |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
236 of the <literal>http2_push</literal> directives |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
237 inherited from the previous configuration level. |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
238 </para> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
239 |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
240 </directive> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
241 |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
242 |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
243 <directive name="http2_push_preload"> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
244 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
245 <default>off</default> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
246 <context>http</context> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
247 <context>server</context> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
248 <context>location</context> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
249 <appeared-in>1.13.9</appeared-in> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
250 |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
251 <para> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
252 Enables automatic conversion of |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
253 <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
|
254 links</link> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
255 specified in the <header>Link</header> response header fields into |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
256 <link url="https://tools.ietf.org/html/rfc7540#section-8.2">push</link> |
d45887ccafde
Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2038
diff
changeset
|
257 requests. |
1834
1d0811707e09
Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1707
diff
changeset
|
258 </para> |
1d0811707e09
Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1707
diff
changeset
|
259 |
1d0811707e09
Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1707
diff
changeset
|
260 </directive> |
1d0811707e09
Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1707
diff
changeset
|
261 |
1d0811707e09
Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1707
diff
changeset
|
262 |
1566 | 263 <directive name="http2_recv_buffer_size"> |
264 <syntax><value>size</value></syntax> | |
265 <default>256k</default> | |
266 <context>http</context> | |
267 | |
268 <para> | |
1666
08f48ecb13ba
Added a hyperlink to http2_recv_buffer_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
269 Sets the size of the per |
08f48ecb13ba
Added a hyperlink to http2_recv_buffer_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
270 <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
|
271 input buffer. |
1566 | 272 </para> |
273 | |
274 </directive> | |
275 | |
276 | |
277 <directive name="http2_recv_timeout"> | |
278 <syntax><value>time</value></syntax> | |
279 <default>30s</default> | |
280 <context>http</context> | |
281 <context>server</context> | |
282 | |
283 <para> | |
284 Sets the timeout for expecting more data from the client, | |
285 after which the connection is closed. | |
286 </para> | |
287 | |
288 </directive> | |
289 | |
290 </section> | |
291 | |
292 | |
293 <section id="variables" name="Embedded Variables"> | |
294 | |
295 <para> | |
296 The <literal>ngx_http_v2_module</literal> module | |
297 supports the following embedded variables: | |
298 <list type="tag" compact="no"> | |
299 | |
300 <tag-name id="var_http2"><var>$http2</var></tag-name> | |
301 <tag-desc> | |
302 negotiated protocol identifier: | |
303 “<literal>h2</literal>” for HTTP/2 over TLS, | |
304 “<literal>h2c</literal>” for HTTP/2 over cleartext TCP, | |
305 or an empty string otherwise. | |
306 </tag-desc> | |
307 | |
308 </list> | |
309 </para> | |
310 | |
311 </section> | |
312 | |
313 </module> |