Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_v2_module.xml @ 1577:37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Mon, 28 Sep 2015 23:04:43 +0300 |
parents | 61a3285d77aa |
children | c711a8a1a8f9 |
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" | |
12 rev="1"> | |
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 | |
1577
37be36b01d28
Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1568
diff
changeset
|
41 <section id="bugs" name="Known Issues"> |
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 | |
79 </section> | |
80 | |
81 | |
82 <section id="directives" name="Directives"> | |
83 | |
84 <directive name="http2_chunk_size"> | |
85 <syntax><value>size</value></syntax> | |
86 <default>8k</default> | |
87 <context>http</context> | |
88 <context>server</context> | |
89 <context>location</context> | |
90 | |
91 <para> | |
92 Sets the maximum size of chunks | |
93 into which the response body is sliced. | |
94 A too low value results in higher overhead. | |
95 A too high value impairs prioritization due to | |
96 <link url="http://en.wikipedia.org/wiki/Head-of-line_blocking"> | |
97 HOL blocking</link>. | |
98 </para> | |
99 | |
100 </directive> | |
101 | |
102 | |
103 <directive name="http2_idle_timeout"> | |
104 <syntax><value>time</value></syntax> | |
105 <default>3m</default> | |
106 <context>http</context> | |
107 <context>server</context> | |
108 | |
109 <para> | |
110 Sets the timeout of inactivity after which the connection is closed. | |
111 </para> | |
112 | |
113 </directive> | |
114 | |
115 | |
116 <directive name="http2_max_concurrent_streams"> | |
117 <syntax><value>number</value></syntax> | |
118 <default>128</default> | |
119 <context>http</context> | |
120 <context>server</context> | |
121 | |
122 <para> | |
123 Sets the maximum number of concurrent HTTP/2 streams | |
124 in a connection. | |
125 </para> | |
126 | |
127 </directive> | |
128 | |
129 | |
130 <directive name="http2_recv_buffer_size"> | |
131 <syntax><value>size</value></syntax> | |
132 <default>256k</default> | |
133 <context>http</context> | |
134 | |
135 <para> | |
136 Sets the size of the per worker input buffer. | |
137 </para> | |
138 | |
139 </directive> | |
140 | |
141 | |
142 <directive name="http2_recv_timeout"> | |
143 <syntax><value>time</value></syntax> | |
144 <default>30s</default> | |
145 <context>http</context> | |
146 <context>server</context> | |
147 | |
148 <para> | |
149 Sets the timeout for expecting more data from the client, | |
150 after which the connection is closed. | |
151 </para> | |
152 | |
153 </directive> | |
154 | |
155 </section> | |
156 | |
157 | |
158 <section id="variables" name="Embedded Variables"> | |
159 | |
160 <para> | |
161 The <literal>ngx_http_v2_module</literal> module | |
162 supports the following embedded variables: | |
163 <list type="tag" compact="no"> | |
164 | |
165 <tag-name id="var_http2"><var>$http2</var></tag-name> | |
166 <tag-desc> | |
167 negotiated protocol identifier: | |
168 “<literal>h2</literal>” for HTTP/2 over TLS, | |
169 “<literal>h2c</literal>” for HTTP/2 over cleartext TCP, | |
170 or an empty string otherwise. | |
171 </tag-desc> | |
172 | |
173 </list> | |
174 </para> | |
175 | |
176 </section> | |
177 | |
178 </module> |