Mercurial > hg > nginx-quic

comparison README @ 8488:8422570f6af4 quic

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
README: updated after QUIC RFC publication, nginx 1.21 rebase.
author Sergey Kandaurov <pluknet@nginx.com>
date Fri, 28 May 2021 13:45:09 +0300
parents 4117aa7fa38e
children f0882db8c8d4
comparison
equal deleted inserted replaced
8487:d514f88053e5 8488:8422570f6af4
13 13
14 This is an experimental QUIC [1] / HTTP/3 [2] support for nginx. 14 This is an experimental QUIC [1] / HTTP/3 [2] support for nginx.
15 15
16 The code is developed in a separate "quic" branch available 16 The code is developed in a separate "quic" branch available
17 at https://hg.nginx.org/nginx-quic. Currently it is based 17 at https://hg.nginx.org/nginx-quic. Currently it is based
18 on nginx mainline 1.19.x. We merge new nginx releases into 18 on nginx mainline 1.21.x. We merge new nginx releases into
19 this branch regularly. 19 this branch regularly.
20 20
21 The project code base is under the same BSD license as nginx. 21 The project code base is under the same BSD license as nginx.
22 22
23 The code is currently at a beta level of quality and should not 23 The code is currently at a beta level of quality and should not
32 32
33 You can always contact us via nginx-devel mailing list [3]. 33 You can always contact us via nginx-devel mailing list [3].
34 34
35 What works now: 35 What works now:
36 36
37 Currently we support IETF-QUIC draft-29 through draft-34. 37 Currently we support IETF-QUIC draft-29 through final RFC documents.
38 Earlier drafts are NOT supported as they have incompatible wire format. 38 Earlier drafts are NOT supported as they have incompatible wire format.
39 39
40 nginx should be able to respond to HTTP/3 requests over QUIC and 40 nginx should be able to respond to HTTP/3 requests over QUIC and
41 it should be possible to upload and download big files without errors. 41 it should be possible to upload and download big files without errors.
42 42
64 a lot of things may not work as expected, for example: 64 a lot of things may not work as expected, for example:
65 65
66 - Flow control mechanism is basic and intended to avoid CPU hog and make 66 - Flow control mechanism is basic and intended to avoid CPU hog and make
67 simple interactions possible 67 simple interactions possible
68 68
69 - Not all draft requirements are strictly followed; some of checks are 69 - Not all protocol requirements are strictly followed; some of checks are
70 omitted for the sake of simplicity of initial implementation 70 omitted for the sake of simplicity of initial implementation
71 71
72 2. Installing 72 2. Installing
73 73
74 You will need a BoringSSL [4] library that provides QUIC support 74 You will need a BoringSSL [4] library that provides QUIC support
240 If you are willing to contribute, please refer to 240 If you are willing to contribute, please refer to
241 http://nginx.org/en/docs/contributing_changes.html 241 http://nginx.org/en/docs/contributing_changes.html
242 242
243 7. Links 243 7. Links
244 244
245 [1] https://tools.ietf.org/html/draft-ietf-quic-transport 245 [1] https://datatracker.ietf.org/doc/html/rfc9000
246 [2] https://tools.ietf.org/html/draft-ietf-quic-http 246 [2] https://datatracker.ietf.org/doc/html/draft-ietf-quic-http
247 [3] https://mailman.nginx.org/mailman/listinfo/nginx-devel 247 [3] https://mailman.nginx.org/mailman/listinfo/nginx-devel
248 [4] https://boringssl.googlesource.com/boringssl/ 248 [4] https://boringssl.googlesource.com/boringssl/
249 [5] https://tools.ietf.org/html/draft-ietf-quic-recovery 249 [5] https://datatracker.ietf.org/doc/html/rfc9002
250 [6] https://nginx.org/en/docs/http/ngx_http_core_module.html#listen 250 [6] https://nginx.org/en/docs/http/ngx_http_core_module.html#listen
251 [7] https://nginx.org/en/docs/debugging_log.html 251 [7] https://nginx.org/en/docs/debugging_log.html