Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_spdy_module.xml @ 1561:ed420c318557
Updated docs for the upcoming NGINX Plus release.
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Thu, 10 Sep 2015 15:50:32 +0300 |
parents | a32df48d88fc |
children | 0ca33afb461b |
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" | |
1561
ed420c318557
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
1447
diff
changeset
|
12 rev="7"> |
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> |
ed420c318557
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
1447
diff
changeset
|
37 This module is not available in the <literal>nginx-plus-http2</literal> package. |
ed420c318557
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
1447
diff
changeset
|
38 </note> |
ed420c318557
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
1447
diff
changeset
|
39 </para> |
ed420c318557
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
1447
diff
changeset
|
40 |
869 | 41 </section> |
42 | |
43 | |
44 <section id="bugs" name="Known Bugs"> | |
45 | |
46 <para> | |
47 The module is experimental, caveat emptor applies. | |
48 </para> | |
49 | |
50 <para> | |
51 Current implementation of SPDY protocol does not support “server push”. | |
52 </para> | |
53 | |
54 <para> | |
1050
85804d815ed3
The SPDY module now supports "limit_rate".
Valentin Bartenev <vbart@nginx.com>
parents:
966
diff
changeset
|
55 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
|
56 <link doc="ngx_http_core_module.xml" id="limit_rate">rate limited</link>. |
869 | 57 </para> |
58 | |
1447
a32df48d88fc
Documented that proxy_request_buffering is on with SPDY enabled.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1058
diff
changeset
|
59 <para> |
a32df48d88fc
Documented that proxy_request_buffering is on with SPDY enabled.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1058
diff
changeset
|
60 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
|
61 regardless of |
a32df48d88fc
Documented that proxy_request_buffering is on with SPDY enabled.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1058
diff
changeset
|
62 <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
|
63 <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
|
64 <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
|
65 <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
|
66 directive values. |
a32df48d88fc
Documented that proxy_request_buffering is on with SPDY enabled.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1058
diff
changeset
|
67 </para> |
a32df48d88fc
Documented that proxy_request_buffering is on with SPDY enabled.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1058
diff
changeset
|
68 |
869 | 69 </section> |
70 | |
71 | |
72 <section id="example" name="Example Configuration"> | |
73 | |
74 <para> | |
75 <example> | |
76 server { | |
77 listen 443 ssl spdy; | |
78 | |
79 ssl_certificate server.crt; | |
80 ssl_certificate_key server.key; | |
81 ... | |
82 } | |
83 </example> | |
84 <note> | |
85 Note that in order to accept both | |
86 <link doc="ngx_http_ssl_module.xml">HTTPS</link> and SPDY connections | |
87 simultaneously on the same port, | |
88 <link url="http://www.openssl.org">OpenSSL</link> library used should support | |
89 “Next Protocol Negotiation” TLS extension, available since OpenSSL | |
90 version 1.0.1. | |
91 </note> | |
92 </para> | |
93 | |
94 </section> | |
95 | |
96 | |
97 <section id="directives" name="Directives"> | |
98 | |
1051
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
99 <directive name="spdy_chunk_size"> |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
100 <syntax><value>size</value></syntax> |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
101 <default>8k</default> |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
102 <context>http</context> |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
103 <context>server</context> |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
104 <context>location</context> |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
105 <appeared-in>1.5.9</appeared-in> |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
106 |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
107 <para> |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
108 Sets the maximum size of chunks |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
109 into which the response body is |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
110 <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
|
111 sliced</link>. |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
112 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
|
113 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
|
114 <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
|
115 HOL blocking</link>. |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
116 </para> |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
117 |
29de277bf322
Documented the "spdy_chunk_size" directive.
Yaroslav Zhuravlev <yaroslav.zhuravlev@nginx.com>
parents:
1050
diff
changeset
|
118 </directive> |
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 |
869 | 121 <directive name="spdy_headers_comp"> |
122 <syntax><value>level</value></syntax> | |
123 <default>0</default> | |
124 <context>http</context> | |
125 <context>server</context> | |
126 | |
127 <para> | |
966 | 128 Sets the header compression <value>level</value> of a response in a range from |
869 | 129 1 (fastest, less compression) to 9 (slowest, best compression). |
966 | 130 The special value 0 turns off the header compression. |
869 | 131 </para> |
132 | |
133 </directive> | |
134 | |
135 </section> | |
136 | |
137 | |
138 <section id="variables" name="Embedded Variables"> | |
139 | |
140 <para> | |
141 The <literal>ngx_http_spdy_module</literal> module | |
142 supports the following embedded variables: | |
143 <list type="tag" compact="no"> | |
144 | |
145 <tag-name id="var_spdy"><var>$spdy</var></tag-name> | |
146 <tag-desc> | |
147 SPDY protocol version for SPDY connections, | |
148 or an empty string otherwise; | |
149 </tag-desc> | |
150 | |
151 <tag-name id="var_spdy_request_priority"><var>$spdy_request_priority</var> | |
152 </tag-name> | |
153 <tag-desc> | |
154 request priority for SPDY connections, | |
155 or an empty string otherwise. | |
156 </tag-desc> | |
157 | |
158 </list> | |
159 </para> | |
160 | |
161 </section> | |
162 | |
163 </module> |