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