Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_spdy_module.xml @ 2972:9a8d15333a58

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Removed obsolete SPDY documentation.
author Sergey Kandaurov <pluknet@nginx.com>
date Wed, 07 Jun 2023 14:21:30 +0400
parents c711a8a1a8f9
children
comparison
equal deleted inserted replaced
2971:a3b5c583c847 2972:9a8d15333a58
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8 8
9 <module name="Module ngx_http_spdy_module" 9 <module name="Module ngx_http_spdy_module"
10 link="/en/docs/http/ngx_http_spdy_module.html" 10 link="/en/docs/http/ngx_http_spdy_module.html"
11 lang="en" 11 lang="en"
12 rev="10"> 12 rev="11">
13 13
14 <section id="summary"> 14 <section id="summary">
15 15
16 <para> 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,
20 <link url="http://www.chromium.org/spdy/spdy-protocol/spdy-protocol-draft3-1">draft
21 3.1</link> of SPDY protocol is implemented.
22 <note>
23 Before version 1.5.10,
24 <link url="http://www.chromium.org/spdy/spdy-protocol/spdy-protocol-draft2">draft
25 2</link> of SPDY protocol was implemented.
26 </note>
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
35 <para>
36 <note>
37 This module was superseded by the 17 This module was superseded by the
38 <link doc="ngx_http_v2_module.xml">ngx_http_v2_module</link> module 18 <link doc="ngx_http_v2_module.xml">ngx_http_v2_module</link> module
39 in 1.9.5. 19 in 1.9.5.
40 </note>
41 </para>
42
43 </section>
44
45
46 <section id="issues" name="Known Issues">
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>
57 In versions prior to 1.5.9, responses in SPDY connections could not be
58 <link doc="ngx_http_core_module.xml" id="limit_rate">rate limited</link>.
59 </para>
60
61 <para>
62 Buffering of a client request body cannot be disabled
63 regardless of
64 <link doc="ngx_http_proxy_module.xml" id="proxy_request_buffering"/>,
65 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_request_buffering"/>,
66 <link doc="ngx_http_uwsgi_module.xml" id="uwsgi_request_buffering"/>, and
67 <link doc="ngx_http_scgi_module.xml" id="scgi_request_buffering"/>
68 directive values.
69 </para>
70
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
101 <directive name="spdy_chunk_size">
102 <syntax><value>size</value></syntax>
103 <default>8k</default>
104 <context>http</context>
105 <context>server</context>
106 <context>location</context>
107 <appeared-in>1.5.9</appeared-in>
108
109 <para>
110 Sets the maximum size of chunks
111 into which the response body is
112 <link url="http://www.chromium.org/spdy/spdy-protocol/spdy-protocol-draft2#TOC-Data-frames">
113 sliced</link>.
114 A too low value results in higher overhead.
115 A too high value impairs prioritization due to
116 <link url="http://en.wikipedia.org/wiki/Head-of-line_blocking">
117 HOL blocking</link>.
118 </para>
119
120 </directive>
121
122
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>
130 Sets the header compression <value>level</value> of a response in a range from
131 1 (fastest, less compression) to 9 (slowest, best compression).
132 The special value 0 turns off the header compression.
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> 20 </para>
162 21
163 </section> 22 </section>
164 23
165 </module> 24 </module>