Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_v2_module.xml @ 1568:61a3285d77aa
Paraphrased the ALPN/NPN requirements note so it makes sense.
| author | Ruslan Ermilov <ru@nginx.com> |
|---|---|
| date | Thu, 17 Sep 2015 20:50:25 +0300 |
| parents | 0ca33afb461b |
| children | 37be36b01d28 |
| rev | line source |
|---|---|
| 1566 | 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_v2_module" | |
| 10 link="/en/docs/http/ngx_http_v2_module.html" | |
| 11 lang="en" | |
| 12 rev="1"> | |
| 13 | |
| 14 <section id="summary"> | |
| 15 | |
| 16 <para> | |
| 17 The <literal>ngx_http_v2_module</literal> module (1.9.5) provides | |
| 18 support for <link url="https://tools.ietf.org/html/rfc7540">HTTP/2</link> | |
| 19 and supersedes the | |
| 20 <link doc="ngx_http_spdy_module.xml">ngx_http_spdy_module</link> module. | |
| 21 </para> | |
| 22 | |
| 23 <para> | |
| 24 This module is not built by default, it should be enabled with | |
| 25 the <literal>--with-http_v2_module</literal> | |
| 26 configuration parameter. | |
| 27 </para> | |
| 28 | |
| 29 <para> | |
| 30 <note> | |
| 31 This module is also available as part of our | |
| 32 <commercial_version>commercial subscription</commercial_version> | |
| 33 in the <literal>nginx-plus-http2</literal> package of NGINX Plus | |
| 34 <link url="https://www.nginx.com/blog/nginx-plus-r7-released/">release 7</link>. | |
| 35 </note> | |
| 36 </para> | |
| 37 | |
| 38 </section> | |
| 39 | |
| 40 | |
| 41 <section id="example" name="Example Configuration"> | |
| 42 | |
| 43 <para> | |
| 44 <example> | |
| 45 server { | |
| 46 listen 443 ssl http2; | |
| 47 | |
| 48 ssl_certificate server.crt; | |
| 49 ssl_certificate_key server.key; | |
| 50 } | |
| 51 </example> | |
|
1568
61a3285d77aa
Paraphrased the ALPN/NPN requirements note so it makes sense.
Ruslan Ermilov <ru@nginx.com>
parents:
1566
diff
changeset
|
52 Note that accepting HTTP/2 connections over TLS requires |
| 1566 | 53 the “Application-Layer Protocol Negotiation” (ALPN) TLS extension |
|
1568
61a3285d77aa
Paraphrased the ALPN/NPN requirements note so it makes sense.
Ruslan Ermilov <ru@nginx.com>
parents:
1566
diff
changeset
|
54 support, which is available only since |
|
61a3285d77aa
Paraphrased the ALPN/NPN requirements note so it makes sense.
Ruslan Ermilov <ru@nginx.com>
parents:
1566
diff
changeset
|
55 <link url="http://www.openssl.org">OpenSSL</link> version 1.0.2. |
|
61a3285d77aa
Paraphrased the ALPN/NPN requirements note so it makes sense.
Ruslan Ermilov <ru@nginx.com>
parents:
1566
diff
changeset
|
56 Using the “Next Protocol Negotiation” (NPN) TLS extension for this purpose |
|
61a3285d77aa
Paraphrased the ALPN/NPN requirements note so it makes sense.
Ruslan Ermilov <ru@nginx.com>
parents:
1566
diff
changeset
|
57 (available since OpenSSL version 1.0.1) is not guaranteed. |
| 1566 | 58 </para> |
| 59 | |
| 60 </section> | |
| 61 | |
| 62 | |
| 63 <section id="directives" name="Directives"> | |
| 64 | |
| 65 <directive name="http2_chunk_size"> | |
| 66 <syntax><value>size</value></syntax> | |
| 67 <default>8k</default> | |
| 68 <context>http</context> | |
| 69 <context>server</context> | |
| 70 <context>location</context> | |
| 71 | |
| 72 <para> | |
| 73 Sets the maximum size of chunks | |
| 74 into which the response body is sliced. | |
| 75 A too low value results in higher overhead. | |
| 76 A too high value impairs prioritization due to | |
| 77 <link url="http://en.wikipedia.org/wiki/Head-of-line_blocking"> | |
| 78 HOL blocking</link>. | |
| 79 </para> | |
| 80 | |
| 81 </directive> | |
| 82 | |
| 83 | |
| 84 <directive name="http2_idle_timeout"> | |
| 85 <syntax><value>time</value></syntax> | |
| 86 <default>3m</default> | |
| 87 <context>http</context> | |
| 88 <context>server</context> | |
| 89 | |
| 90 <para> | |
| 91 Sets the timeout of inactivity after which the connection is closed. | |
| 92 </para> | |
| 93 | |
| 94 </directive> | |
| 95 | |
| 96 | |
| 97 <directive name="http2_max_concurrent_streams"> | |
| 98 <syntax><value>number</value></syntax> | |
| 99 <default>128</default> | |
| 100 <context>http</context> | |
| 101 <context>server</context> | |
| 102 | |
| 103 <para> | |
| 104 Sets the maximum number of concurrent HTTP/2 streams | |
| 105 in a connection. | |
| 106 </para> | |
| 107 | |
| 108 </directive> | |
| 109 | |
| 110 | |
| 111 <directive name="http2_recv_buffer_size"> | |
| 112 <syntax><value>size</value></syntax> | |
| 113 <default>256k</default> | |
| 114 <context>http</context> | |
| 115 | |
| 116 <para> | |
| 117 Sets the size of the per worker input buffer. | |
| 118 </para> | |
| 119 | |
| 120 </directive> | |
| 121 | |
| 122 | |
| 123 <directive name="http2_recv_timeout"> | |
| 124 <syntax><value>time</value></syntax> | |
| 125 <default>30s</default> | |
| 126 <context>http</context> | |
| 127 <context>server</context> | |
| 128 | |
| 129 <para> | |
| 130 Sets the timeout for expecting more data from the client, | |
| 131 after which the connection is closed. | |
| 132 </para> | |
| 133 | |
| 134 </directive> | |
| 135 | |
| 136 </section> | |
| 137 | |
| 138 | |
| 139 <section id="variables" name="Embedded Variables"> | |
| 140 | |
| 141 <para> | |
| 142 The <literal>ngx_http_v2_module</literal> module | |
| 143 supports the following embedded variables: | |
| 144 <list type="tag" compact="no"> | |
| 145 | |
| 146 <tag-name id="var_http2"><var>$http2</var></tag-name> | |
| 147 <tag-desc> | |
| 148 negotiated protocol identifier: | |
| 149 “<literal>h2</literal>” for HTTP/2 over TLS, | |
| 150 “<literal>h2c</literal>” for HTTP/2 over cleartext TCP, | |
| 151 or an empty string otherwise. | |
| 152 </tag-desc> | |
| 153 | |
| 154 </list> | |
| 155 </para> | |
| 156 | |
| 157 </section> | |
| 158 | |
| 159 </module> |