nginx-site: xml/en/docs/http/ngx_http_v2

annotate xml/en/docs/http/ngx_http_v2_module.xml @ 2972:9a8d15333a58

Removed obsolete SPDY documentation.

author	Sergey Kandaurov <pluknet@nginx.com>
date	Wed, 07 Jun 2023 14:21:30 +0400
parents	4add6ae1296f
children	cbd963190c15

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
2972 9a8d15333a58 Removed obsolete SPDY documentation. Sergey Kandaurov <pluknet@nginx.com> parents: 2831 diff changeset	18 support for
9a8d15333a58 Removed obsolete SPDY documentation. Sergey Kandaurov <pluknet@nginx.com> parents: 2831 diff changeset	19 <link url="https://datatracker.ietf.org/doc/html/rfc7540">HTTP/2</link>.
1566 0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	20 </para>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	21
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	22 <para>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	23 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	24 the <literal>--with-http_v2_module</literal>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	25 configuration parameter.
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	26 </para>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	27
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	28 </section>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	29
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	30
1580 c711a8a1a8f9 Changed ID from "bugs" to "issues" for http/2, perl, spdy. Yaroslav Zhuravlev <yar@nginx.com> parents: 1577 diff changeset	31 <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	32
37be36b01d28 Added the "Known issues" section to the ngx_http_v2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1568 diff changeset	33 <para>
1671 5154b356a1b2 Unbuffered request body upload support in http2. Ruslan Ermilov <ru@nginx.com> parents: 1666 diff changeset	34 Before version 1.9.14,
5154b356a1b2 Unbuffered request body upload support in http2. Ruslan Ermilov <ru@nginx.com> parents: 1666 diff changeset	35 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	36 regardless of
37be36b01d28 Added the "Known issues" section to the ngx_http_v2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1568 diff changeset	37 <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	38 <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	39 <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	40 <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	41 directive values.
37be36b01d28 Added the "Known issues" section to the ngx_http_v2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1568 diff changeset	42 </para>
37be36b01d28 Added the "Known issues" section to the ngx_http_v2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1568 diff changeset	43
2567 4f3494d80949 Documented support for HTTP/2 in lingering_close. Yaroslav Zhuravlev <yar@nginx.com> parents: 2450 diff changeset	44 <para>
4f3494d80949 Documented support for HTTP/2 in lingering_close. Yaroslav Zhuravlev <yar@nginx.com> parents: 2450 diff changeset	45 Before version 1.19.1,
4f3494d80949 Documented support for HTTP/2 in lingering_close. Yaroslav Zhuravlev <yar@nginx.com> parents: 2450 diff changeset	46 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	47 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	48 </para>
4f3494d80949 Documented support for HTTP/2 in lingering_close. Yaroslav Zhuravlev <yar@nginx.com> parents: 2450 diff changeset	49
1577 37be36b01d28 Added the "Known issues" section to the ngx_http_v2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1568 diff changeset	50 </section>
37be36b01d28 Added the "Known issues" section to the ngx_http_v2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1568 diff changeset	51
37be36b01d28 Added the "Known issues" section to the ngx_http_v2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: 1568 diff changeset	52
1566 0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	53 <section id="example" name="Example Configuration">
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	54
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	55 <para>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	56 <example>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	57 server {
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	58 listen 443 ssl http2;
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	59
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	60 ssl_certificate server.crt;
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	61 ssl_certificate_key server.key;
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	62 }
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	63 </example>
1568 61a3285d77aa Paraphrased the ALPN/NPN requirements note so it makes sense. Ruslan Ermilov <ru@nginx.com> parents: 1566 diff changeset	64 Note that accepting HTTP/2 connections over TLS requires
1566 0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	65 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	66 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	67 <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	68 </para>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	69
1609 887ce78207ac Added note about ssl_prefer_server_ciphers in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 1596 diff changeset	70 <para>
887ce78207ac Added note about ssl_prefer_server_ciphers in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 1596 diff changeset	71 Also note that if the
887ce78207ac Added note about ssl_prefer_server_ciphers in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 1596 diff changeset	72 <link doc="ngx_http_ssl_module.xml" id="ssl_prefer_server_ciphers"/> directive
1659 680cbf783efe Fixed some misuses of "value". Ruslan Ermilov <ru@nginx.com> parents: 1636 diff changeset	73 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	74 the <link doc="ngx_http_ssl_module.xml" id="ssl_ciphers">ciphers</link>
887ce78207ac Added note about ssl_prefer_server_ciphers in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 1596 diff changeset	75 should be configured to comply with
2831 4add6ae1296f Updated links to datatracker.ietf.org. Sergey Kandaurov <pluknet@nginx.com> parents: 2794 diff changeset	76 <link url="https://datatracker.ietf.org/doc/html/rfc7540#appendix-A">RFC 7540, Appendix A</link>
1609 887ce78207ac Added note about ssl_prefer_server_ciphers in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 1596 diff changeset	77 black list and supported by clients.
887ce78207ac Added note about ssl_prefer_server_ciphers in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 1596 diff changeset	78 </para>
887ce78207ac Added note about ssl_prefer_server_ciphers in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 1596 diff changeset	79
1566 0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	80 </section>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	81
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 <section id="directives" name="Directives">
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	84
2142 ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2105 diff changeset	85 <directive name="http2_body_preread_size">
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2105 diff changeset	86 <syntax><value>size</value></syntax>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2105 diff changeset	87 <default>64k</default>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2105 diff changeset	88 <context>http</context>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2105 diff changeset	89 <context>server</context>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2105 diff changeset	90 <appeared-in>1.11.0</appeared-in>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2105 diff changeset	91
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2105 diff changeset	92 <para>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2105 diff changeset	93 Sets the <value>size</value> of the buffer per each request
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2105 diff changeset	94 in which the request body may be saved
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2105 diff changeset	95 before it is started to be processed.
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2105 diff changeset	96 </para>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2105 diff changeset	97
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2105 diff changeset	98 </directive>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2105 diff changeset	99
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2105 diff changeset	100
1566 0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	101 <directive name="http2_chunk_size">
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	102 <syntax><value>size</value></syntax>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	103 <default>8k</default>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	104 <context>http</context>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	105 <context>server</context>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	106 <context>location</context>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	107
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	108 <para>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	109 Sets the maximum size of chunks
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	110 into which the response body is sliced.
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	111 A too low value results in higher overhead.
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	112 A too high value impairs prioritization due to
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	113 <link url="http://en.wikipedia.org/wiki/Head-of-line_blocking">
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	114 HOL blocking</link>.
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	115 </para>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	116
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	117 </directive>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	118
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 <directive name="http2_idle_timeout">
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	121 <syntax><value>time</value></syntax>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	122 <default>3m</default>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	123 <context>http</context>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	124 <context>server</context>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	125
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	126 <para>
2654 d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	127 <note>
d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	128 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	129 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	130 directive should be used instead.
d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	131 </note>
d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	132 </para>
d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	133
d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	134 <para>
1566 0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	135 Sets the timeout of inactivity after which the connection is closed.
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	136 </para>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	137
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	138 </directive>
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
2105 d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	141 <directive name="http2_max_concurrent_pushes">
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	142 <syntax><value>number</value></syntax>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	143 <default>10</default>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	144 <context>http</context>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	145 <context>server</context>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	146 <appeared-in>1.13.9</appeared-in>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	147
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	148 <para>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	149 Limits the maximum number of concurrent
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	150 <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	151 </para>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	152
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	153 </directive>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	154
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	155
1566 0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	156 <directive name="http2_max_concurrent_streams">
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	157 <syntax><value>number</value></syntax>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	158 <default>128</default>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	159 <context>http</context>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	160 <context>server</context>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	161
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	162 <para>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	163 Sets the maximum number of concurrent HTTP/2 streams
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	164 in a connection.
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	165 </para>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	166
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	167 </directive>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	168
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	169
1596 e491c669220e Documented http2_max_field_size, http2_max_header_size Yaroslav Zhuravlev <yar@nginx.com> parents: 1580 diff changeset	170 <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	171 <syntax><value>size</value></syntax>
e491c669220e Documented http2_max_field_size, http2_max_header_size Yaroslav Zhuravlev <yar@nginx.com> parents: 1580 diff changeset	172 <default>4k</default>
e491c669220e Documented http2_max_field_size, http2_max_header_size Yaroslav Zhuravlev <yar@nginx.com> parents: 1580 diff changeset	173 <context>http</context>
e491c669220e Documented http2_max_field_size, http2_max_header_size Yaroslav Zhuravlev <yar@nginx.com> parents: 1580 diff changeset	174 <context>server</context>
e491c669220e Documented http2_max_field_size, http2_max_header_size Yaroslav Zhuravlev <yar@nginx.com> parents: 1580 diff changeset	175
e491c669220e Documented http2_max_field_size, http2_max_header_size Yaroslav Zhuravlev <yar@nginx.com> parents: 1580 diff changeset	176 <para>
2654 d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	177 <note>
d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	178 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	179 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	180 directive should be used instead.
d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	181 </note>
d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	182 </para>
d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	183
d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	184 <para>
1596 e491c669220e Documented http2_max_field_size, http2_max_header_size Yaroslav Zhuravlev <yar@nginx.com> parents: 1580 diff changeset	185 Limits the maximum size of
2831 4add6ae1296f Updated links to datatracker.ietf.org. Sergey Kandaurov <pluknet@nginx.com> parents: 2794 diff changeset	186 an <link url="https://datatracker.ietf.org/doc/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	187 request header field.
e491c669220e Documented http2_max_field_size, http2_max_header_size Yaroslav Zhuravlev <yar@nginx.com> parents: 1580 diff changeset	188 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	189 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	190 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	191 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	192 </para>
e491c669220e Documented http2_max_field_size, http2_max_header_size Yaroslav Zhuravlev <yar@nginx.com> parents: 1580 diff changeset	193
e491c669220e Documented http2_max_field_size, http2_max_header_size Yaroslav Zhuravlev <yar@nginx.com> parents: 1580 diff changeset	194 </directive>
e491c669220e Documented http2_max_field_size, http2_max_header_size Yaroslav Zhuravlev <yar@nginx.com> parents: 1580 diff changeset	195
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 <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	198 <syntax><value>size</value></syntax>
e491c669220e Documented http2_max_field_size, http2_max_header_size Yaroslav Zhuravlev <yar@nginx.com> parents: 1580 diff changeset	199 <default>16k</default>
e491c669220e Documented http2_max_field_size, http2_max_header_size Yaroslav Zhuravlev <yar@nginx.com> parents: 1580 diff changeset	200 <context>http</context>
e491c669220e Documented http2_max_field_size, http2_max_header_size Yaroslav Zhuravlev <yar@nginx.com> parents: 1580 diff changeset	201 <context>server</context>
e491c669220e Documented http2_max_field_size, http2_max_header_size Yaroslav Zhuravlev <yar@nginx.com> parents: 1580 diff changeset	202
e491c669220e Documented http2_max_field_size, http2_max_header_size Yaroslav Zhuravlev <yar@nginx.com> parents: 1580 diff changeset	203 <para>
2654 d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	204 <note>
d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	205 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	206 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	207 directive should be used instead.
d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	208 </note>
d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	209 </para>
d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	210
d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	211 <para>
1596 e491c669220e Documented http2_max_field_size, http2_max_header_size Yaroslav Zhuravlev <yar@nginx.com> parents: 1580 diff changeset	212 Limits the maximum size of the entire request header list after
2831 4add6ae1296f Updated links to datatracker.ietf.org. Sergey Kandaurov <pluknet@nginx.com> parents: 2794 diff changeset	213 <link url="https://datatracker.ietf.org/doc/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	214 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	215 </para>
e491c669220e Documented http2_max_field_size, http2_max_header_size Yaroslav Zhuravlev <yar@nginx.com> parents: 1580 diff changeset	216
e491c669220e Documented http2_max_field_size, http2_max_header_size Yaroslav Zhuravlev <yar@nginx.com> parents: 1580 diff changeset	217 </directive>
e491c669220e Documented http2_max_field_size, http2_max_header_size Yaroslav Zhuravlev <yar@nginx.com> parents: 1580 diff changeset	218
e491c669220e Documented http2_max_field_size, http2_max_header_size Yaroslav Zhuravlev <yar@nginx.com> parents: 1580 diff changeset	219
1834 1d0811707e09 Documented the "http2_max_requests" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1707 diff changeset	220 <directive name="http2_max_requests">
1d0811707e09 Documented the "http2_max_requests" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1707 diff changeset	221 <syntax><value>number</value></syntax>
1d0811707e09 Documented the "http2_max_requests" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1707 diff changeset	222 <default>1000</default>
1d0811707e09 Documented the "http2_max_requests" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1707 diff changeset	223 <context>http</context>
1d0811707e09 Documented the "http2_max_requests" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1707 diff changeset	224 <context>server</context>
1d0811707e09 Documented the "http2_max_requests" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1707 diff changeset	225 <appeared-in>1.11.6</appeared-in>
1d0811707e09 Documented the "http2_max_requests" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1707 diff changeset	226
1d0811707e09 Documented the "http2_max_requests" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1707 diff changeset	227 <para>
2654 d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	228 <note>
d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	229 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	230 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	231 directive should be used instead.
d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	232 </note>
d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	233 </para>
d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	234
d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	235 <para>
2105 d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	236 Sets the maximum number of requests (including
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	237 <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	238 through one HTTP/2 connection,
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	239 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	240 and the need of establishing a new connection.
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	241 </para>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	242
2450 a26a42699207 Added note about max number of keepalive requests. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	243 <para>
a26a42699207 Added note about max number of keepalive requests. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	244 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	245 per-connection memory allocations.
a26a42699207 Added note about max number of keepalive requests. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	246 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	247 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	248 </para>
a26a42699207 Added note about max number of keepalive requests. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	249
2105 d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	250 </directive>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	251
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 <directive name="http2_push">
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	254 <syntax><value>uri</value> \| <literal>off</literal></syntax>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	255 <default>off</default>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	256 <context>http</context>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	257 <context>server</context>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	258 <context>location</context>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	259 <appeared-in>1.13.9</appeared-in>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	260
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	261 <para>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	262 Pre-emptively sends
2831 4add6ae1296f Updated links to datatracker.ietf.org. Sergey Kandaurov <pluknet@nginx.com> parents: 2794 diff changeset	263 (<link url="https://datatracker.ietf.org/doc/html/rfc7540#section-8.2">pushes</link>)
2105 d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	264 a request to the specified <value>uri</value>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	265 along with the response to the original request.
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	266 Only relative URIs with absolute path will be processed,
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	267 for example:
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	268 <example>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	269 http2_push /static/css/main.css;
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	270 </example>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	271 The <value>uri</value> value can contain variables.
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	272 </para>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	273
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	274 <para>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	275 Several <literal>http2_push</literal> directives
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	276 can be specified on the same configuration level.
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	277 The <literal>off</literal> parameter cancels the effect
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	278 of the <literal>http2_push</literal> directives
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	279 inherited from the previous configuration level.
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	280 </para>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	281
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	282 </directive>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	283
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 <directive name="http2_push_preload">
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	286 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	287 <default>off</default>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	288 <context>http</context>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	289 <context>server</context>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	290 <context>location</context>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	291 <appeared-in>1.13.9</appeared-in>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	292
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	293 <para>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	294 Enables automatic conversion of
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	295 <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	296 links</link>
d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	297 specified in the <header>Link</header> response header fields into
2831 4add6ae1296f Updated links to datatracker.ietf.org. Sergey Kandaurov <pluknet@nginx.com> parents: 2794 diff changeset	298 <link url="https://datatracker.ietf.org/doc/html/rfc7540#section-8.2">push</link>
2105 d45887ccafde Documented HTTP/2 server push. Yaroslav Zhuravlev <yar@nginx.com> parents: 2038 diff changeset	299 requests.
1834 1d0811707e09 Documented the "http2_max_requests" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1707 diff changeset	300 </para>
1d0811707e09 Documented the "http2_max_requests" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1707 diff changeset	301
1d0811707e09 Documented the "http2_max_requests" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1707 diff changeset	302 </directive>
1d0811707e09 Documented the "http2_max_requests" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1707 diff changeset	303
1d0811707e09 Documented the "http2_max_requests" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1707 diff changeset	304
1566 0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	305 <directive name="http2_recv_buffer_size">
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	306 <syntax><value>size</value></syntax>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	307 <default>256k</default>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	308 <context>http</context>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	309
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	310 <para>
1666 08f48ecb13ba Added a hyperlink to http2_recv_buffer_size. Yaroslav Zhuravlev <yar@nginx.com> parents: 1659 diff changeset	311 Sets the size of the per
08f48ecb13ba Added a hyperlink to http2_recv_buffer_size. Yaroslav Zhuravlev <yar@nginx.com> parents: 1659 diff changeset	312 <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	313 input buffer.
1566 0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	314 </para>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	315
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	316 </directive>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	317
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 <directive name="http2_recv_timeout">
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	320 <syntax><value>time</value></syntax>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	321 <default>30s</default>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	322 <context>http</context>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	323 <context>server</context>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	324
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	325 <para>
2654 d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	326 <note>
d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	327 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	328 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	329 directive should be used instead.
d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	330 </note>
d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	331 </para>
d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	332
d13341d3c54a Marked some directives as obsolete in HTTP/2. Yaroslav Zhuravlev <yar@nginx.com> parents: 2567 diff changeset	333 <para>
1566 0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	334 Sets the timeout for expecting more data from the client,
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	335 after which the connection is closed.
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	336 </para>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	337
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	338 </directive>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	339
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	340 </section>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	341
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 <section id="variables" name="Embedded Variables">
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	344
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	345 <para>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	346 The <literal>ngx_http_v2_module</literal> module
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	347 supports the following embedded variables:
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	348 <list type="tag" compact="no">
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	349
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	350 <tag-name id="var_http2"><var>$http2</var></tag-name>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	351 <tag-desc>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	352 negotiated protocol identifier:
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	353 “<literal>h2</literal>” for HTTP/2 over TLS,
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	354 “<literal>h2c</literal>” for HTTP/2 over cleartext TCP,
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	355 or an empty string otherwise.
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	356 </tag-desc>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	357
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	358 </list>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	359 </para>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	360
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	361 </section>
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	362
0ca33afb461b Added the http2 module. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	363 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_v2_module.xml @ 2972:9a8d15333a58