Mercurial > hg > nginx
annotate README @ 9103:b9230e37b8a1 quic
QUIC: removed "quic_mtu" directive.
The directive used to set the value of the "max_udp_payload_size" transport
parameter. According to RFC 9000, Section 18.2, the value specifies the size
of buffer for reading incoming datagrams:
This limit does act as an additional constraint on datagram size in
the same way as the path MTU, but it is a property of the endpoint
and not the path; see Section 14. It is expected that this is the
space an endpoint dedicates to holding incoming packets.
Current QUIC implementation uses the maximum possible buffer size (65527) for
reading datagrams.
author | Roman Arutyunyan <arut@nginx.com> |
---|---|
date | Thu, 11 May 2023 10:37:51 +0400 |
parents | 8347620e0e76 |
children | 113e2438dbd4 |
rev | line source |
---|---|
8366 | 1 Experimental QUIC support for nginx |
2 ----------------------------------- | |
3 | |
4 1. Introduction | |
9074 | 5 2. Building from sources |
8366 | 6 3. Configuration |
9074 | 7 4. Directives |
8 5. Clients | |
9 6. Troubleshooting | |
10 7. Contributing | |
11 8. Links | |
8366 | 12 |
13 1. Introduction | |
14 | |
15 This is an experimental QUIC [1] / HTTP/3 [2] support for nginx. | |
16 | |
17 The code is developed in a separate "quic" branch available | |
18 at https://hg.nginx.org/nginx-quic. Currently it is based | |
9021
8d0753760546
Merged with the default branch.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9019
diff
changeset
|
19 on nginx mainline 1.23.x. We merge new nginx releases into |
8601
dd8e50e11bfc
QUIC: updated README.
Sergey Kandaurov <pluknet@nginx.com>
parents:
8547
diff
changeset
|
20 this branch regularly. |
8366 | 21 |
22 The project code base is under the same BSD license as nginx. | |
23 | |
9028
98e94553ae51
README: updated the current status.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9021
diff
changeset
|
24 The code is currently at a beta level of quality, however |
98e94553ae51
README: updated the current status.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9021
diff
changeset
|
25 there are several production deployments with it. |
8366 | 26 |
9034
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
27 NGINX Development Team is working on improving HTTP/3 support to |
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
28 integrate it into the main NGINX codebase. Thus, expect further |
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
29 updates of this code, including features, changes in behaviour, |
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
30 bug fixes, and refactoring. NGINX Development team will be |
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
31 grateful for any feedback and code submissions. |
8366 | 32 |
9034
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
33 Please contact NGINX Development Team via nginx-devel mailing list [3]. |
8366 | 34 |
35 What works now: | |
36 | |
9034
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
37 IETF QUIC version 1 is supported. Internet drafts are no longer supported. |
8366 | 38 |
8601
dd8e50e11bfc
QUIC: updated README.
Sergey Kandaurov <pluknet@nginx.com>
parents:
8547
diff
changeset
|
39 nginx should be able to respond to HTTP/3 requests over QUIC and |
8366 | 40 it should be possible to upload and download big files without errors. |
41 | |
42 + The handshake completes successfully | |
43 + One endpoint can update keys and its peer responds correctly | |
8390 | 44 + 0-RTT data is being received and acted on |
8366 | 45 + Connection is established using TLS Resume Ticket |
8389
2b580ac17a47
README: Retry support, protocol error messages implemented.
Sergey Kandaurov <pluknet@nginx.com>
parents:
8373
diff
changeset
|
46 + A handshake that includes a Retry packet completes successfully |
8366 | 47 + Stream data is being exchanged and ACK'ed |
48 + An H3 transaction succeeded | |
49 + One or both endpoints insert entries into dynamic table and | |
50 subsequently reference them from header blocks | |
8527 | 51 + Version Negotiation packet is sent to client with unknown version |
52 + Lost packets are detected and retransmitted properly | |
8763
4117aa7fa38e
QUIC: connection migration.
Vladimir Homutov <vl@nginx.com>
parents:
8747
diff
changeset
|
53 + Clients may migrate to new address |
8366 | 54 |
9073
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
55 2. Building from sources |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
56 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
57 The build is configured using the configure command. |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
58 Refer to http://nginx.org/en/docs/configure.html for details. |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
59 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
60 When configuring nginx, it's possible to enable QUIC and HTTP/3 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
61 using the following new configuration options: |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
62 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
63 --with-http_v3_module - enable QUIC and HTTP/3 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
64 --with-stream_quic_module - enable QUIC in Stream |
8366 | 65 |
9080
7da4791e0264
QUIC: OpenSSL compatibility layer.
Roman Arutyunyan <arut@nginx.com>
parents:
9074
diff
changeset
|
66 A library that provides QUIC support is recommended to build nginx, there |
9034
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
67 are several of those available on the market: |
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
68 + BoringSSL [4] |
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
69 + LibreSSL [5] |
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
70 + QuicTLS [6] |
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
71 |
9080
7da4791e0264
QUIC: OpenSSL compatibility layer.
Roman Arutyunyan <arut@nginx.com>
parents:
9074
diff
changeset
|
72 Alternatively, nginx can be configured with OpenSSL compatibility |
7da4791e0264
QUIC: OpenSSL compatibility layer.
Roman Arutyunyan <arut@nginx.com>
parents:
9074
diff
changeset
|
73 layer, which emulates BoringSSL QUIC API for OpenSSL. This mode is |
7da4791e0264
QUIC: OpenSSL compatibility layer.
Roman Arutyunyan <arut@nginx.com>
parents:
9074
diff
changeset
|
74 enabled by default if native QUIC support is not detected. |
7da4791e0264
QUIC: OpenSSL compatibility layer.
Roman Arutyunyan <arut@nginx.com>
parents:
9074
diff
changeset
|
75 0-RTT is not supported in OpenSSL compatibility mode. |
7da4791e0264
QUIC: OpenSSL compatibility layer.
Roman Arutyunyan <arut@nginx.com>
parents:
9074
diff
changeset
|
76 |
9034
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
77 Clone the NGINX QUIC repository |
8366 | 78 |
8373
796b5b6c43cd
Mention quic branch in README.
Sergey Kandaurov <pluknet@nginx.com>
parents:
8372
diff
changeset
|
79 $ hg clone -b quic https://hg.nginx.org/nginx-quic |
8366 | 80 $ cd nginx-quic |
9034
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
81 |
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
82 Use the following command to configure nginx with BoringSSL [4] |
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
83 |
8966
6f8253673669
README: documented QuicTLS support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
8929
diff
changeset
|
84 $ ./auto/configure --with-debug --with-http_v3_module \ |
6f8253673669
README: documented QuicTLS support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
8929
diff
changeset
|
85 --with-cc-opt="-I../boringssl/include" \ |
6f8253673669
README: documented QuicTLS support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
8929
diff
changeset
|
86 --with-ld-opt="-L../boringssl/build/ssl \ |
8372
0e6528551f26
Configure: unbreak with old OpenSSL, --with-http_v3_module added.
Sergey Kandaurov <pluknet@nginx.com>
parents:
8366
diff
changeset
|
87 -L../boringssl/build/crypto" |
8366 | 88 $ make |
89 | |
9034
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
90 Alternatively, nginx can be configured with QuicTLS [6] |
8966
6f8253673669
README: documented QuicTLS support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
8929
diff
changeset
|
91 |
6f8253673669
README: documented QuicTLS support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
8929
diff
changeset
|
92 $ ./auto/configure --with-debug --with-http_v3_module \ |
6f8253673669
README: documented QuicTLS support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
8929
diff
changeset
|
93 --with-cc-opt="-I../quictls/build/include" \ |
6f8253673669
README: documented QuicTLS support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
8929
diff
changeset
|
94 --with-ld-opt="-L../quictls/build/lib" |
6f8253673669
README: documented QuicTLS support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
8929
diff
changeset
|
95 |
9034
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
96 Alternatively, nginx can be configured with a modern version |
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
97 of LibreSSL [7] |
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
98 |
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
99 $ ./auto/configure --with-debug --with-http_v3_module \ |
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
100 --with-cc-opt="-I../libressl/build/include" \ |
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
101 --with-ld-opt="-L../libressl/build/lib" |
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
102 |
8366 | 103 3. Configuration |
104 | |
9081
c851a2ed5ce8
HTTP/3: "quic" parameter of "listen" directive.
Roman Arutyunyan <arut@nginx.com>
parents:
9080
diff
changeset
|
105 The HTTP "listen" directive got a new option "quic" which enables |
c851a2ed5ce8
HTTP/3: "quic" parameter of "listen" directive.
Roman Arutyunyan <arut@nginx.com>
parents:
9080
diff
changeset
|
106 QUIC as client transport protocol instead of TCP. |
8366 | 107 |
8487
6e84524886d4
QUIC: updated README to mention "quic" listen parameter.
Roman Arutyunyan <arut@nginx.com>
parents:
8449
diff
changeset
|
108 The Stream "listen" directive got a new option "quic" which enables |
6e84524886d4
QUIC: updated README to mention "quic" listen parameter.
Roman Arutyunyan <arut@nginx.com>
parents:
8449
diff
changeset
|
109 QUIC as client transport protocol instead of TCP or plain UDP. |
6e84524886d4
QUIC: updated README to mention "quic" listen parameter.
Roman Arutyunyan <arut@nginx.com>
parents:
8449
diff
changeset
|
110 |
9081
c851a2ed5ce8
HTTP/3: "quic" parameter of "listen" directive.
Roman Arutyunyan <arut@nginx.com>
parents:
9080
diff
changeset
|
111 Along with "quic", it's also possible to specify "reuseport" |
9034
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
112 option [8] to make it work properly with multiple workers. |
8366 | 113 |
8402
af22b60a905b
README: documented Retry, 0-RTT, TLSv1.3 configuration.
Sergey Kandaurov <pluknet@nginx.com>
parents:
8396
diff
changeset
|
114 To enable address validation: |
af22b60a905b
README: documented Retry, 0-RTT, TLSv1.3 configuration.
Sergey Kandaurov <pluknet@nginx.com>
parents:
8396
diff
changeset
|
115 |
af22b60a905b
README: documented Retry, 0-RTT, TLSv1.3 configuration.
Sergey Kandaurov <pluknet@nginx.com>
parents:
8396
diff
changeset
|
116 quic_retry on; |
af22b60a905b
README: documented Retry, 0-RTT, TLSv1.3 configuration.
Sergey Kandaurov <pluknet@nginx.com>
parents:
8396
diff
changeset
|
117 |
af22b60a905b
README: documented Retry, 0-RTT, TLSv1.3 configuration.
Sergey Kandaurov <pluknet@nginx.com>
parents:
8396
diff
changeset
|
118 To enable 0-RTT: |
af22b60a905b
README: documented Retry, 0-RTT, TLSv1.3 configuration.
Sergey Kandaurov <pluknet@nginx.com>
parents:
8396
diff
changeset
|
119 |
af22b60a905b
README: documented Retry, 0-RTT, TLSv1.3 configuration.
Sergey Kandaurov <pluknet@nginx.com>
parents:
8396
diff
changeset
|
120 ssl_early_data on; |
af22b60a905b
README: documented Retry, 0-RTT, TLSv1.3 configuration.
Sergey Kandaurov <pluknet@nginx.com>
parents:
8396
diff
changeset
|
121 |
8819
d0ef43a53a51
QUIC: updated README with GSO details.
Vladimir Homutov <vl@nginx.com>
parents:
8804
diff
changeset
|
122 To enable GSO (Generic Segmentation Offloading): |
d0ef43a53a51
QUIC: updated README with GSO details.
Vladimir Homutov <vl@nginx.com>
parents:
8804
diff
changeset
|
123 |
d0ef43a53a51
QUIC: updated README with GSO details.
Vladimir Homutov <vl@nginx.com>
parents:
8804
diff
changeset
|
124 quic_gso on; |
d0ef43a53a51
QUIC: updated README with GSO details.
Vladimir Homutov <vl@nginx.com>
parents:
8804
diff
changeset
|
125 |
8924
d6ef13c5fd8e
QUIC: simplified configuration.
Vladimir Homutov <vl@nginx.com>
parents:
8923
diff
changeset
|
126 To set host key for various tokens: |
d6ef13c5fd8e
QUIC: simplified configuration.
Vladimir Homutov <vl@nginx.com>
parents:
8923
diff
changeset
|
127 |
d6ef13c5fd8e
QUIC: simplified configuration.
Vladimir Homutov <vl@nginx.com>
parents:
8923
diff
changeset
|
128 quic_host_key <filename>; |
d6ef13c5fd8e
QUIC: simplified configuration.
Vladimir Homutov <vl@nginx.com>
parents:
8923
diff
changeset
|
129 |
9089
8347620e0e76
README: revised TLSv1.3 requirement for QUIC.
Roman Arutyunyan <arut@nginx.com>
parents:
9081
diff
changeset
|
130 QUIC requires TLSv1.3 protocol, which is enabled by the default |
8347620e0e76
README: revised TLSv1.3 requirement for QUIC.
Roman Arutyunyan <arut@nginx.com>
parents:
9081
diff
changeset
|
131 by "ssl_protocols" directive. |
8924
d6ef13c5fd8e
QUIC: simplified configuration.
Vladimir Homutov <vl@nginx.com>
parents:
8923
diff
changeset
|
132 |
9034
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
133 By default, GSO Linux-specific optimization [10] is disabled. |
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
134 Enable it in case a corresponding network interface is configured to |
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
135 support GSO. |
8819
d0ef43a53a51
QUIC: updated README with GSO details.
Vladimir Homutov <vl@nginx.com>
parents:
8804
diff
changeset
|
136 |
8498
affb0245e291
QUIC: added HTTP/3 directives list to README.
Roman Arutyunyan <arut@nginx.com>
parents:
8487
diff
changeset
|
137 A number of directives were added that configure HTTP/3: |
affb0245e291
QUIC: added HTTP/3 directives list to README.
Roman Arutyunyan <arut@nginx.com>
parents:
8487
diff
changeset
|
138 |
9081
c851a2ed5ce8
HTTP/3: "quic" parameter of "listen" directive.
Roman Arutyunyan <arut@nginx.com>
parents:
9080
diff
changeset
|
139 http3 |
c851a2ed5ce8
HTTP/3: "quic" parameter of "listen" directive.
Roman Arutyunyan <arut@nginx.com>
parents:
9080
diff
changeset
|
140 http3_hq |
8924
d6ef13c5fd8e
QUIC: simplified configuration.
Vladimir Homutov <vl@nginx.com>
parents:
8923
diff
changeset
|
141 http3_stream_buffer_size |
8498
affb0245e291
QUIC: added HTTP/3 directives list to README.
Roman Arutyunyan <arut@nginx.com>
parents:
8487
diff
changeset
|
142 http3_max_concurrent_pushes |
8924
d6ef13c5fd8e
QUIC: simplified configuration.
Vladimir Homutov <vl@nginx.com>
parents:
8923
diff
changeset
|
143 http3_max_concurrent_streams |
8498
affb0245e291
QUIC: added HTTP/3 directives list to README.
Roman Arutyunyan <arut@nginx.com>
parents:
8487
diff
changeset
|
144 http3_push |
affb0245e291
QUIC: added HTTP/3 directives list to README.
Roman Arutyunyan <arut@nginx.com>
parents:
8487
diff
changeset
|
145 http3_push_preload |
affb0245e291
QUIC: added HTTP/3 directives list to README.
Roman Arutyunyan <arut@nginx.com>
parents:
8487
diff
changeset
|
146 |
8923
651cc905b7c2
HTTP/3: $http3 variable.
Roman Arutyunyan <arut@nginx.com>
parents:
8922
diff
changeset
|
147 In http, an additional variable is available: $http3. |
651cc905b7c2
HTTP/3: $http3 variable.
Roman Arutyunyan <arut@nginx.com>
parents:
8922
diff
changeset
|
148 The value of $http3 is "h3" for HTTP/3 connections, |
651cc905b7c2
HTTP/3: $http3 variable.
Roman Arutyunyan <arut@nginx.com>
parents:
8922
diff
changeset
|
149 "hq" for hq connections, or an empty string otherwise. |
651cc905b7c2
HTTP/3: $http3 variable.
Roman Arutyunyan <arut@nginx.com>
parents:
8922
diff
changeset
|
150 |
651cc905b7c2
HTTP/3: $http3 variable.
Roman Arutyunyan <arut@nginx.com>
parents:
8922
diff
changeset
|
151 In stream, an additional variable is available: $quic. |
8366 | 152 The value of $quic is "quic" if QUIC connection is used, |
8788
f0882db8c8d4
HTTP/3: removed $http3 that served its purpose.
Sergey Kandaurov <pluknet@nginx.com>
parents:
8787
diff
changeset
|
153 or an empty string otherwise. |
8366 | 154 |
155 Example configuration: | |
156 | |
157 http { | |
158 log_format quic '$remote_addr - $remote_user [$time_local] ' | |
159 '"$request" $status $body_bytes_sent ' | |
8929 | 160 '"$http_referer" "$http_user_agent" "$http3"'; |
8366 | 161 |
162 access_log logs/access.log quic; | |
163 | |
164 server { | |
165 # for better compatibility it's recommended | |
166 # to use the same port for quic and https | |
9081
c851a2ed5ce8
HTTP/3: "quic" parameter of "listen" directive.
Roman Arutyunyan <arut@nginx.com>
parents:
9080
diff
changeset
|
167 listen 8443 quic reuseport; |
8366 | 168 listen 8443 ssl; |
169 | |
170 ssl_certificate certs/example.com.crt; | |
171 ssl_certificate_key certs/example.com.key; | |
172 | |
173 location / { | |
174 # required for browsers to direct them into quic port | |
8788
f0882db8c8d4
HTTP/3: removed $http3 that served its purpose.
Sergey Kandaurov <pluknet@nginx.com>
parents:
8787
diff
changeset
|
175 add_header Alt-Svc 'h3=":8443"; ma=86400'; |
8366 | 176 } |
177 } | |
178 } | |
179 | |
9073
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
180 4. Directives |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
181 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
182 Syntax: quic_bpf on | off; |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
183 Default: quic_bpf off; |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
184 Context: main |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
185 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
186 Enables routing of QUIC packets using eBPF. |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
187 When enabled, this allows to support QUIC connection migration. |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
188 The directive is only supported on Linux 5.7+. |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
189 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
190 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
191 Syntax: quic_retry on | off; |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
192 Default: quic_retry off; |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
193 Context: http | stream, server |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
194 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
195 Enables the QUIC Address Validation feature. This includes: |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
196 - sending a new token in a Retry packet or a NEW_TOKEN frame |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
197 - validating a token received in the Initial packet |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
198 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
199 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
200 Syntax: quic_gso on | off; |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
201 Default: quic_gso off; |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
202 Context: http | stream, server |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
203 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
204 Enables sending in optimized batch mode using segmentation offloading. |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
205 Optimized sending is only supported on Linux featuring UDP_SEGMENT. |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
206 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
207 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
208 Syntax: quic_host_key file; |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
209 Default: - |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
210 Context: http | stream, server |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
211 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
212 Specifies a file with the secret key used to encrypt stateless reset and |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
213 address validation tokens. By default, a randomly generated key is used. |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
214 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
215 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
216 Syntax: quic_active_connection_id_limit number; |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
217 Default: quic_active_connection_id_limit 2; |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
218 Context: http | stream, server |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
219 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
220 Sets the QUIC active_connection_id_limit transport parameter value. |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
221 This is the maximum number of connection IDs we are willing to store. |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
222 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
223 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
224 Syntax: quic_timeout time; |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
225 Default: quic_timeout 60s; |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
226 Context: stream, server |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
227 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
228 Defines a timeout used to negotiate the QUIC idle timeout. |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
229 In the http module, it is taken from the keepalive_timeout directive. |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
230 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
231 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
232 Syntax: quic_stream_buffer_size size; |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
233 Default: quic_stream_buffer_size 64k; |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
234 Context: stream, server |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
235 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
236 Syntax: http3_stream_buffer_size size; |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
237 Default: http3_stream_buffer_size 64k; |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
238 Context: http, server |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
239 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
240 Sets buffer size for reading and writing of the QUIC STREAM payload. |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
241 The buffer size is used to calculate initial flow control limits |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
242 in the following QUIC transport parameters: |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
243 - initial_max_data |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
244 - initial_max_stream_data_bidi_local |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
245 - initial_max_stream_data_bidi_remote |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
246 - initial_max_stream_data_uni |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
247 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
248 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
249 Syntax: http3_max_concurrent_pushes number; |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
250 Default: http3_max_concurrent_pushes 10; |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
251 Context: http, server |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
252 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
253 Limits the maximum number of concurrent push requests in a connection. |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
254 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
255 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
256 Syntax: http3_max_concurrent_streams number; |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
257 Default: http3_max_concurrent_streams 128; |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
258 Context: http, server |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
259 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
260 Sets the maximum number of concurrent HTTP/3 streams in a connection. |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
261 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
262 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
263 Syntax: http3_push uri | off; |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
264 Default: http3_push off; |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
265 Context: http, server, location |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
266 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
267 Pre-emptively sends (pushes) a request to the specified uri along with |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
268 the response to the original request. Only relative URIs with absolute |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
269 path will be processed, for example: |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
270 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
271 http3_push /static/css/main.css; |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
272 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
273 The uri value can contain variables. |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
274 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
275 Several http3_push directives can be specified on the same configuration |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
276 level. The off parameter cancels the effect of the http3_push directives |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
277 inherited from the previous configuration level. |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
278 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
279 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
280 Syntax: http3_push_preload on | off; |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
281 Default: http3_push_preload off; |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
282 Context: http, server, location |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
283 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
284 Enables automatic conversion of preload links specified in the “Link” |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
285 response header fields into push requests. |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
286 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
287 |
9081
c851a2ed5ce8
HTTP/3: "quic" parameter of "listen" directive.
Roman Arutyunyan <arut@nginx.com>
parents:
9080
diff
changeset
|
288 Syntax: http3 on | off; |
c851a2ed5ce8
HTTP/3: "quic" parameter of "listen" directive.
Roman Arutyunyan <arut@nginx.com>
parents:
9080
diff
changeset
|
289 Default: http3 on; |
c851a2ed5ce8
HTTP/3: "quic" parameter of "listen" directive.
Roman Arutyunyan <arut@nginx.com>
parents:
9080
diff
changeset
|
290 Context: http, server |
c851a2ed5ce8
HTTP/3: "quic" parameter of "listen" directive.
Roman Arutyunyan <arut@nginx.com>
parents:
9080
diff
changeset
|
291 |
c851a2ed5ce8
HTTP/3: "quic" parameter of "listen" directive.
Roman Arutyunyan <arut@nginx.com>
parents:
9080
diff
changeset
|
292 Enables HTTP/3 protocol negotiation. |
c851a2ed5ce8
HTTP/3: "quic" parameter of "listen" directive.
Roman Arutyunyan <arut@nginx.com>
parents:
9080
diff
changeset
|
293 |
c851a2ed5ce8
HTTP/3: "quic" parameter of "listen" directive.
Roman Arutyunyan <arut@nginx.com>
parents:
9080
diff
changeset
|
294 |
9073
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
295 Syntax: http3_hq on | off; |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
296 Default: http3_hq off; |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
297 Context: http, server |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
298 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
299 Enables HTTP/0.9 protocol negotiation used in QUIC interoperability tests. |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
300 |
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
301 5. Clients |
8366 | 302 |
303 * Browsers | |
304 | |
8982
8f5d0ade0da7
README: updated to QUICv1.
Sergey Kandaurov <pluknet@nginx.com>
parents:
8966
diff
changeset
|
305 Known to work: Firefox 90+ and Chrome 92+ (QUIC version 1) |
8366 | 306 |
307 Beware of strange issues: sometimes browser may decide to ignore QUIC | |
308 Cache clearing/restart might help. Always check access.log and | |
9034
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
309 error.log to make sure the browser is using HTTP/3 and not TCP https. |
8366 | 310 |
311 * Console clients | |
312 | |
313 Known to work: ngtcp2, firefox's neqo and chromium's console clients: | |
314 | |
315 $ examples/client 127.0.0.1 8443 https://example.com:8443/index.html | |
316 | |
317 $ ./neqo-client https://127.0.0.1:8443/ | |
318 | |
8982
8f5d0ade0da7
README: updated to QUICv1.
Sergey Kandaurov <pluknet@nginx.com>
parents:
8966
diff
changeset
|
319 $ chromium-build/out/my_build/quic_client http://example.com:8443 |
8366 | 320 |
321 | |
9034
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
322 In case everyhing is right, the access log should show something like: |
8366 | 323 |
324 127.0.0.1 - - [24/Apr/2020:11:27:29 +0300] "GET / HTTP/3" 200 805 "-" | |
8788
f0882db8c8d4
HTTP/3: removed $http3 that served its purpose.
Sergey Kandaurov <pluknet@nginx.com>
parents:
8787
diff
changeset
|
325 "nghttp3/ngtcp2 client" "quic" |
8366 | 326 |
327 | |
9073
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
328 6. Troubleshooting |
8366 | 329 |
9034
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
330 Here are some tips that may help to identify problems: |
8366 | 331 |
9034
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
332 + Ensure nginx is built with proper SSL library that supports QUIC |
8366 | 333 |
9034
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
334 + Ensure nginx is using the proper SSL library in runtime |
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
335 (`nginx -V` shows what it's using) |
8366 | 336 |
9034
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
337 + Ensure a client is actually sending requests over QUIC |
8366 | 338 (see "Clients" section about browsers and cache) |
339 | |
340 We recommend to start with simple console client like ngtcp2 | |
9034
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
341 to ensure the server is configured properly before trying |
8395 | 342 with real browsers that may be very picky with certificates, |
8366 | 343 for example. |
344 | |
9034
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
345 + Build nginx with debug support [9] and check the debug log. |
8366 | 346 It should contain all details about connection and why it |
347 failed. All related messages contain "quic " prefix and can | |
348 be easily filtered out. | |
349 | |
9034
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
350 + For a deeper investigation, please enable additional debugging |
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
351 in src/event/quic/ngx_event_quic_connection.h: |
8366 | 352 |
353 #define NGX_QUIC_DEBUG_PACKETS | |
354 #define NGX_QUIC_DEBUG_FRAMES | |
8657
2dfc5ef29973
QUIC: introduced QUIC buffers.
Roman Arutyunyan <arut@nginx.com>
parents:
8601
diff
changeset
|
355 #define NGX_QUIC_DEBUG_ALLOC |
8366 | 356 #define NGX_QUIC_DEBUG_CRYPTO |
357 | |
9073
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
358 7. Contributing |
8410
c7d1b500bd0a
Updated README with "Contributing" section and draft details.
Vladimir Homutov <vl@nginx.com>
parents:
8402
diff
changeset
|
359 |
9034
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
360 Please refer to |
8410
c7d1b500bd0a
Updated README with "Contributing" section and draft details.
Vladimir Homutov <vl@nginx.com>
parents:
8402
diff
changeset
|
361 http://nginx.org/en/docs/contributing_changes.html |
c7d1b500bd0a
Updated README with "Contributing" section and draft details.
Vladimir Homutov <vl@nginx.com>
parents:
8402
diff
changeset
|
362 |
9073
3c33d39a51d3
README: updated building from sources, added directives reference.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9034
diff
changeset
|
363 8. Links |
8366 | 364 |
8787
8422570f6af4
README: updated after QUIC RFC publication, nginx 1.21 rebase.
Sergey Kandaurov <pluknet@nginx.com>
parents:
8763
diff
changeset
|
365 [1] https://datatracker.ietf.org/doc/html/rfc9000 |
9019
0e74a77c2475
README: updated after HTTP/3 RFC publication, minor refinements.
Sergey Kandaurov <pluknet@nginx.com>
parents:
8984
diff
changeset
|
366 [2] https://datatracker.ietf.org/doc/html/rfc9114 |
9074 | 367 [3] https://mailman.nginx.org/mailman/listinfo/nginx-devel |
8366 | 368 [4] https://boringssl.googlesource.com/boringssl/ |
9034
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
369 [5] https://www.libressl.org/ |
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
370 [6] https://github.com/quictls/openssl |
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
371 [7] https://github.com/libressl-portable/portable/releases/tag/v3.6.0 |
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
372 [8] https://nginx.org/en/docs/http/ngx_http_core_module.html#listen |
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
373 [9] https://nginx.org/en/docs/debugging_log.html |
79cd6993a3e3
README: converted to passive voice, LibreSSL support.
Sergey Kandaurov <pluknet@nginx.com>
parents:
9028
diff
changeset
|
374 [10] http://vger.kernel.org/lpc_net2018_talks/willemdebruijn-lpc2018-udpgso-paper-DRAFT-1.pdf |