annotate xml/en/docs/http/ngx_http_spdy_module.xml @ 869:ade81792bdaa

Documented SPDY support. New SPDY module added and the "listen" directive description is updated.
author Homutov Vladimir <vl@nginx.com>
date Wed, 20 Mar 2013 15:00:06 +0400
parents
children ca9a259cb5c8
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"
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
12 rev="1">
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,
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
20 <link url="http://www.chromium.org/spdy/spdy-protocol/spdy-protocol-draft2">draft
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
21 2</link> of SPDY protocol is implemented.
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
22 </para>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
23
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
24 <para>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
25 This module is not built by default, it should be enabled with
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
26 the <literal>--with-http_spdy_module</literal>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
27 configuration parameter.
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
28 </para>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
29
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
30 </section>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
31
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
32
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
33 <section id="bugs" name="Known Bugs">
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 <para>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
36 The module is experimental, caveat emptor applies.
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
37 </para>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
38
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
39 <para>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
40 Current implementation of SPDY protocol does not support “server push”.
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
41 </para>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
42
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
43 <para>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
44 Processing of requests from SPDY connections cannot be rate
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
45 <link doc="ngx_http_limit_req_module.xml">limited</link>.
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 </section>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
49
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
50
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
51 <section id="example" name="Example Configuration">
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 <para>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
54 <example>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
55 server {
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
56 listen 443 ssl spdy;
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 ssl_certificate server.crt;
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
59 ssl_certificate_key server.key;
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
60 ...
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
61 }
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
62 </example>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
63 <note>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
64 Note that in order to accept both
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
65 <link doc="ngx_http_ssl_module.xml">HTTPS</link> and SPDY connections
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
66 simultaneously on the same port,
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
67 <link url="http://www.openssl.org">OpenSSL</link> library used should support
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
68 “Next Protocol Negotiation” TLS extension, available since OpenSSL
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
69 version 1.0.1.
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
70 </note>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
71 </para>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
72
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
73 </section>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
74
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
75
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
76 <section id="directives" name="Directives">
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 <directive name="spdy_headers_comp">
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
79 <syntax><value>level</value></syntax>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
80 <default>0</default>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
81 <context>http</context>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
82 <context>server</context>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
83
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
84 <para>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
85 Sets a header compression <value>level</value> of a response in a range from
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
86 1 (fastest, less compression) to 9 (slowest, best compression).
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
87 The special value 0 turns off header compression.
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
88 </para>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
89
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
90 </directive>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
91
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
92 </section>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
93
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
94
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
95 <section id="variables" name="Embedded Variables">
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
96
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
97 <para>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
98 The <literal>ngx_http_spdy_module</literal> module
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
99 supports the following embedded variables:
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
100 <list type="tag" compact="no">
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
101
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
102 <tag-name id="var_spdy"><var>$spdy</var></tag-name>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
103 <tag-desc>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
104 SPDY protocol version for SPDY connections,
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
105 or an empty string otherwise;
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
106 </tag-desc>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
107
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
108 <tag-name id="var_spdy_request_priority"><var>$spdy_request_priority</var>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
109 </tag-name>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
110 <tag-desc>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
111 request priority for SPDY connections,
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
112 or an empty string otherwise.
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
113 </tag-desc>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
114
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
115 </list>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
116 </para>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
117
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
118 </section>
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
119
ade81792bdaa Documented SPDY support.
Homutov Vladimir <vl@nginx.com>
parents:
diff changeset
120 </module>