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