comparison xml/en/docs/http/ngx_http_v2_module.xml @ 2105:d45887ccafde

Documented HTTP/2 server push.
author Yaroslav Zhuravlev <yar@nginx.com>
date Thu, 15 Feb 2018 21:24:36 +0300
parents ffb3570c352c
children ca7568f67dee
comparison
equal deleted inserted replaced
2104:c2e3884f1a9c 2105:d45887ccafde
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8 8
9 <module name="Module ngx_http_v2_module" 9 <module name="Module ngx_http_v2_module"
10 link="/en/docs/http/ngx_http_v2_module.html" 10 link="/en/docs/http/ngx_http_v2_module.html"
11 lang="en" 11 lang="en"
12 rev="10"> 12 rev="11">
13 13
14 <section id="summary"> 14 <section id="summary">
15 15
16 <para> 16 <para>
17 The <literal>ngx_http_v2_module</literal> module (1.9.5) provides 17 The <literal>ngx_http_v2_module</literal> module (1.9.5) provides
125 </para> 125 </para>
126 126
127 </directive> 127 </directive>
128 128
129 129
130 <directive name="http2_max_concurrent_pushes">
131 <syntax><value>number</value></syntax>
132 <default>10</default>
133 <context>http</context>
134 <context>server</context>
135 <appeared-in>1.13.9</appeared-in>
136
137 <para>
138 Limits the maximum number of concurrent
139 <link id="http2_push">push</link> requests in a connection.
140 </para>
141
142 </directive>
143
144
130 <directive name="http2_max_concurrent_streams"> 145 <directive name="http2_max_concurrent_streams">
131 <syntax><value>number</value></syntax> 146 <syntax><value>number</value></syntax>
132 <default>128</default> 147 <default>128</default>
133 <context>http</context> 148 <context>http</context>
134 <context>server</context> 149 <context>server</context>
181 <context>http</context> 196 <context>http</context>
182 <context>server</context> 197 <context>server</context>
183 <appeared-in>1.11.6</appeared-in> 198 <appeared-in>1.11.6</appeared-in>
184 199
185 <para> 200 <para>
186 Sets the maximum number of requests that can be 201 Sets the maximum number of requests (including
187 served through one HTTP/2 connection, 202 <link id="http2_push">push</link> requests) that can be served
188 after which the connection is closed 203 through one HTTP/2 connection,
189 and the client should use a new connection. 204 after which the next client request will lead to connection closing
205 and the need of establishing a new connection.
206 </para>
207
208 </directive>
209
210
211 <directive name="http2_push">
212 <syntax><value>uri</value> | <literal>off</literal></syntax>
213 <default>off</default>
214 <context>http</context>
215 <context>server</context>
216 <context>location</context>
217 <appeared-in>1.13.9</appeared-in>
218
219 <para>
220 Pre-emptively sends
221 (<link url="https://tools.ietf.org/html/rfc7540#section-8.2">pushes</link>)
222 a request to the specified <value>uri</value>
223 along with the response to the original request.
224 Only relative URIs with absolute path will be processed,
225 for example:
226 <example>
227 http2_push /static/css/main.css;
228 </example>
229 The <value>uri</value> value can contain variables.
230 </para>
231
232 <para>
233 Several <literal>http2_push</literal> directives
234 can be specified on the same configuration level.
235 The <literal>off</literal> parameter cancels the effect
236 of the <literal>http2_push</literal> directives
237 inherited from the previous configuration level.
238 </para>
239
240 </directive>
241
242
243 <directive name="http2_push_preload">
244 <syntax><literal>on</literal> | <literal>off</literal></syntax>
245 <default>off</default>
246 <context>http</context>
247 <context>server</context>
248 <context>location</context>
249 <appeared-in>1.13.9</appeared-in>
250
251 <para>
252 Enables automatic conversion of
253 <link url="https://www.w3.org/TR/preload/#server-push-http-2">preload
254 links</link>
255 specified in the <header>Link</header> response header fields into
256 <link url="https://tools.ietf.org/html/rfc7540#section-8.2">push</link>
257 requests.
190 </para> 258 </para>
191 259
192 </directive> 260 </directive>
193 261
194 262