Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_v2_module.xml @ 1641:c0d1026e7e7b
Documented the "auto" parameter in worker_cpu_affinity.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Tue, 19 Jan 2016 14:19:30 +0300 |
parents | 44c4323144c5 |
children | 680cbf783efe |
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" | |
1636
44c4323144c5
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
1609
diff
changeset
|
12 rev="4"> |
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> |
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
35 The module is experimental, caveat emptor applies. |
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
36 </para> |
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
37 |
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
38 <para> |
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
39 Buffering of a client request body cannot be disabled |
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
40 regardless of |
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_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
|
42 <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
|
43 <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
|
44 <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
|
45 directive values. |
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
46 </para> |
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
47 |
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
48 </section> |
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
49 |
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
50 |
1566 | 51 <section id="example" name="Example Configuration"> |
52 | |
53 <para> | |
54 <example> | |
55 server { | |
56 listen 443 ssl http2; | |
57 | |
58 ssl_certificate server.crt; | |
59 ssl_certificate_key server.key; | |
60 } | |
61 </example> | |
1568
61a3285d77aa
Paraphrased the ALPN/NPN requirements note so it makes sense.
Ruslan Ermilov <ru@nginx.com>
parents:
1566
diff
changeset
|
62 Note that accepting HTTP/2 connections over TLS requires |
1566 | 63 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
|
64 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
|
65 <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
|
66 Using the “Next Protocol Negotiation” (NPN) TLS extension for this purpose |
61a3285d77aa
Paraphrased the ALPN/NPN requirements note so it makes sense.
Ruslan Ermilov <ru@nginx.com>
parents:
1566
diff
changeset
|
67 (available since OpenSSL version 1.0.1) is not guaranteed. |
1566 | 68 </para> |
69 | |
1609
887ce78207ac
Added note about ssl_prefer_server_ciphers in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1596
diff
changeset
|
70 <para> |
887ce78207ac
Added note about ssl_prefer_server_ciphers in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1596
diff
changeset
|
71 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
|
72 <link doc="ngx_http_ssl_module.xml" id="ssl_prefer_server_ciphers"/> directive |
887ce78207ac
Added note about ssl_prefer_server_ciphers in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1596
diff
changeset
|
73 is set to the value <value>on</value>, |
887ce78207ac
Added note about ssl_prefer_server_ciphers in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1596
diff
changeset
|
74 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
|
75 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
|
76 <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
|
77 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
|
78 </para> |
887ce78207ac
Added note about ssl_prefer_server_ciphers in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1596
diff
changeset
|
79 |
1566 | 80 </section> |
81 | |
82 | |
83 <section id="directives" name="Directives"> | |
84 | |
85 <directive name="http2_chunk_size"> | |
86 <syntax><value>size</value></syntax> | |
87 <default>8k</default> | |
88 <context>http</context> | |
89 <context>server</context> | |
90 <context>location</context> | |
91 | |
92 <para> | |
93 Sets the maximum size of chunks | |
94 into which the response body is sliced. | |
95 A too low value results in higher overhead. | |
96 A too high value impairs prioritization due to | |
97 <link url="http://en.wikipedia.org/wiki/Head-of-line_blocking"> | |
98 HOL blocking</link>. | |
99 </para> | |
100 | |
101 </directive> | |
102 | |
103 | |
104 <directive name="http2_idle_timeout"> | |
105 <syntax><value>time</value></syntax> | |
106 <default>3m</default> | |
107 <context>http</context> | |
108 <context>server</context> | |
109 | |
110 <para> | |
111 Sets the timeout of inactivity after which the connection is closed. | |
112 </para> | |
113 | |
114 </directive> | |
115 | |
116 | |
117 <directive name="http2_max_concurrent_streams"> | |
118 <syntax><value>number</value></syntax> | |
119 <default>128</default> | |
120 <context>http</context> | |
121 <context>server</context> | |
122 | |
123 <para> | |
124 Sets the maximum number of concurrent HTTP/2 streams | |
125 in a connection. | |
126 </para> | |
127 | |
128 </directive> | |
129 | |
130 | |
1596
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
131 <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
|
132 <syntax><value>size</value></syntax> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
133 <default>4k</default> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
134 <context>http</context> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
135 <context>server</context> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
136 |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
137 <para> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
138 Limits the maximum size of |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
139 an <link url="http://tools.ietf.org/html/rfc7541">HPACK</link>-compressed |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
140 request header field. |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
141 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
|
142 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
|
143 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
|
144 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
|
145 </para> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
146 |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
147 </directive> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
148 |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
149 |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
150 <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
|
151 <syntax><value>size</value></syntax> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
152 <default>16k</default> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
153 <context>http</context> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
154 <context>server</context> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
155 |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
156 <para> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
157 Limits the maximum size of the entire request header list after |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
158 <link url="http://tools.ietf.org/html/rfc7541">HPACK</link> decompression. |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
159 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
|
160 </para> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
161 |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
162 </directive> |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
163 |
e491c669220e
Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1580
diff
changeset
|
164 |
1566 | 165 <directive name="http2_recv_buffer_size"> |
166 <syntax><value>size</value></syntax> | |
167 <default>256k</default> | |
168 <context>http</context> | |
169 | |
170 <para> | |
171 Sets the size of the per worker input buffer. | |
172 </para> | |
173 | |
174 </directive> | |
175 | |
176 | |
177 <directive name="http2_recv_timeout"> | |
178 <syntax><value>time</value></syntax> | |
179 <default>30s</default> | |
180 <context>http</context> | |
181 <context>server</context> | |
182 | |
183 <para> | |
184 Sets the timeout for expecting more data from the client, | |
185 after which the connection is closed. | |
186 </para> | |
187 | |
188 </directive> | |
189 | |
190 </section> | |
191 | |
192 | |
193 <section id="variables" name="Embedded Variables"> | |
194 | |
195 <para> | |
196 The <literal>ngx_http_v2_module</literal> module | |
197 supports the following embedded variables: | |
198 <list type="tag" compact="no"> | |
199 | |
200 <tag-name id="var_http2"><var>$http2</var></tag-name> | |
201 <tag-desc> | |
202 negotiated protocol identifier: | |
203 “<literal>h2</literal>” for HTTP/2 over TLS, | |
204 “<literal>h2c</literal>” for HTTP/2 over cleartext TCP, | |
205 or an empty string otherwise. | |
206 </tag-desc> | |
207 | |
208 </list> | |
209 </para> | |
210 | |
211 </section> | |
212 | |
213 </module> |