annotate xml/en/docs/http/ngx_http_v2_module.xml @ 2794:b74f2038f2b5

Removed support of NPN for http/2.
author Yaroslav Zhuravlev <yar@nginx.com>
date Mon, 08 Nov 2021 12:30:24 +0000
parents d13341d3c54a
children 4add6ae1296f
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"
2794
b74f2038f2b5 Removed support of NPN for http/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2654
diff changeset
12 rev="15">
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>
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
2567
4f3494d80949 Documented support for HTTP/2 in lingering_close.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2450
diff changeset
45 <para>
4f3494d80949 Documented support for HTTP/2 in lingering_close.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2450
diff changeset
46 Before version 1.19.1,
4f3494d80949 Documented support for HTTP/2 in lingering_close.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2450
diff changeset
47 the <link doc="ngx_http_core_module.xml" id="lingering_close"/> mechanism
4f3494d80949 Documented support for HTTP/2 in lingering_close.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2450
diff changeset
48 was not used to control closing HTTP/2 connections.
4f3494d80949 Documented support for HTTP/2 in lingering_close.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2450
diff changeset
49 </para>
4f3494d80949 Documented support for HTTP/2 in lingering_close.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2450
diff changeset
50
1577
37be36b01d28 Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1568
diff changeset
51 </section>
37be36b01d28 Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1568
diff changeset
52
37be36b01d28 Added the "Known issues" section to the ngx_http_v2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1568
diff changeset
53
1566
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
54 <section id="example" name="Example Configuration">
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
55
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
56 <para>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
57 <example>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
58 server {
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
59 listen 443 ssl http2;
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
60
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
61 ssl_certificate server.crt;
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
62 ssl_certificate_key server.key;
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
63 }
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
64 </example>
1568
61a3285d77aa Paraphrased the ALPN/NPN requirements note so it makes sense.
Ruslan Ermilov <ru@nginx.com>
parents: 1566
diff changeset
65 Note that accepting HTTP/2 connections over TLS requires
1566
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
66 the “Application-Layer Protocol Negotiation” (ALPN) TLS extension
2794
b74f2038f2b5 Removed support of NPN for http/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2654
diff changeset
67 support, which is available since
1568
61a3285d77aa Paraphrased the ALPN/NPN requirements note so it makes sense.
Ruslan Ermilov <ru@nginx.com>
parents: 1566
diff changeset
68 <link url="http://www.openssl.org">OpenSSL</link> version 1.0.2.
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
2142
ca7568f67dee Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents: 2105
diff changeset
86 <directive name="http2_body_preread_size">
ca7568f67dee Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents: 2105
diff changeset
87 <syntax><value>size</value></syntax>
ca7568f67dee Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents: 2105
diff changeset
88 <default>64k</default>
ca7568f67dee Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents: 2105
diff changeset
89 <context>http</context>
ca7568f67dee Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents: 2105
diff changeset
90 <context>server</context>
ca7568f67dee Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents: 2105
diff changeset
91 <appeared-in>1.11.0</appeared-in>
ca7568f67dee Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents: 2105
diff changeset
92
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 Sets the <value>size</value> of the buffer per each request
ca7568f67dee Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents: 2105
diff changeset
95 in which the request body may be saved
ca7568f67dee Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents: 2105
diff changeset
96 before it is started to be processed.
ca7568f67dee Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents: 2105
diff changeset
97 </para>
ca7568f67dee Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents: 2105
diff changeset
98
ca7568f67dee Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents: 2105
diff changeset
99 </directive>
ca7568f67dee Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents: 2105
diff changeset
100
ca7568f67dee Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents: 2105
diff changeset
101
1566
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
102 <directive name="http2_chunk_size">
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
103 <syntax><value>size</value></syntax>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
104 <default>8k</default>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
105 <context>http</context>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
106 <context>server</context>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
107 <context>location</context>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
108
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
109 <para>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
110 Sets the maximum size of chunks
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
111 into which the response body is sliced.
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
112 A too low value results in higher overhead.
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
113 A too high value impairs prioritization due to
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
114 <link url="http://en.wikipedia.org/wiki/Head-of-line_blocking">
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
115 HOL blocking</link>.
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
116 </para>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
117
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
118 </directive>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
119
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
120
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>
2654
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
128 <note>
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
129 This directive is obsolete since version 1.19.7.
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
130 The <link doc="ngx_http_core_module.xml" id="keepalive_timeout"/>
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
131 directive should be used instead.
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
132 </note>
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
133 </para>
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
134
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
135 <para>
1566
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
136 Sets the timeout of inactivity after which the connection is closed.
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
137 </para>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
138
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
139 </directive>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
140
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
141
2105
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
142 <directive name="http2_max_concurrent_pushes">
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
143 <syntax><value>number</value></syntax>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
144 <default>10</default>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
145 <context>http</context>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
146 <context>server</context>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
147 <appeared-in>1.13.9</appeared-in>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
148
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
149 <para>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
150 Limits the maximum number of concurrent
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
151 <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
152 </para>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
153
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
154 </directive>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
155
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
156
1566
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
157 <directive name="http2_max_concurrent_streams">
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
158 <syntax><value>number</value></syntax>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
159 <default>128</default>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
160 <context>http</context>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
161 <context>server</context>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
162
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
163 <para>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
164 Sets the maximum number of concurrent HTTP/2 streams
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
165 in a connection.
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
166 </para>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
167
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
168 </directive>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
169
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
170
1596
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
171 <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
172 <syntax><value>size</value></syntax>
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
173 <default>4k</default>
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
174 <context>http</context>
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
175 <context>server</context>
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 <para>
2654
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
178 <note>
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
179 This directive is obsolete since version 1.19.7.
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
180 The <link doc="ngx_http_core_module.xml" id="large_client_header_buffers"/>
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
181 directive should be used instead.
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
182 </note>
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
183 </para>
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
184
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
185 <para>
1596
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
186 Limits the maximum size of
1923
66a30a380fba Fixed links to tools.ietf.org.
Ruslan Ermilov <ru@nginx.com>
parents: 1835
diff changeset
187 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
188 request header field.
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
189 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
190 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
191 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
192 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
193 </para>
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
194
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
195 </directive>
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
196
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
197
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
198 <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
199 <syntax><value>size</value></syntax>
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
200 <default>16k</default>
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
201 <context>http</context>
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
202 <context>server</context>
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
203
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
204 <para>
2654
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
205 <note>
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
206 This directive is obsolete since version 1.19.7.
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
207 The <link doc="ngx_http_core_module.xml" id="large_client_header_buffers"/>
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
208 directive should be used instead.
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
209 </note>
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
210 </para>
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
211
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
212 <para>
1596
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
213 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
214 <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
215 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
216 </para>
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
217
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
218 </directive>
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
219
e491c669220e Documented http2_max_field_size, http2_max_header_size
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1580
diff changeset
220
1834
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
221 <directive name="http2_max_requests">
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
222 <syntax><value>number</value></syntax>
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
223 <default>1000</default>
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
224 <context>http</context>
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
225 <context>server</context>
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
226 <appeared-in>1.11.6</appeared-in>
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
227
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
228 <para>
2654
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
229 <note>
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
230 This directive is obsolete since version 1.19.7.
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
231 The <link doc="ngx_http_core_module.xml" id="keepalive_requests"/>
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
232 directive should be used instead.
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
233 </note>
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
234 </para>
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
235
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
236 <para>
2105
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
237 Sets the maximum number of requests (including
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
238 <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
239 through one HTTP/2 connection,
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
240 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
241 and the need of establishing a new connection.
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
242 </para>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
243
2450
a26a42699207 Added note about max number of keepalive requests.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2142
diff changeset
244 <para>
a26a42699207 Added note about max number of keepalive requests.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2142
diff changeset
245 Closing connections periodically is necessary to free
a26a42699207 Added note about max number of keepalive requests.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2142
diff changeset
246 per-connection memory allocations.
a26a42699207 Added note about max number of keepalive requests.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2142
diff changeset
247 Therefore, using too high maximum number of requests
a26a42699207 Added note about max number of keepalive requests.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2142
diff changeset
248 could result in excessive memory usage and not recommended.
a26a42699207 Added note about max number of keepalive requests.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2142
diff changeset
249 </para>
a26a42699207 Added note about max number of keepalive requests.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2142
diff changeset
250
2105
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
251 </directive>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
252
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
253
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
254 <directive name="http2_push">
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
255 <syntax><value>uri</value> | <literal>off</literal></syntax>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
256 <default>off</default>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
257 <context>http</context>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
258 <context>server</context>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
259 <context>location</context>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
260 <appeared-in>1.13.9</appeared-in>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
261
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
262 <para>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
263 Pre-emptively sends
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
264 (<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
265 a request to the specified <value>uri</value>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
266 along with the response to the original request.
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
267 Only relative URIs with absolute path will be processed,
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
268 for example:
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
269 <example>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
270 http2_push /static/css/main.css;
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
271 </example>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
272 The <value>uri</value> value can contain variables.
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
273 </para>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
274
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
275 <para>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
276 Several <literal>http2_push</literal> directives
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
277 can be specified on the same configuration level.
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
278 The <literal>off</literal> parameter cancels the effect
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
279 of the <literal>http2_push</literal> directives
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
280 inherited from the previous configuration level.
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
281 </para>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
282
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
283 </directive>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
284
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
285
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
286 <directive name="http2_push_preload">
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
287 <syntax><literal>on</literal> | <literal>off</literal></syntax>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
288 <default>off</default>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
289 <context>http</context>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
290 <context>server</context>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
291 <context>location</context>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
292 <appeared-in>1.13.9</appeared-in>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
293
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
294 <para>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
295 Enables automatic conversion of
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
296 <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
297 links</link>
d45887ccafde Documented HTTP/2 server push.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2038
diff changeset
298 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
299 <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
300 requests.
1834
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
301 </para>
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
302
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
303 </directive>
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
304
1d0811707e09 Documented the "http2_max_requests" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1707
diff changeset
305
1566
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
306 <directive name="http2_recv_buffer_size">
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
307 <syntax><value>size</value></syntax>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
308 <default>256k</default>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
309 <context>http</context>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
310
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
311 <para>
1666
08f48ecb13ba Added a hyperlink to http2_recv_buffer_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1659
diff changeset
312 Sets the size of the per
08f48ecb13ba Added a hyperlink to http2_recv_buffer_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1659
diff changeset
313 <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
314 input buffer.
1566
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
315 </para>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
316
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
317 </directive>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
318
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
319
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
320 <directive name="http2_recv_timeout">
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
321 <syntax><value>time</value></syntax>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
322 <default>30s</default>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
323 <context>http</context>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
324 <context>server</context>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
325
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
326 <para>
2654
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
327 <note>
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
328 This directive is obsolete since version 1.19.7.
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
329 The <link doc="ngx_http_core_module.xml" id="client_header_timeout"/>
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
330 directive should be used instead.
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
331 </note>
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
332 </para>
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
333
d13341d3c54a Marked some directives as obsolete in HTTP/2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2567
diff changeset
334 <para>
1566
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
335 Sets the timeout for expecting more data from the client,
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
336 after which the connection is closed.
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
337 </para>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
338
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
339 </directive>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
340
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
341 </section>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
342
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
343
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
344 <section id="variables" name="Embedded Variables">
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
345
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
346 <para>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
347 The <literal>ngx_http_v2_module</literal> module
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
348 supports the following embedded variables:
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
349 <list type="tag" compact="no">
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
350
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
351 <tag-name id="var_http2"><var>$http2</var></tag-name>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
352 <tag-desc>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
353 negotiated protocol identifier:
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
354 “<literal>h2</literal>” for HTTP/2 over TLS,
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
355 “<literal>h2c</literal>” for HTTP/2 over cleartext TCP,
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
356 or an empty string otherwise.
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
357 </tag-desc>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
358
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
359 </list>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
360 </para>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
361
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
362 </section>
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
363
0ca33afb461b Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
364 </module>