annotate xml/en/docs/http/ngx_http_v2_module.xml @ 1878:127ae107e5a9

Removed clause about shared memory and Windows versions with ASLR. Starting with nginx 1.9.0 shared memory can be used on Windows versions with address space layout randomization.
author Maxim Dounin <mdounin@mdounin.ru>
date Mon, 26 Dec 2016 19:38:06 +0300
parents 0ba8d161c354
children 66a30a380fba
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1566
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
1 <?xml version="1.0"?>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
2
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
3 <!--
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
4 Copyright (C) Nginx, Inc.
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
5 -->
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
6
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
8
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
9 <module name="Module ngx_http_v2_module"
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
10 link="/en/docs/http/ngx_http_v2_module.html"
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
11 lang="en"
1834
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
12 rev="8">
1566
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
13
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
14 <section id="summary">
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
15
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
16 <para>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
17 The <literal>ngx_http_v2_module</literal> module (1.9.5) provides
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
18 support for <link url="https://tools.ietf.org/html/rfc7540">HTTP/2</link>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
19 and supersedes the
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
20 <link doc="ngx_http_spdy_module.xml">ngx_http_spdy_module</link> module.
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
21 </para>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
22
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
23 <para>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
24 This module is not built by default, it should be enabled with
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
25 the <literal>--with-http_v2_module</literal>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
26 configuration parameter.
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
27 </para>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
28
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
29 </section>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
30
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
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>
1671
5154b356a1b2 Unbuffered request body upload support in http2.
Ruslan Ermilov <ru@nginx.com>
parents: 1666
diff changeset
39 Before version 1.9.14,
5154b356a1b2 Unbuffered request body upload support in http2.
Ruslan Ermilov <ru@nginx.com>
parents: 1666
diff changeset
40 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
41 regardless of
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_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
43 <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
44 <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
45 <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
46 directive values.
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
37be36b01d28 Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1568
diff changeset
49 </section>
37be36b01d28 Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1568
diff changeset
50
37be36b01d28 Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1568
diff changeset
51
1566
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
52 <section id="example" name="Example Configuration">
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
53
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
54 <para>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
55 <example>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
56 server {
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
57 listen 443 ssl http2;
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
58
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
59 ssl_certificate server.crt;
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
60 ssl_certificate_key server.key;
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
61 }
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
62 </example>
1568
61a3285d77aa Paraphrased the ALPN/NPN requirements note so it makes sense.
Ruslan Ermilov <ru@nginx.com>
parents: 1566
diff changeset
63 Note that accepting HTTP/2 connections over TLS requires
1566
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
64 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
65 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
66 <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
67 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
68 (available since OpenSSL version 1.0.1) is not guaranteed to work.
1566
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
69 </para>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
70
1609
887ce78207ac Added note about ssl_prefer_server_ciphers in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1596
diff changeset
71 <para>
887ce78207ac Added note about ssl_prefer_server_ciphers in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1596
diff changeset
72 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
73 <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
74 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
75 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
76 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
77 <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
78 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
79 </para>
887ce78207ac Added note about ssl_prefer_server_ciphers in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1596
diff changeset
80
1566
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
81 </section>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
82
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
83
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
84 <section id="directives" name="Directives">
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
85
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
86 <directive name="http2_chunk_size">
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
87 <syntax><value>size</value></syntax>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
88 <default>8k</default>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
89 <context>http</context>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
90 <context>server</context>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
91 <context>location</context>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
92
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
93 <para>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
94 Sets the maximum size of chunks
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
95 into which the response body is sliced.
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
96 A too low value results in higher overhead.
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
97 A too high value impairs prioritization due to
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
98 <link url="http://en.wikipedia.org/wiki/Head-of-line_blocking">
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
99 HOL blocking</link>.
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
100 </para>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
101
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
102 </directive>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
103
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
104
1707
ea60a7dff3c1 Documented the http2_body_preread_size directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1671
diff changeset
105 <directive name="http2_body_preread_size">
ea60a7dff3c1 Documented the http2_body_preread_size directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1671
diff changeset
106 <syntax><value>size</value></syntax>
ea60a7dff3c1 Documented the http2_body_preread_size directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1671
diff changeset
107 <default>64k</default>
ea60a7dff3c1 Documented the http2_body_preread_size directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1671
diff changeset
108 <context>http</context>
ea60a7dff3c1 Documented the http2_body_preread_size directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1671
diff changeset
109 <context>server</context>
ea60a7dff3c1 Documented the http2_body_preread_size directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1671
diff changeset
110 <appeared-in>1.11.0</appeared-in>
ea60a7dff3c1 Documented the http2_body_preread_size directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1671
diff changeset
111
ea60a7dff3c1 Documented the http2_body_preread_size directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1671
diff changeset
112 <para>
ea60a7dff3c1 Documented the http2_body_preread_size directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1671
diff changeset
113 Sets the <value>size</value> of the buffer per each request
ea60a7dff3c1 Documented the http2_body_preread_size directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1671
diff changeset
114 in which the request body may be saved
ea60a7dff3c1 Documented the http2_body_preread_size directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1671
diff changeset
115 before it is started to be processed.
ea60a7dff3c1 Documented the http2_body_preread_size directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1671
diff changeset
116 </para>
ea60a7dff3c1 Documented the http2_body_preread_size directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1671
diff changeset
117
ea60a7dff3c1 Documented the http2_body_preread_size directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1671
diff changeset
118 </directive>
ea60a7dff3c1 Documented the http2_body_preread_size directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1671
diff changeset
119
ea60a7dff3c1 Documented the http2_body_preread_size directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1671
diff changeset
120
1566
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
121 <directive name="http2_idle_timeout">
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
122 <syntax><value>time</value></syntax>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
123 <default>3m</default>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
124 <context>http</context>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
125 <context>server</context>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
126
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
127 <para>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
128 Sets the timeout of inactivity after which the connection is closed.
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
129 </para>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
130
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
131 </directive>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
132
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
133
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
134 <directive name="http2_max_concurrent_streams">
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
135 <syntax><value>number</value></syntax>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
136 <default>128</default>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
137 <context>http</context>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
138 <context>server</context>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
139
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
140 <para>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
141 Sets the maximum number of concurrent HTTP/2 streams
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
142 in a connection.
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
143 </para>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
144
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
145 </directive>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
146
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
147
1596
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
148 <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
149 <syntax><value>size</value></syntax>
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
150 <default>4k</default>
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
151 <context>http</context>
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
152 <context>server</context>
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
153
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 Limits the maximum size of
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
156 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
157 request header field.
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
158 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
159 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
160 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
161 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
162 </para>
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 </directive>
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
165
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
166
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
167 <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
168 <syntax><value>size</value></syntax>
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
169 <default>16k</default>
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
170 <context>http</context>
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
171 <context>server</context>
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 <para>
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
174 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
175 <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
176 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
177 </para>
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
178
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
179 </directive>
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
180
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
181
1834
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
182 <directive name="http2_max_requests">
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
183 <syntax><value>number</value></syntax>
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
184 <default>1000</default>
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
185 <context>http</context>
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
186 <context>server</context>
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
187 <context>location</context>
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
188 <appeared-in>1.11.6</appeared-in>
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
189
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
190 <para>
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
191 Sets the maximum number of requests that can be
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
192 served through one HTTP/2 connection,
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
193 after which the connection is closed
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
194 and the client should use a new connection.
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
195 </para>
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
196
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
197 </directive>
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
198
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
199
1566
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
200 <directive name="http2_recv_buffer_size">
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
201 <syntax><value>size</value></syntax>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
202 <default>256k</default>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
203 <context>http</context>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
204
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
205 <para>
1666
08f48ecb13ba Added a hyperlink to http2_recv_buffer_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1659
diff changeset
206 Sets the size of the per
08f48ecb13ba Added a hyperlink to http2_recv_buffer_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1659
diff changeset
207 <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
208 input buffer.
1566
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
209 </para>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
210
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
211 </directive>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
212
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
213
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
214 <directive name="http2_recv_timeout">
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
215 <syntax><value>time</value></syntax>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
216 <default>30s</default>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
217 <context>http</context>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
218 <context>server</context>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
219
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
220 <para>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
221 Sets the timeout for expecting more data from the client,
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
222 after which the connection is closed.
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
223 </para>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
224
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
225 </directive>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
226
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
227 </section>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
228
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
229
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
230 <section id="variables" name="Embedded Variables">
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
231
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
232 <para>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
233 The <literal>ngx_http_v2_module</literal> module
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
234 supports the following embedded variables:
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
235 <list type="tag" compact="no">
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
236
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
237 <tag-name id="var_http2"><var>$http2</var></tag-name>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
238 <tag-desc>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
239 negotiated protocol identifier:
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
240 “<literal>h2</literal>” for HTTP/2 over TLS,
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
241 “<literal>h2c</literal>” for HTTP/2 over cleartext TCP,
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
242 or an empty string otherwise.
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
243 </tag-desc>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
244
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
245 </list>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
246 </para>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
247
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
248 </section>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
249
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
250 </module>