Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_spdy_module.xml @ 1191:ea85ba147fe9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
869
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
1 <?xml version="1.0"?>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
2
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
3 <!--
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
4 Copyright (C) Nginx, Inc.
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
5 -->
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
6
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
8
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
9 <module name="Module ngx_http_spdy_module"
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
10 link="/en/docs/http/ngx_http_spdy_module.html"
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
11 lang="en"
1058
2ef5a63ce6e2 Documented SPDY/3.1 support.
Ruslan Ermilov <ru@nginx.com>
parents: 1051
diff changeset
12 rev="5">
869
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
13
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
14 <section id="summary">
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
15
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
16 <para>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
17 The <literal>ngx_http_spdy_module</literal> module provides experimental
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
18 support for <link url="http://www.chromium.org/spdy/spdy-protocol">SPDY</link>.
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
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
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
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
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
27 </para>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
28
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
29 <para>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
30 This module is not built by default, it should be enabled with
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
31 the <literal>--with-http_spdy_module</literal>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
32 configuration parameter.
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
33 </para>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
34
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
35 </section>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
36
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
37
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
38 <section id="bugs" name="Known Bugs">
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
39
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
40 <para>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
41 The module is experimental, caveat emptor applies.
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
42 </para>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
43
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
44 <para>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
45 Current implementation of SPDY protocol does not support “server push”.
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
46 </para>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
47
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
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
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
51 </para>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
52
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
53 </section>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
54
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
55
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
56 <section id="example" name="Example Configuration">
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
57
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
58 <para>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
59 <example>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
60 server {
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
61 listen 443 ssl spdy;
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
62
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
63 ssl_certificate server.crt;
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
64 ssl_certificate_key server.key;
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
65 ...
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
66 }
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
67 </example>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
68 <note>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
69 Note that in order to accept both
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
70 <link doc="ngx_http_ssl_module.xml">HTTPS</link> and SPDY connections
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
71 simultaneously on the same port,
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
72 <link url="http://www.openssl.org">OpenSSL</link> library used should support
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
73 “Next Protocol Negotiation” TLS extension, available since OpenSSL
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
74 version 1.0.1.
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
75 </note>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
76 </para>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
77
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
78 </section>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
79
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
80
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
81 <section id="directives" name="Directives">
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
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
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
105 <directive name="spdy_headers_comp">
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
106 <syntax><value>level</value></syntax>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
107 <default>0</default>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
108 <context>http</context>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
109 <context>server</context>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
110
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
111 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 886
diff changeset
112 Sets the header compression <value>level</value> of a response in a range from
869
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
113 1 (fastest, less compression) to 9 (slowest, best compression).
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 886
diff changeset
114 The special value 0 turns off the header compression.
869
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
115 </para>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
116
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
117 </directive>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
118
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
119 </section>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
120
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
121
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
122 <section id="variables" name="Embedded Variables">
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
123
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
124 <para>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
125 The <literal>ngx_http_spdy_module</literal> module
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
126 supports the following embedded variables:
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
127 <list type="tag" compact="no">
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
128
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
129 <tag-name id="var_spdy"><var>$spdy</var></tag-name>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
130 <tag-desc>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
131 SPDY protocol version for SPDY connections,
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
132 or an empty string otherwise;
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
133 </tag-desc>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
134
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
135 <tag-name id="var_spdy_request_priority"><var>$spdy_request_priority</var>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
136 </tag-name>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
137 <tag-desc>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
138 request priority for SPDY connections,
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
139 or an empty string otherwise.
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
140 </tag-desc>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
141
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
142 </list>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
143 </para>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
144
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
145 </section>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
146
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
147 </module>