Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_spdy_module.xml @ 2769:16f6fa718be2
Updated TLSv1.3 support notes.
Previous notes described some early development snapshot of OpenSSL 1.1.1
with disabled TLSv1.3 by default. It was then enabled in the first alpha.
Further, the updated text covers later major releases such as OpenSSL 3.0.
| author | Sergey Kandaurov <pluknet@nginx.com> |
|---|---|
| date | Thu, 30 Sep 2021 16:29:20 +0300 |
| parents | c711a8a1a8f9 |
| children | 9a8d15333a58 |
| rev | line source |
|---|---|
| 869 | 1 <?xml version="1.0"?> |
| 2 | |
| 3 <!-- | |
| 4 Copyright (C) Nginx, Inc. | |
| 5 --> | |
| 6 | |
| 7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> | |
| 8 | |
| 9 <module name="Module ngx_http_spdy_module" | |
| 10 link="/en/docs/http/ngx_http_spdy_module.html" | |
| 11 lang="en" | |
|
1580
c711a8a1a8f9
Changed ID from "bugs" to "issues" for http/2, perl, spdy.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1578
diff
changeset
|
12 rev="10"> |
| 869 | 13 |
| 14 <section id="summary"> | |
| 15 | |
| 16 <para> | |
| 17 The <literal>ngx_http_spdy_module</literal> module provides experimental | |
| 18 support for <link url="http://www.chromium.org/spdy/spdy-protocol">SPDY</link>. | |
| 19 Currently, | |
|
1058
2ef5a63ce6e2
Documented SPDY/3.1 support.
Ruslan Ermilov <ru@nginx.com>
parents:
1051
diff
changeset
|
20 <link url="http://www.chromium.org/spdy/spdy-protocol/spdy-protocol-draft3-1">draft |
|
2ef5a63ce6e2
Documented SPDY/3.1 support.
Ruslan Ermilov <ru@nginx.com>
parents:
1051
diff
changeset
|
21 3.1</link> of SPDY protocol is implemented. |
|
2ef5a63ce6e2
Documented SPDY/3.1 support.
Ruslan Ermilov <ru@nginx.com>
parents:
1051
diff
changeset
|
22 <note> |
|
2ef5a63ce6e2
Documented SPDY/3.1 support.
Ruslan Ermilov <ru@nginx.com>
parents:
1051
diff
changeset
|
23 Before version 1.5.10, |
| 869 | 24 <link url="http://www.chromium.org/spdy/spdy-protocol/spdy-protocol-draft2">draft |
|
1058
2ef5a63ce6e2
Documented SPDY/3.1 support.
Ruslan Ermilov <ru@nginx.com>
parents:
1051
diff
changeset
|
25 2</link> of SPDY protocol was implemented. |
|
2ef5a63ce6e2
Documented SPDY/3.1 support.
Ruslan Ermilov <ru@nginx.com>
parents:
1051
diff
changeset
|
26 </note> |
| 869 | 27 </para> |
| 28 | |
| 29 <para> | |
| 30 This module is not built by default, it should be enabled with | |
| 31 the <literal>--with-http_spdy_module</literal> | |
| 32 configuration parameter. | |
| 33 </para> | |
| 34 | |
|
1561
ed420c318557
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
1447
diff
changeset
|
35 <para> |
|
ed420c318557
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
1447
diff
changeset
|
36 <note> |
|
1566
0ca33afb461b
Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1561
diff
changeset
|
37 This module was superseded by the |
|
0ca33afb461b
Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1561
diff
changeset
|
38 <link doc="ngx_http_v2_module.xml">ngx_http_v2_module</link> module |
|
0ca33afb461b
Added the http2 module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1561
diff
changeset
|
39 in 1.9.5. |
|
1561
ed420c318557
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
1447
diff
changeset
|
40 </note> |
|
ed420c318557
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
1447
diff
changeset
|
41 </para> |
|
ed420c318557
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
1447
diff
changeset
|
42 |
| 869 | 43 </section> |
| 44 | |
| 45 | |
|
1580
c711a8a1a8f9
Changed ID from "bugs" to "issues" for http/2, perl, spdy.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1578
diff
changeset
|
46 <section id="issues" name="Known Issues"> |
| 869 | 47 |
| 48 <para> | |
| 49 The module is experimental, caveat emptor applies. | |
| 50 </para> | |
| 51 | |
| 52 <para> | |
| 53 Current implementation of SPDY protocol does not support “server push”. | |
| 54 </para> | |
| 55 | |
| 56 <para> | |
|
1050
85804d815ed3
The SPDY module now supports "limit_rate".
Valentin Bartenev <vbart@nginx.com>
parents:
966
diff
changeset
|
57 In versions prior to 1.5.9, responses in SPDY connections could not be |
|
886
ca9a259cb5c8
The SPDY module does not support "limit_rate", not "limit_req".
Valentin Bartenev <vbart@nginx.com>
parents:
869
diff
changeset
|
58 <link doc="ngx_http_core_module.xml" id="limit_rate">rate limited</link>. |
| 869 | 59 </para> |
| 60 | |
|
1447
a32df48d88fc
Documented that proxy_request_buffering is on with SPDY enabled.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1058
diff
changeset
|
61 <para> |
|
a32df48d88fc
Documented that proxy_request_buffering is on with SPDY enabled.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1058
diff
changeset
|
62 Buffering of a client request body cannot be disabled |
|
a32df48d88fc
Documented that proxy_request_buffering is on with SPDY enabled.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1058
diff
changeset
|
63 regardless of |
|
a32df48d88fc
Documented that proxy_request_buffering is on with SPDY enabled.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1058
diff
changeset
|
64 <link doc="ngx_http_proxy_module.xml" id="proxy_request_buffering"/>, |
|
a32df48d88fc
Documented that proxy_request_buffering is on with SPDY enabled.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1058
diff
changeset
|
65 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_request_buffering"/>, |
|
a32df48d88fc
Documented that proxy_request_buffering is on with SPDY enabled.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1058
diff
changeset
|
66 <link doc="ngx_http_uwsgi_module.xml" id="uwsgi_request_buffering"/>, and |
|
a32df48d88fc
Documented that proxy_request_buffering is on with SPDY enabled.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1058
diff
changeset
|
67 <link doc="ngx_http_scgi_module.xml" id="scgi_request_buffering"/> |
|
a32df48d88fc
Documented that proxy_request_buffering is on with SPDY enabled.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1058
diff
changeset
|
68 directive values. |
|
a32df48d88fc
Documented that proxy_request_buffering is on with SPDY enabled.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1058
diff
changeset
|
69 </para> |
|
a32df48d88fc
Documented that proxy_request_buffering is on with SPDY enabled.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1058
diff
changeset
|
70 |
| 869 | 71 </section> |
| 72 | |
| 73 | |
| 74 <section id="example" name="Example Configuration"> | |
| 75 | |
| 76 <para> | |
| 77 <example> | |
| 78 server { | |
| 79 listen 443 ssl spdy; | |
| 80 | |
| 81 ssl_certificate server.crt; | |
| 82 ssl_certificate_key server.key; | |
| 83 ... | |
| 84 } | |
| 85 </example> | |
| 86 <note> | |
| 87 Note that in order to accept both | |
| 88 <link doc="ngx_http_ssl_module.xml">HTTPS</link> and SPDY connections | |
| 89 simultaneously on the same port, | |
| 90 <link url="http://www.openssl.org">OpenSSL</link> library used should support | |
| 91 “Next Protocol Negotiation” TLS extension, available since OpenSSL | |
| 92 version 1.0.1. | |
| 93 </note> | |
| 94 </para> | |
| 95 | |
| 96 </section> | |
| 97 | |
| 98 | |
| 99 <section id="directives" name="Directives"> | |
| 100 | |
|
1051
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
101 <directive name="spdy_chunk_size"> |
|
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
102 <syntax><value>size</value></syntax> |
|
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
103 <default>8k</default> |
|
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
104 <context>http</context> |
|
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
105 <context>server</context> |
|
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
106 <context>location</context> |
|
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
107 <appeared-in>1.5.9</appeared-in> |
|
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
108 |
|
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
109 <para> |
|
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
110 Sets the maximum size of chunks |
|
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
111 into which the response body is |
|
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
112 <link url="http://www.chromium.org/spdy/spdy-protocol/spdy-protocol-draft2#TOC-Data-frames"> |
|
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
113 sliced</link>. |
|
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
114 A too low value results in higher overhead. |
|
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
115 A too high value impairs prioritization due to |
|
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
116 <link url="http://en.wikipedia.org/wiki/Head-of-line_blocking"> |
|
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
117 HOL blocking</link>. |
|
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
118 </para> |
|
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
119 |
|
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
120 </directive> |
|
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
121 |
|
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
122 |
| 869 | 123 <directive name="spdy_headers_comp"> |
| 124 <syntax><value>level</value></syntax> | |
| 125 <default>0</default> | |
| 126 <context>http</context> | |
| 127 <context>server</context> | |
| 128 | |
| 129 <para> | |
| 966 | 130 Sets the header compression <value>level</value> of a response in a range from |
| 869 | 131 1 (fastest, less compression) to 9 (slowest, best compression). |
| 966 | 132 The special value 0 turns off the header compression. |
| 869 | 133 </para> |
| 134 | |
| 135 </directive> | |
| 136 | |
| 137 </section> | |
| 138 | |
| 139 | |
| 140 <section id="variables" name="Embedded Variables"> | |
| 141 | |
| 142 <para> | |
| 143 The <literal>ngx_http_spdy_module</literal> module | |
| 144 supports the following embedded variables: | |
| 145 <list type="tag" compact="no"> | |
| 146 | |
| 147 <tag-name id="var_spdy"><var>$spdy</var></tag-name> | |
| 148 <tag-desc> | |
| 149 SPDY protocol version for SPDY connections, | |
| 150 or an empty string otherwise; | |
| 151 </tag-desc> | |
| 152 | |
| 153 <tag-name id="var_spdy_request_priority"><var>$spdy_request_priority</var> | |
| 154 </tag-name> | |
| 155 <tag-desc> | |
| 156 request priority for SPDY connections, | |
| 157 or an empty string otherwise. | |
| 158 </tag-desc> | |
| 159 | |
| 160 </list> | |
| 161 </para> | |
| 162 | |
| 163 </section> | |
| 164 | |
| 165 </module> |