changeset 2976:cbd963190c15

Documented the http2 directive.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 13 Jun 2023 16:04:45 +0100
parents f8ad45c72992
children e4718be70b33
files xml/en/docs/http/ngx_http_core_module.xml xml/en/docs/http/ngx_http_grpc_module.xml xml/en/docs/http/ngx_http_v2_module.xml xml/ru/docs/http/ngx_http_core_module.xml xml/ru/docs/http/ngx_http_grpc_module.xml xml/ru/docs/http/ngx_http_v2_module.xml
diffstat 6 files changed, 59 insertions(+), 10 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_core_module.xml
+++ b/xml/en/docs/http/ngx_http_core_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_core_module"
         link="/en/docs/http/ngx_http_core_module.html"
         lang="en"
-        rev="105">
+        rev="106">
 
 <section id="directives" name="Directives">
 
@@ -1384,6 +1384,11 @@ The <literal>http2</literal> parameter (
 Normally, for this to work the <literal>ssl</literal> parameter should be
 specified as well, but nginx can also be configured to accept HTTP/2
 connections without SSL.
+<note>
+The parameter is deprecated,
+the <link doc="ngx_http_v2_module.xml" id="http2">http2</link> directive
+should be used instead.
+</note>
 </para>
 
 <para id="quic">
--- a/xml/en/docs/http/ngx_http_grpc_module.xml
+++ b/xml/en/docs/http/ngx_http_grpc_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_grpc_module"
         link="/en/docs/http/ngx_http_grpc_module.html"
         lang="en"
-        rev="9">
+        rev="10">
 
 <section id="summary">
 
@@ -29,7 +29,9 @@ The module requires the
 <para>
 <example>
 server {
-    listen 9000 http2;
+    listen 9000;
+
+    http2 on;
 
     location / {
         grpc_pass 127.0.0.1:9000;
--- a/xml/en/docs/http/ngx_http_v2_module.xml
+++ b/xml/en/docs/http/ngx_http_v2_module.xml
@@ -9,7 +9,7 @@
 <module name="Module ngx_http_v2_module"
         link="/en/docs/http/ngx_http_v2_module.html"
         lang="en"
-        rev="15">
+        rev="16">
 
 <section id="summary">
 
@@ -55,7 +55,9 @@ was not used to control closing HTTP/2 c
 <para>
 <example>
 server {
-    listen 443 ssl http2;
+    listen 443 ssl;
+
+    http2 on;
 
     ssl_certificate server.crt;
     ssl_certificate_key server.key;
@@ -82,6 +84,22 @@ black list and supported by clients.
 
 <section id="directives" name="Directives">
 
+<directive name="http2">
+<syntax><literal>on</literal> | <literal>off</literal></syntax>
+<default>off</default>
+<context>http</context>
+<context>server</context>
+<appeared-in>1.25.1</appeared-in>
+
+<para>
+Enables
+the <link url="https://datatracker.ietf.org/doc/html/rfc9113">HTTP/2</link>
+protocol.
+</para>
+
+</directive>
+
+
 <directive name="http2_body_preread_size">
 <syntax><value>size</value></syntax>
 <default>64k</default>
--- a/xml/ru/docs/http/ngx_http_core_module.xml
+++ b/xml/ru/docs/http/ngx_http_core_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_core_module"
         link="/ru/docs/http/ngx_http_core_module.html"
         lang="ru"
-        rev="105">
+        rev="106">
 
 <section id="directives" name="Директивы">
 
@@ -1376,6 +1376,10 @@ id="single_http_https_server">конфигурацию</link> для сервера,
 Обычно, чтобы это работало, следует также указать параметр
 <literal>ssl</literal>, однако nginx можно также настроить и на приём
 HTTP/2-соединений без SSL.
+<note>
+Параметр устарел, вместо него следует использовать
+директиву <link doc="ngx_http_v2_module.xml" id="http2">http2</link>.
+</note>
 </para>
 
 <para id="quic">
--- a/xml/ru/docs/http/ngx_http_grpc_module.xml
+++ b/xml/ru/docs/http/ngx_http_grpc_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_grpc_module"
         link="/ru/docs/http/ngx_http_grpc_module.html"
         lang="ru"
-        rev="9">
+        rev="10">
 
 <section id="summary">
 
@@ -29,7 +29,9 @@ gRPC-серверу (1.13.10).
 <para>
 <example>
 server {
-    listen 9000 http2;
+    listen 9000;
+
+    http2 on;
 
     location / {
         grpc_pass 127.0.0.1:9000;
--- a/xml/ru/docs/http/ngx_http_v2_module.xml
+++ b/xml/ru/docs/http/ngx_http_v2_module.xml
@@ -9,7 +9,7 @@
 <module name="Модуль ngx_http_v2_module"
         link="/ru/docs/http/ngx_http_v2_module.html"
         lang="ru"
-        rev="15">
+        rev="16">
 
 <section id="summary">
 
@@ -55,7 +55,9 @@
 <para>
 <example>
 server {
-    listen 443 ssl http2;
+    listen 443 ssl;
+
+    http2 on;
 
     ssl_certificate server.crt;
     ssl_certificate_key server.key;
@@ -82,6 +84,22 @@ server {
 
 <section id="directives" name="Директивы">
 
+<directive name="http2">
+<syntax><literal>on</literal> | <literal>off</literal></syntax>
+<default>off</default>
+<context>http</context>
+<context>server</context>
+<appeared-in>1.25.1</appeared-in>
+
+<para>
+Разрешает
+протокол
+<link url="https://datatracker.ietf.org/doc/html/rfc9113">HTTP/2</link>.
+</para>
+
+</directive>
+
+
 <directive name="http2_body_preread_size">
 <syntax><value>размер</value></syntax>
 <default>64k</default>