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

annotate xml/en/docs/http/ngx_http_v3_module.xml @ 2957:cebca5ba84d7

Minor fixes in http/3 and OTel modules. Fixed a link to load_module in ngx_otel_module, removed obsolete text in quic.xml, fixed package name in ngx_http_v3_module.

author	Yaroslav Zhuravlev <yar@nginx.com>
date	Wed, 03 May 2023 13:15:55 +0100
parents	a85e4d126bc7
children	23eedf89fd5d

rev	line source
2956 a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	1 <?xml version="1.0"?>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	2
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	3 <!--
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	4 Copyright (C) Nginx, Inc.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	5 -->
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	6
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	8
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	9 <module name="Module ngx_http_v3_module"
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	10 link="/en/docs/http/ngx_http_v3_module.html"
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	11 lang="en"
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	12 rev="1">
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	13
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	14 <section id="summary">
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	15
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	16 <para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	17 The <literal>ngx_http_v3_module</literal> module (1.23.4) provides
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	18 experimental support for
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	19 <link url="https://datatracker.ietf.org/doc/html/rfc9114">HTTP/3</link>.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	20 </para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	21
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	22 <para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	23 This module is not built by default, it should be enabled with the
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	24 <link doc="../configure.xml"><literal>--with-http_v3_module</literal></link>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	25 configuration parameter.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	26 <note>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	27 An SSL library that provides QUIC support
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	28 such as
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	29 <link url="https://boringssl.googlesource.com/boringssl">BoringSSL</link>,
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	30 <link url="https://www.libressl.org">LibreSSL</link>, or
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	31 <link url="https://github.com/quictls/openssl">QuicTLS</link>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	32 is recommended to build and run this module.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	33 Otherwise,
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	34 when using the <link url="https://openssl.org">OpenSSL</link> library,
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	35 OpenSSL compatibility layer will be used that does not support
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	36 <link doc="ngx_http_ssl_module.xml" id="ssl_early_data">early data</link>.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	37 </note>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	38 </para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	39
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	40
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	41 <para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	42 <note>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	43 The module is available as
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	44 <literal>nginx-quic</literal> in
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	45 <link doc="../quic.xml" id="linux">prebult Linux packages</link>.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	46 The module is also available as part of our
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	47 <commercial_version>commercial subscription</commercial_version>
2957 cebca5ba84d7 Minor fixes in http/3 and OTel modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 2956 diff changeset	48 in a separate <literal>nginx-plus-quic</literal> package.
2956 a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	49 </note>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	50 </para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	51
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	52 </section>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	53
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	54
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	55 <section id="issues" name="Known Issues">
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	56
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	57 <para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	58 The module is experimental, caveat emptor applies.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	59 </para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	60
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	61 </section>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	62
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	63
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	64 <section id="example" name="Example Configuration">
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	65
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	66 <para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	67 <example>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	68 http {
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	69 log_format quic '$remote_addr - $remote_user [$time_local] '
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	70 '"$request" $status $body_bytes_sent '
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	71 '"$http_referer" "$http_user_agent" "$http3"';
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	72
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	73 access_log logs/access.log quic;
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	74
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	75 server {
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	76 # for better compatibility it's recommended
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	77 # to use the same port for http/3 and https
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	78 listen 8443 quic reuseport;
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	79 listen 8443 ssl;
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	80
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	81 ssl_certificate certs/example.com.crt;
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	82 ssl_certificate_key certs/example.com.key;
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	83
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	84 location / {
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	85 # used to advertise the availability of HTTP/3
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	86 add_header Alt-Svc 'h3=":8443"; ma=86400';
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	87 }
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	88 }
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	89 }
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	90 </example>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	91 Note that accepting HTTP/3 connections over TLS requires
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	92 the TLSv1.3 protocol support, which is available since
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	93 <link url="http://www.openssl.org">OpenSSL</link> version 1.1.1.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	94 </para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	95
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	96 </section>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	97
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	98
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	99 <section id="directives" name="Directives">
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	100
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	101 <directive name="http3">
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	102 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	103 <default>on</default>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	104 <context>http</context>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	105 <context>server</context>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	106
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	107 <para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	108 Enables
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	109 <link url="https://datatracker.ietf.org/doc/html/rfc9114">HTTP/3</link>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	110 protocol negotiation.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	111 </para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	112
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	113 </directive>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	114
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	115
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	116 <directive name="http3_hq">
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	117 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	118 <default>off</default>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	119 <context>http</context>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	120 <context>server</context>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	121
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	122 <para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	123 Enables HTTP/0.9 protocol negotiation
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	124 used in
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	125 <link url="https://github.com/marten-seemann/quic-interop-runner">QUIC
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	126 interoperability tests</link>.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	127 </para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	128
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	129 </directive>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	130
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	131
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	132 <directive name="http3_max_concurrent_pushes">
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	133 <syntax><value>number</value></syntax>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	134 <default>10</default>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	135 <context>http</context>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	136 <context>server</context>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	137
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	138 <para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	139 Limits the maximum number of concurrent
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	140 <link id="http3_push">push</link> requests in a connection.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	141 </para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	142
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	143 </directive>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	144
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	145
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	146 <directive name="http3_max_concurrent_streams">
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	147 <syntax><value>number</value></syntax>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	148 <default>128</default>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	149 <context>http</context>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	150 <context>server</context>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	151
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	152 <para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	153 Sets the maximum number of concurrent HTTP/3 request streams
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	154 in a connection.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	155 </para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	156
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	157 </directive>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	158
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	159
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	160 <directive name="http3_push">
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	161 <syntax><value>uri</value> \| <literal>off</literal></syntax>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	162 <default>off</default>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	163 <context>http</context>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	164 <context>server</context>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	165 <context>location</context>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	166
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	167 <para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	168 Pre-emptively sends
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	169 (<link url="https://datatracker.ietf.org/doc/html/rfc9114#name-server-push">pushes</link>)
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	170 a request to the specified <value>uri</value>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	171 along with the response to the original request.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	172 Only relative URIs with absolute path will be processed,
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	173 for example:
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	174 <example>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	175 http3_push /static/css/main.css;
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	176 </example>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	177 The <value>uri</value> value can contain variables.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	178 </para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	179
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	180 <para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	181 Several <literal>http3_push</literal> directives
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	182 can be specified on the same configuration level.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	183 The <literal>off</literal> parameter cancels the effect
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	184 of the <literal>http3_push</literal> directives
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	185 inherited from the previous configuration level.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	186 </para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	187
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	188 </directive>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	189
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	190
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	191 <directive name="http3_push_preload">
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	192 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	193 <default>off</default>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	194 <context>http</context>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	195 <context>server</context>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	196 <context>location</context>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	197
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	198 <para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	199 Enables automatic conversion of
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	200 <link url="https://www.w3.org/TR/preload/#server-push-http-3">preload
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	201 links</link>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	202 specified in the <header>Link</header> response header fields into
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	203 <link url="https://datatracker.ietf.org/doc/html/rfc9114#name-server-push">push</link>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	204 requests.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	205 </para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	206
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	207 </directive>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	208
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	209
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	210 <directive name="http3_stream_buffer_size">
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	211 <syntax><value>size</value></syntax>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	212 <default>64k</default>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	213 <context>http</context>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	214 <context>server</context>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	215
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	216 <para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	217 Sets the size of the buffer used for reading and writing of the
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	218 QUIC streams.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	219 </para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	220
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	221 </directive>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	222
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	223
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	224 <directive name="quic_active_connection_id_limit">
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	225 <syntax><value>number</value></syntax>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	226 <default>2</default>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	227 <context>http</context>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	228 <context>server</context>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	229
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	230 <para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	231 Sets the
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	232 QUIC <literal>active_connection_id_limit</literal> transport parameter value.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	233 This is the maximum number of client connection IDs
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	234 which can be stored on the server.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	235 </para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	236
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	237 </directive>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	238
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	239
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	240 <directive name="quic_bpf">
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	241 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	242 <default>off</default>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	243 <context>main</context>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	244
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	245 <para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	246 Enables routing of QUIC packets using
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	247 <link url="https://ebpf.io/">eBPF</link>.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	248 When enabled, this allows supporting QUIC connection migration.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	249 </para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	250
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	251 <para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	252 <note>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	253 The directive is only supported on Linux 5.7+.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	254 </note>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	255 </para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	256
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	257 </directive>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	258
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	259
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	260 <directive name="quic_gso">
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	261 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	262 <default>off</default>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	263 <context>http</context>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	264 <context>server</context>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	265
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	266 <para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	267 Enables sending in optimized batch mode
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	268 using segmentation offloading.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	269 </para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	270
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	271 <para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	272 <note>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	273 Optimized sending is supported only on Linux
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	274 featuring <literal>UDP_SEGMENT</literal>.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	275 </note>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	276 </para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	277
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	278 </directive>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	279
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	280
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	281 <directive name="quic_host_key">
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	282 <syntax><value>file</value></syntax>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	283 <default/>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	284 <context>http</context>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	285 <context>server</context>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	286
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	287 <para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	288 Sets a <value>file</value> with the secret key used to encrypt
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	289 stateless reset and address validation tokens.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	290 By default, a random key is generated on each reload.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	291 Tokens generated with old keys are not accepted.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	292 </para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	293
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	294 </directive>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	295
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	296
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	297 <directive name="quic_mtu">
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	298 <syntax><value>size</value></syntax>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	299 <default>65527</default>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	300 <context>http</context>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	301 <context>server</context>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	302
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	303 <para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	304 Sets the
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	305 QUIC <literal>max_udp_payload_size</literal> transport parameter value.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	306 This is the maximum UDP payload possible to receive.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	307 </para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	308
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	309 </directive>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	310
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	311
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	312 <directive name="quic_retry">
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	313 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	314 <default>off</default>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	315 <context>http</context>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	316 <context>server</context>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	317
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	318 <para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	319 Enables the
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	320 <link url="https://datatracker.ietf.org/doc/html/rfc9000#name-address-validation">QUIC
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	321 Address Validation</link> feature.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	322 This includes sending a new token in a <literal>Retry</literal> packet
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	323 or a <literal>NEW_TOKEN</literal> frame
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	324 and
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	325 validating a token received in the <literal>Initial</literal> packet.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	326 </para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	327
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	328 </directive>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	329
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	330 </section>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	331
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	332
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	333 <section id="variables" name="Embedded Variables">
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	334
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	335 <para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	336 The <literal>ngx_http_v3_module</literal> module
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	337 supports the following embedded variables:
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	338 <list type="tag" compact="no">
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	339
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	340 <tag-name id="var_http3"><var>$http3</var></tag-name>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	341 <tag-desc>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	342 negotiated protocol identifier:
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	343 “<literal>h3</literal>” for HTTP/3 connections,
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	344 “<literal>hq</literal>” for hq connections,
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	345 or an empty string otherwise.
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	346 </tag-desc>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	347
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	348 </list>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	349 </para>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	350
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	351 </section>
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	352
a85e4d126bc7 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	353 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_v3_module.xml @ 2957:cebca5ba84d7