Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_v3_module.xml @ 2965:23eedf89fd5d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated QUIC documentation after QUIC code merge. - removed http3_max_concurrent_pushes, http3_push http3_push_preload, quic_mtu - updated apperared-in version - update of quic.xml, adding Rus translation
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 23 May 2023 16:44:47 +0100
parents cebca5ba84d7
children
comparison
equal deleted inserted replaced
2963:c7bf5c9a1174 2965:23eedf89fd5d
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8 8
9 <module name="Module ngx_http_v3_module" 9 <module name="Module ngx_http_v3_module"
10 link="/en/docs/http/ngx_http_v3_module.html" 10 link="/en/docs/http/ngx_http_v3_module.html"
11 lang="en" 11 lang="en"
12 rev="1"> 12 rev="2">
13 13
14 <section id="summary"> 14 <section id="summary">
15 15
16 <para> 16 <para>
17 The <literal>ngx_http_v3_module</literal> module (1.23.4) provides 17 The <literal>ngx_http_v3_module</literal> module (1.25.0) provides
18 experimental support for 18 experimental support for
19 <link url="https://datatracker.ietf.org/doc/html/rfc9114">HTTP/3</link>. 19 <link url="https://datatracker.ietf.org/doc/html/rfc9114">HTTP/3</link>.
20 </para> 20 </para>
21 21
22 <para> 22 <para>
23 This module is not built by default, it should be enabled with the 23 This module is not built by default, it should be enabled with the
24 <link doc="../configure.xml"><literal>--with-http_v3_module</literal></link> 24 <link doc="../configure.xml" id="http_v3_module"><literal>--with-http_v3_module</literal></link>
25 configuration parameter. 25 configuration parameter.
26 <note> 26 <note>
27 An SSL library that provides QUIC support 27 An SSL library that provides QUIC support
28 such as 28 such as
29 <link url="https://boringssl.googlesource.com/boringssl">BoringSSL</link>, 29 <link url="https://boringssl.googlesource.com/boringssl">BoringSSL</link>,
35 OpenSSL compatibility layer will be used that does not support 35 OpenSSL compatibility layer will be used that does not support
36 <link doc="ngx_http_ssl_module.xml" id="ssl_early_data">early data</link>. 36 <link doc="ngx_http_ssl_module.xml" id="ssl_early_data">early data</link>.
37 </note> 37 </note>
38 </para> 38 </para>
39 39
40
41 <para>
42 <note>
43 The module is available as
44 <literal>nginx-quic</literal> in
45 <link doc="../quic.xml" id="linux">prebult Linux packages</link>.
46 The module is also available as part of our
47 <commercial_version>commercial subscription</commercial_version>
48 in a separate <literal>nginx-plus-quic</literal> package.
49 </note>
50 </para>
51
52 </section> 40 </section>
53 41
54 42
55 <section id="issues" name="Known Issues"> 43 <section id="issues" name="Known Issues">
56 44
127 </para> 115 </para>
128 116
129 </directive> 117 </directive>
130 118
131 119
132 <directive name="http3_max_concurrent_pushes">
133 <syntax><value>number</value></syntax>
134 <default>10</default>
135 <context>http</context>
136 <context>server</context>
137
138 <para>
139 Limits the maximum number of concurrent
140 <link id="http3_push">push</link> requests in a connection.
141 </para>
142
143 </directive>
144
145
146 <directive name="http3_max_concurrent_streams"> 120 <directive name="http3_max_concurrent_streams">
147 <syntax><value>number</value></syntax> 121 <syntax><value>number</value></syntax>
148 <default>128</default> 122 <default>128</default>
149 <context>http</context> 123 <context>http</context>
150 <context>server</context> 124 <context>server</context>
151 125
152 <para> 126 <para>
153 Sets the maximum number of concurrent HTTP/3 request streams 127 Sets the maximum number of concurrent HTTP/3 request streams
154 in a connection. 128 in a connection.
155 </para>
156
157 </directive>
158
159
160 <directive name="http3_push">
161 <syntax><value>uri</value> | <literal>off</literal></syntax>
162 <default>off</default>
163 <context>http</context>
164 <context>server</context>
165 <context>location</context>
166
167 <para>
168 Pre-emptively sends
169 (<link url="https://datatracker.ietf.org/doc/html/rfc9114#name-server-push">pushes</link>)
170 a request to the specified <value>uri</value>
171 along with the response to the original request.
172 Only relative URIs with absolute path will be processed,
173 for example:
174 <example>
175 http3_push /static/css/main.css;
176 </example>
177 The <value>uri</value> value can contain variables.
178 </para>
179
180 <para>
181 Several <literal>http3_push</literal> directives
182 can be specified on the same configuration level.
183 The <literal>off</literal> parameter cancels the effect
184 of the <literal>http3_push</literal> directives
185 inherited from the previous configuration level.
186 </para>
187
188 </directive>
189
190
191 <directive name="http3_push_preload">
192 <syntax><literal>on</literal> | <literal>off</literal></syntax>
193 <default>off</default>
194 <context>http</context>
195 <context>server</context>
196 <context>location</context>
197
198 <para>
199 Enables automatic conversion of
200 <link url="https://www.w3.org/TR/preload/#server-push-http-3">preload
201 links</link>
202 specified in the <header>Link</header> response header fields into
203 <link url="https://datatracker.ietf.org/doc/html/rfc9114#name-server-push">push</link>
204 requests.
205 </para> 129 </para>
206 130
207 </directive> 131 </directive>
208 132
209 133
287 <para> 211 <para>
288 Sets a <value>file</value> with the secret key used to encrypt 212 Sets a <value>file</value> with the secret key used to encrypt
289 stateless reset and address validation tokens. 213 stateless reset and address validation tokens.
290 By default, a random key is generated on each reload. 214 By default, a random key is generated on each reload.
291 Tokens generated with old keys are not accepted. 215 Tokens generated with old keys are not accepted.
292 </para>
293
294 </directive>
295
296
297 <directive name="quic_mtu">
298 <syntax><value>size</value></syntax>
299 <default>65527</default>
300 <context>http</context>
301 <context>server</context>
302
303 <para>
304 Sets the
305 QUIC <literal>max_udp_payload_size</literal> transport parameter value.
306 This is the maximum UDP payload possible to receive.
307 </para> 216 </para>
308 217
309 </directive> 218 </directive>
310 219
311 220