Mercurial > hg > nginx-site

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

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