nginx-site: xml/en/docs/http/ngx_http_grpc

annotate xml/en/docs/http/ngx_http_grpc_module.xml @ 2976:cbd963190c15

Documented the http2 directive.

author	Yaroslav Zhuravlev <yar@nginx.com>
date	Tue, 13 Jun 2023 16:04:45 +0100
parents	37e082fd009c
children

rev	line source
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1 <?xml version="1.0"?>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2
580 be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	3 <!--
be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	4 Copyright (C) Igor Sysoev
be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	5 Copyright (C) Nginx, Inc.
be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	6 -->
be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 364 diff changeset	7
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	9
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	10 <module name="Module ngx_http_grpc_module"
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	11 link="/en/docs/http/ngx_http_grpc_module.html"
589 764fbac1b8b4 Added document revision. Ruslan Ermilov <ru@nginx.com> parents: 580 diff changeset	12 lang="en"
2976 cbd963190c15 Documented the http2 directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2948 diff changeset	13 rev="10">
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	14
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	15 <section id="summary">
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	16
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	17 <para>
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	18 The <literal>ngx_http_grpc_module</literal> module allows passing requests
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	19 to a gRPC server (1.13.10).
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	20 The module requires the
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	21 <link doc="ngx_http_v2_module.xml">ngx_http_v2_module</link> module.
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	22 </para>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	23
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	24 </section>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	25
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	26
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	27 <section id="example" name="Example Configuration">
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	28
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	29 <para>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	30 <example>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	31 server {
2976 cbd963190c15 Documented the http2 directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2948 diff changeset	32 listen 9000;
cbd963190c15 Documented the http2 directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2948 diff changeset	33
cbd963190c15 Documented the http2 directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2948 diff changeset	34 http2 on;
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	35
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	36 location / {
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	37 grpc_pass 127.0.0.1:9000;
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	38 }
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	39 }
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	40 </example>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	41 </para>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	42
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	43 </section>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	44
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	45
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	46 <section id="directives" name="Directives">
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	47
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	48 <directive name="grpc_bind">
1885 6839c258c473 Added <literal> tag to proxy bind transparent. Yaroslav Zhuravlev <yar@nginx.com> parents: 1748 diff changeset	49 <syntax>
6839c258c473 Added <literal> tag to proxy bind transparent. Yaroslav Zhuravlev <yar@nginx.com> parents: 1748 diff changeset	50 <value>address</value>
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	51 [<literal>transparent </literal>] \|
1885 6839c258c473 Added <literal> tag to proxy bind transparent. Yaroslav Zhuravlev <yar@nginx.com> parents: 1748 diff changeset	52 <literal>off</literal></syntax>
772 ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 677 diff changeset	53 <default/>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 677 diff changeset	54 <context>http</context>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 677 diff changeset	55 <context>server</context>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 677 diff changeset	56 <context>location</context>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 677 diff changeset	57
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 677 diff changeset	58 <para>
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	59 Makes outgoing connections to a gRPC server originate
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	60 from the specified local IP address with an optional port.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	61 Parameter value can contain variables.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	62 The special value <literal>off</literal> cancels the effect
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	63 of the <literal>grpc_bind</literal> directive
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	64 inherited from the previous configuration level, which allows the
1748 be371be7a5c8 Documented optional port for proxy_bind and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1696 diff changeset	65 system to auto-assign the local IP address and port.
772 ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 677 diff changeset	66 </para>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 677 diff changeset	67
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	68 <para id="grpc_bind_transparent">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	69 The <literal>transparent</literal> parameter allows
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	70 outgoing connections to a gRPC server originate
1696 d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1672 diff changeset	71 from a non-local IP address,
d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1672 diff changeset	72 for example, from a real IP address of a client:
d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1672 diff changeset	73 <example>
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	74 grpc_bind $remote_addr transparent;
1696 d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1672 diff changeset	75 </example>
d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1672 diff changeset	76 In order for this parameter to work,
2090 a9a9a052b5bd Documented the "CAP_NET_RAW" capability for transparent proxying. Yaroslav Zhuravlev <yar@nginx.com> parents: 2056 diff changeset	77 it is usually necessary to run nginx worker processes with the
a9a9a052b5bd Documented the "CAP_NET_RAW" capability for transparent proxying. Yaroslav Zhuravlev <yar@nginx.com> parents: 2056 diff changeset	78 <link doc="../ngx_core_module.xml" id="user">superuser</link> privileges.
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	79 On Linux it is not required as if
2090 a9a9a052b5bd Documented the "CAP_NET_RAW" capability for transparent proxying. Yaroslav Zhuravlev <yar@nginx.com> parents: 2056 diff changeset	80 the <literal>transparent</literal> parameter is specified, worker processes
a9a9a052b5bd Documented the "CAP_NET_RAW" capability for transparent proxying. Yaroslav Zhuravlev <yar@nginx.com> parents: 2056 diff changeset	81 inherit the <literal>CAP_NET_RAW</literal> capability from the master process.
a9a9a052b5bd Documented the "CAP_NET_RAW" capability for transparent proxying. Yaroslav Zhuravlev <yar@nginx.com> parents: 2056 diff changeset	82 It is also necessary to configure kernel routing table
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	83 to intercept network traffic from the gRPC server.
1696 d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1672 diff changeset	84 </para>
d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1672 diff changeset	85
772 ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 677 diff changeset	86 </directive>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 677 diff changeset	87
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 677 diff changeset	88
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	89 <directive name="grpc_buffer_size">
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	90 <syntax><value>size</value></syntax>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	91 <default>4k\|8k</default>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	92 <context>http</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	93 <context>server</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	94 <context>location</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	95
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	96 <para>
1151 4c2324a7eeea Corrected the usage of articles and a comma. Yaroslav Zhuravlev <yar@nginx.com> parents: 1149 diff changeset	97 Sets the <value>size</value> of the buffer used for reading the response
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	98 received from the gRPC server.
1151 4c2324a7eeea Corrected the usage of articles and a comma. Yaroslav Zhuravlev <yar@nginx.com> parents: 1149 diff changeset	99 The response is passed to the client synchronously, as soon as it is received.
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	100 </para>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	101
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	102 </directive>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	103
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	104
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	105 <directive name="grpc_connect_timeout">
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	106 <syntax><value>time</value></syntax>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	107 <default>60s</default>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	108 <context>http</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	109 <context>server</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	110 <context>location</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	111
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	112 <para>
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	113 Defines a timeout for establishing a connection with a gRPC server.
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	114 It should be noted that this timeout cannot usually exceed 75 seconds.
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	115 </para>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	116
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	117 </directive>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	118
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	119
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	120 <directive name="grpc_hide_header">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	121 <syntax><value>field</value></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	122 <default/>
1337 91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	123 <context>http</context>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	124 <context>server</context>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	125 <context>location</context>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	126
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	127 <para>
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	128 By default,
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	129 nginx does not pass the header fields <header>Date</header>,
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	130 <header>Server</header>, and
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	131 <header>X-Accel-...</header> from the response of a gRPC
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	132 server to a client.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	133 The <literal>grpc_hide_header</literal> directive sets additional fields
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	134 that will not be passed.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	135 If, on the contrary, the passing of fields needs to be permitted,
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	136 the <link id="grpc_pass_header"/> directive can be used.
1337 91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	137 </para>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	138
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	139 </directive>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	140
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	141
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	142 <directive name="grpc_ignore_headers">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	143 <syntax><value>field</value> ...</syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	144 <default/>
675 08140f6b7964 Documented gunzip module and corresponding changes. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	145 <context>http</context>
08140f6b7964 Documented gunzip module and corresponding changes. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	146 <context>server</context>
08140f6b7964 Documented gunzip module and corresponding changes. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	147 <context>location</context>
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	148
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	149 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	150 Disables processing of certain response header fields from the gRPC server.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	151 The following fields can be ignored: <header>X-Accel-Redirect</header>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	152 and <header>X-Accel-Charset</header>.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	153 </para>
675 08140f6b7964 Documented gunzip module and corresponding changes. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	154
08140f6b7964 Documented gunzip module and corresponding changes. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	155 <para>
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	156 If not disabled, processing of these header fields has the following
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	157 effect:
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	158 <list type="bullet" compact="no">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	159
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	160 <listitem>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	161 <header>X-Accel-Redirect</header> performs an
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	162 <link doc="ngx_http_core_module.xml" id="internal">internal
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	163 redirect</link> to the specified URI;
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	164 </listitem>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	165
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	166 <listitem>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	167 <header>X-Accel-Charset</header> sets the desired
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	168 <link doc="ngx_http_charset_module.xml" id="charset"/>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	169 of a response.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	170 </listitem>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	171
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	172 </list>
675 08140f6b7964 Documented gunzip module and corresponding changes. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	173 </para>
08140f6b7964 Documented gunzip module and corresponding changes. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	174
08140f6b7964 Documented gunzip module and corresponding changes. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	175 </directive>
08140f6b7964 Documented gunzip module and corresponding changes. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	176
08140f6b7964 Documented gunzip module and corresponding changes. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	177
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	178 <directive name="grpc_intercept_errors">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	179 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	180 <default>off</default>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	181 <context>http</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	182 <context>server</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	183 <context>location</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	184
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	185 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	186 Determines whether gRPC server responses with codes greater than or equal
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	187 to 300 should be passed to a client
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	188 or be intercepted and redirected to nginx for processing
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	189 with the <link doc="ngx_http_core_module.xml" id="error_page"/> directive.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	190 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	191
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	192 </directive>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	193
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	194
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	195 <directive name="grpc_next_upstream">
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	196 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 363 diff changeset	197 <literal>error</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 363 diff changeset	198 <literal>timeout</literal> \|
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	199 <literal>invalid_header</literal> \|
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	200 <literal>http_500</literal> \|
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	201 <literal>http_502</literal> \|
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	202 <literal>http_503</literal> \|
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	203 <literal>http_504</literal> \|
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	204 <literal>http_403</literal> \|
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	205 <literal>http_404</literal> \|
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	206 <literal>http_429</literal> \|
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	207 <literal>non_idempotent</literal> \|
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 363 diff changeset	208 <literal>off</literal>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 363 diff changeset	209 ...</syntax>
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	210 <default>error timeout</default>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	211 <context>http</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	212 <context>server</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	213 <context>location</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	214
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	215 <para>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	216 Specifies in which cases a request should be passed to the next server:
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	217 <list type="tag">
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	218
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	219 <tag-name><literal>error</literal></tag-name>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	220 <tag-desc>an error occurred while establishing a connection with the
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	221 server, passing a request to it, or reading the response header;</tag-desc>
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	222
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	223 <tag-name><literal>timeout</literal></tag-name>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	224 <tag-desc>a timeout has occurred while establishing a connection with the
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	225 server, passing a request to it, or reading the response header;</tag-desc>
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	226
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	227 <tag-name><literal>invalid_header</literal></tag-name>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	228 <tag-desc>a server returned an empty or invalid response;</tag-desc>
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	229
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	230 <tag-name><literal>http_500</literal></tag-name>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	231 <tag-desc>a server returned a response with the code 500;</tag-desc>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	232
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	233 <tag-name><literal>http_502</literal></tag-name>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	234 <tag-desc>a server returned a response with the code 502;</tag-desc>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	235
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	236 <tag-name><literal>http_503</literal></tag-name>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	237 <tag-desc>a server returned a response with the code 503;</tag-desc>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	238
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	239 <tag-name><literal>http_504</literal></tag-name>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	240 <tag-desc>a server returned a response with the code 504;</tag-desc>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	241
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	242 <tag-name><literal>http_403</literal></tag-name>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	243 <tag-desc>a server returned a response with the code 403;</tag-desc>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	244
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	245 <tag-name><literal>http_404</literal></tag-name>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	246 <tag-desc>a server returned a response with the code 404;</tag-desc>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	247
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	248 <tag-name><literal>http_429</literal></tag-name>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	249 <tag-desc>a server returned a response with the code 429;</tag-desc>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	250
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	251 <tag-name id="non_idempotent"><literal>non_idempotent</literal></tag-name>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	252 <tag-desc>normally, requests with a
2831 4add6ae1296f Updated links to datatracker.ietf.org. Sergey Kandaurov <pluknet@nginx.com> parents: 2721 diff changeset	253 <link url="https://datatracker.ietf.org/doc/html/rfc7231#section-4.2.2">non-idempotent</link>
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	254 method
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	255 (<literal>POST</literal>, <literal>LOCK</literal>, <literal>PATCH</literal>)
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	256 are not passed to the next server
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	257 if a request has been sent to an upstream server;
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	258 enabling this option explicitly allows retrying such requests;
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	259 </tag-desc>
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	260
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	261 <tag-name><literal>off</literal></tag-name>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	262 <tag-desc>disables passing a request to the next server.</tag-desc>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	263
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	264 </list>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	265 </para>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	266
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	267 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	268 One should bear in mind that passing a request to the next server is
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	269 only possible if nothing has been sent to a client yet.
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	270 That is, if an error or timeout occurs in the middle of the
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	271 transferring of a response, fixing this is impossible.
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	272 </para>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	273
942 ba3d6ade3513 Elaborate on upstream server failures. Ruslan Ermilov <ru@nginx.com> parents: 878 diff changeset	274 <para>
1289 57fc39924d42 Proxy/memcached/fastcgi/scgi/uwsgi: updated link in _next_upstream directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 1157 diff changeset	275 The directive also defines what is considered an
57fc39924d42 Proxy/memcached/fastcgi/scgi/uwsgi: updated link in _next_upstream directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 1157 diff changeset	276 <link doc="ngx_http_upstream_module.xml" id="max_fails">unsuccessful
57fc39924d42 Proxy/memcached/fastcgi/scgi/uwsgi: updated link in _next_upstream directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 1157 diff changeset	277 attempt</link> of communication with a server.
942 ba3d6ade3513 Elaborate on upstream server failures. Ruslan Ermilov <ru@nginx.com> parents: 878 diff changeset	278 The cases of <literal>error</literal>, <literal>timeout</literal> and
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	279 <literal>invalid_header</literal> are always considered unsuccessful attempts,
942 ba3d6ade3513 Elaborate on upstream server failures. Ruslan Ermilov <ru@nginx.com> parents: 878 diff changeset	280 even if they are not specified in the directive.
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	281 The cases of <literal>http_500</literal>, <literal>http_502</literal>,
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	282 <literal>http_503</literal>, <literal>http_504</literal>,
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	283 and <literal>http_429</literal> are
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	284 considered unsuccessful attempts only if they are specified in the directive.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	285 The cases of <literal>http_403</literal> and <literal>http_404</literal>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	286 are never considered unsuccessful attempts.
942 ba3d6ade3513 Elaborate on upstream server failures. Ruslan Ermilov <ru@nginx.com> parents: 878 diff changeset	287 </para>
ba3d6ade3513 Elaborate on upstream server failures. Ruslan Ermilov <ru@nginx.com> parents: 878 diff changeset	288
1290 f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	289 <para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	290 Passing a request to the next server can be limited by
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	291 <link id="grpc_next_upstream_tries">the number of tries</link>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	292 and by <link id="grpc_next_upstream_timeout">time</link>.
1290 f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	293 </para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	294
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	295 </directive>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	296
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	297
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	298 <directive name="grpc_next_upstream_timeout">
1290 f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	299 <syntax><value>time</value></syntax>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	300 <default>0</default>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	301 <context>http</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	302 <context>server</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	303 <context>location</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	304
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	305 <para>
1672 9c98c4498f08 Rephrased the "proxy_next_upstream_timeout" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1622 diff changeset	306 Limits the time during which a request can be passed to the
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	307 <link id="grpc_next_upstream">next server</link>.
1290 f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	308 The <literal>0</literal> value turns off this limitation.
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	309 </para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	310
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	311 </directive>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	312
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	313
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	314 <directive name="grpc_next_upstream_tries">
1290 f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	315 <syntax><value>number</value></syntax>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	316 <default>0</default>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	317 <context>http</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	318 <context>server</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	319 <context>location</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	320
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	321 <para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	322 Limits the number of possible tries for passing a request to the
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	323 <link id="grpc_next_upstream">next server</link>.
1290 f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	324 The <literal>0</literal> value turns off this limitation.
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	325 </para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	326
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	327 </directive>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	328
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	329
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	330 <directive name="grpc_pass">
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	331 <syntax><value>address</value></syntax>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	332 <default/>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	333 <context>location</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	334 <context>if in location</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	335
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	336 <para>
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	337 Sets the gRPC server address.
1622 c4c1dddfedac Unified _pass address descriptions. Ruslan Ermilov <ru@nginx.com>* parents: 1337 diff changeset	338 The address can be specified as a domain name or IP address,
c4c1dddfedac Unified _pass address descriptions. Ruslan Ermilov <ru@nginx.com>* parents: 1337 diff changeset	339 and a port:
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	340 <example>
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	341 grpc_pass localhost:9000;
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	342 </example>
814 f46a132af596 "memcached_pass" can be a UNIX-domain socket. Ruslan Ermilov <ru@nginx.com> parents: 772 diff changeset	343 or as a UNIX-domain socket path:
f46a132af596 "memcached_pass" can be a UNIX-domain socket. Ruslan Ermilov <ru@nginx.com> parents: 772 diff changeset	344 <example>
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	345 grpc_pass unix:/tmp/grpc.socket;
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	346 </example>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	347 Alternatively, the “<literal>grpc://</literal>” scheme can be used:
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	348 <example>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	349 grpc_pass grpc://127.0.0.1:9000;
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	350 </example>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	351 To use gRPC over SSL, the “<literal>grpcs://</literal>” scheme should be used:
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	352 <example>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	353 grpc_pass grpcs://127.0.0.1:443;
814 f46a132af596 "memcached_pass" can be a UNIX-domain socket. Ruslan Ermilov <ru@nginx.com> parents: 772 diff changeset	354 </example>
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	355 </para>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	356
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	357 <para>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	358 If a domain name resolves to several addresses, all of them will be
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	359 used in a round-robin fashion.
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	360 In addition, an address can be specified as a
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	361 <link doc="ngx_http_upstream_module.xml">server group</link>.
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	362 </para>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	363
2477 bdc7cacb164f Documented variables support in grpc_pass. Sergey Kandaurov <pluknet@nginx.com> parents: 2254 diff changeset	364 <para>
bdc7cacb164f Documented variables support in grpc_pass. Sergey Kandaurov <pluknet@nginx.com> parents: 2254 diff changeset	365 Parameter value can contain variables (1.17.8).
bdc7cacb164f Documented variables support in grpc_pass. Sergey Kandaurov <pluknet@nginx.com> parents: 2254 diff changeset	366 In this case, if an address is specified as a domain name,
bdc7cacb164f Documented variables support in grpc_pass. Sergey Kandaurov <pluknet@nginx.com> parents: 2254 diff changeset	367 the name is searched among the described
bdc7cacb164f Documented variables support in grpc_pass. Sergey Kandaurov <pluknet@nginx.com> parents: 2254 diff changeset	368 <link doc="ngx_http_upstream_module.xml">server groups</link>,
bdc7cacb164f Documented variables support in grpc_pass. Sergey Kandaurov <pluknet@nginx.com> parents: 2254 diff changeset	369 and, if not found, is determined using a
bdc7cacb164f Documented variables support in grpc_pass. Sergey Kandaurov <pluknet@nginx.com> parents: 2254 diff changeset	370 <link doc="ngx_http_core_module.xml" id="resolver"/>.
bdc7cacb164f Documented variables support in grpc_pass. Sergey Kandaurov <pluknet@nginx.com> parents: 2254 diff changeset	371 </para>
bdc7cacb164f Documented variables support in grpc_pass. Sergey Kandaurov <pluknet@nginx.com> parents: 2254 diff changeset	372
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	373 </directive>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	374
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	375
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	376 <directive name="grpc_pass_header">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	377 <syntax><value>field</value></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	378 <default/>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	379 <context>http</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	380 <context>server</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	381 <context>location</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	382
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	383 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	384 Permits passing <link id="grpc_hide_header">otherwise disabled</link> header
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	385 fields from a gRPC server to a client.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	386 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	387
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	388 </directive>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	389
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	390
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	391 <directive name="grpc_read_timeout">
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	392 <syntax><value>time</value></syntax>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	393 <default>60s</default>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	394 <context>http</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	395 <context>server</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	396 <context>location</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	397
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	398 <para>
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	399 Defines a timeout for reading a response from the gRPC server.
1149 1501e5848052 Corrected the usage of the definite article. Yaroslav Zhuravlev <yar@nginx.com> parents: 966 diff changeset	400 The timeout is set only between two successive read operations,
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	401 not for the transmission of the whole response.
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	402 If the gRPC server does not transmit anything within this time,
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	403 the connection is closed.
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	404 </para>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	405
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	406 </directive>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	407
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	408
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	409 <directive name="grpc_send_timeout">
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	410 <syntax><value>time</value></syntax>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	411 <default>60s</default>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	412 <context>http</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	413 <context>server</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	414 <context>location</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	415
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	416 <para>
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	417 Sets a timeout for transmitting a request to the gRPC server.
1149 1501e5848052 Corrected the usage of the definite article. Yaroslav Zhuravlev <yar@nginx.com> parents: 966 diff changeset	418 The timeout is set only between two successive write operations,
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	419 not for the transmission of the whole request.
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	420 If the gRPC server does not receive anything within this time,
1149 1501e5848052 Corrected the usage of the definite article. Yaroslav Zhuravlev <yar@nginx.com> parents: 966 diff changeset	421 the connection is closed.
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	422 </para>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	423
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	424 </directive>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	425
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	426
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	427 <directive name="grpc_set_header">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	428 <syntax><value>field</value> <value>value</value></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	429 <default>Content-Length $content_length</default>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	430 <context>http</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	431 <context>server</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	432 <context>location</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	433
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	434 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	435 Allows redefining or appending fields to the request header
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	436 <link id="grpc_pass_request_headers">passed</link> to the gRPC server.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	437 The <value>value</value> can contain text, variables, and their combinations.
2593 eeed494bba51 Unified phrases about configuration levels and inheritance. Ruslan Ermilov <ru@nginx.com> parents: 2477 diff changeset	438 These directives are inherited from the previous configuration level
eeed494bba51 Unified phrases about configuration levels and inheritance. Ruslan Ermilov <ru@nginx.com> parents: 2477 diff changeset	439 if and only if there are no <literal>grpc_set_header</literal> directives
eeed494bba51 Unified phrases about configuration levels and inheritance. Ruslan Ermilov <ru@nginx.com> parents: 2477 diff changeset	440 defined on the current level.
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	441 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	442
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	443 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	444 If the value of a header field is an empty string then this
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	445 field will not be passed to a gRPC server:
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	446 <example>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	447 grpc_set_header Accept-Encoding "";
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	448 </example>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	449 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	450
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	451 </directive>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	452
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	453
2254 d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	454 <directive name="grpc_socket_keepalive">
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	455 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	456 <default>off</default>
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	457 <context>http</context>
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	458 <context>server</context>
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	459 <context>location</context>
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	460 <appeared-in>1.15.6</appeared-in>
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	461
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	462 <para>
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	463 Configures the “TCP keepalive” behavior
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	464 for outgoing connections to a gRPC server.
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	465 By default, the operating system’s settings are in effect for the socket.
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	466 If the directive is set to the value “<literal>on</literal>”, the
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	467 <c-def>SO_KEEPALIVE</c-def> socket option is turned on for the socket.
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	468 </para>
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	469
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	470 </directive>
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	471
d765ffffd08c Documented proxy_socket_keepalive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	472
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	473 <directive name="grpc_ssl_certificate">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	474 <syntax><value>file</value></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	475 <default/>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	476 <context>http</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	477 <context>server</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	478 <context>location</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	479
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	480 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	481 Specifies a <value>file</value> with the certificate in the PEM format
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	482 used for authentication to a gRPC SSL server.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	483 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	484
2721 7041bddec07d Documented variables support for certificates in proxy, uwsgi, grpc. Yaroslav Zhuravlev <yar@nginx.com> parents: 2617 diff changeset	485 <para>
7041bddec07d Documented variables support for certificates in proxy, uwsgi, grpc. Yaroslav Zhuravlev <yar@nginx.com> parents: 2617 diff changeset	486 Since version 1.21.0, variables can be used in the <value>file</value> name.
7041bddec07d Documented variables support for certificates in proxy, uwsgi, grpc. Yaroslav Zhuravlev <yar@nginx.com> parents: 2617 diff changeset	487 </para>
7041bddec07d Documented variables support for certificates in proxy, uwsgi, grpc. Yaroslav Zhuravlev <yar@nginx.com> parents: 2617 diff changeset	488
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	489 </directive>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	490
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	491
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	492 <directive name="grpc_ssl_certificate_key">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	493 <syntax><value>file</value></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	494 <default/>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	495 <context>http</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	496 <context>server</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	497 <context>location</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	498
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	499 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	500 Specifies a <value>file</value> with the secret key in the PEM format
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	501 used for authentication to a gRPC SSL server.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	502 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	503
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	504 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	505 The value
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	506 <literal>engine</literal>:<value>name</value>:<value>id</value>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	507 can be specified instead of the <value>file</value>,
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	508 which loads a secret key with a specified <value>id</value>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	509 from the OpenSSL engine <value>name</value>.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	510 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	511
2721 7041bddec07d Documented variables support for certificates in proxy, uwsgi, grpc. Yaroslav Zhuravlev <yar@nginx.com> parents: 2617 diff changeset	512 <para>
7041bddec07d Documented variables support for certificates in proxy, uwsgi, grpc. Yaroslav Zhuravlev <yar@nginx.com> parents: 2617 diff changeset	513 Since version 1.21.0, variables can be used in the <value>file</value> name.
7041bddec07d Documented variables support for certificates in proxy, uwsgi, grpc. Yaroslav Zhuravlev <yar@nginx.com> parents: 2617 diff changeset	514 </para>
7041bddec07d Documented variables support for certificates in proxy, uwsgi, grpc. Yaroslav Zhuravlev <yar@nginx.com> parents: 2617 diff changeset	515
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	516 </directive>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	517
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	518
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	519 <directive name="grpc_ssl_ciphers">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	520 <syntax><value>ciphers</value></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	521 <default>DEFAULT</default>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	522 <context>http</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	523 <context>server</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	524 <context>location</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	525
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	526 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	527 Specifies the enabled ciphers for requests to a gRPC SSL server.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	528 The ciphers are specified in the format understood by the OpenSSL library.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	529 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	530
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	531 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	532 The full list can be viewed using the
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	533 “<command>openssl ciphers</command>” command.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	534 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	535
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	536 </directive>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	537
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	538
2617 6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	539 <directive name="grpc_ssl_conf_command">
2865 0d355d154181 Corrected syntax of ssl_conf_command and friends. Sergey Kandaurov <pluknet@nginx.com> parents: 2837 diff changeset	540 <syntax><value>name</value> <value>value</value></syntax>
2617 6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	541 <default/>
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	542 <context>http</context>
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	543 <context>server</context>
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	544 <context>location</context>
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	545 <appeared-in>1.19.4</appeared-in>
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	546
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	547 <para>
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	548 Sets arbitrary OpenSSL configuration
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	549 <link url="https://www.openssl.org/docs/man1.1.1/man3/SSL_CONF_cmd.html">commands</link>
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	550 when establishing a connection with the gRPC SSL server.
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	551 <note>
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	552 The directive is supported when using OpenSSL 1.0.2 or higher.
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	553 </note>
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	554 </para>
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	555
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	556 <para>
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	557 Several <literal>grpc_ssl_conf_command</literal> directives
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	558 can be specified on the same level.
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	559 These directives are inherited from the previous configuration level
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	560 if and only if there are
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	561 no <literal>grpc_ssl_conf_command</literal> directives
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	562 defined on the current level.
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	563 </para>
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	564
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	565 <para>
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	566 <note>
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	567 Note that configuring OpenSSL directly
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	568 might result in unexpected behavior.
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	569 </note>
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	570 </para>
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	571
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	572 </directive>
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	573
6684517c9d19 Documented the proxy_ssl_conf_command directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2593 diff changeset	574
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	575 <directive name="grpc_ssl_crl">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	576 <syntax><value>file</value></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	577 <default/>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	578 <context>http</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	579 <context>server</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	580 <context>location</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	581
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	582 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	583 Specifies a <value>file</value> with revoked certificates (CRL)
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	584 in the PEM format used to <link id="grpc_ssl_verify">verify</link>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	585 the certificate of the gRPC SSL server.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	586 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	587
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	588 </directive>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	589
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	590
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	591 <directive name="grpc_ssl_name">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	592 <syntax><value>name</value></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	593 <default>host from grpc_pass</default>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	594 <context>http</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	595 <context>server</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	596 <context>location</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	597
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	598 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	599 Allows overriding the server name used to
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	600 <link id="grpc_ssl_verify">verify</link>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	601 the certificate of the gRPC SSL server and to be
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	602 <link id="grpc_ssl_server_name">passed through SNI</link>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	603 when establishing a connection with the gRPC SSL server.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	604 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	605
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	606 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	607 By default, the host part from <link id="grpc_pass"/> is used.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	608 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	609
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	610 </directive>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	611
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	612
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	613 <directive name="grpc_ssl_password_file">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	614 <syntax><value>file</value></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	615 <default/>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	616 <context>http</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	617 <context>server</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	618 <context>location</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	619
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	620 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	621 Specifies a <value>file</value> with passphrases for
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	622 <link id="grpc_ssl_certificate_key">secret keys</link>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	623 where each passphrase is specified on a separate line.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	624 Passphrases are tried in turn when loading the key.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	625 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	626
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	627 </directive>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	628
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	629
2142 ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	630 <directive name="grpc_ssl_protocols">
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	631 <syntax>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	632 [<literal>SSLv2</literal>]
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	633 [<literal>SSLv3</literal>]
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	634 [<literal>TLSv1</literal>]
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	635 [<literal>TLSv1.1</literal>]
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	636 [<literal>TLSv1.2</literal>]
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	637 [<literal>TLSv1.3</literal>]</syntax>
2948 37e082fd009c Added TLSv1.3 to the default value of ssl_protocols and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2865 diff changeset	638 <default>TLSv1 TLSv1.1 TLSv1.2 TLSv1.3</default>
2142 ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	639 <context>http</context>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	640 <context>server</context>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	641 <context>location</context>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	642
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	643 <para>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	644 Enables the specified protocols for requests to a gRPC SSL server.
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	645 </para>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	646
2948 37e082fd009c Added TLSv1.3 to the default value of ssl_protocols and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2865 diff changeset	647 <para>
37e082fd009c Added TLSv1.3 to the default value of ssl_protocols and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2865 diff changeset	648 <note>
37e082fd009c Added TLSv1.3 to the default value of ssl_protocols and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2865 diff changeset	649 The <literal>TLSv1.3</literal> parameter is used by default
37e082fd009c Added TLSv1.3 to the default value of ssl_protocols and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2865 diff changeset	650 since 1.23.4.
37e082fd009c Added TLSv1.3 to the default value of ssl_protocols and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2865 diff changeset	651 </note>
37e082fd009c Added TLSv1.3 to the default value of ssl_protocols and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2865 diff changeset	652 </para>
37e082fd009c Added TLSv1.3 to the default value of ssl_protocols and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 2865 diff changeset	653
2142 ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	654 </directive>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	655
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	656
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	657 <directive name="grpc_ssl_server_name">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	658 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	659 <default>off</default>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	660 <context>http</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	661 <context>server</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	662 <context>location</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	663
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	664 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	665 Enables or disables passing of the server name through
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	666 <link url="http://en.wikipedia.org/wiki/Server_Name_Indication">TLS
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	667 Server Name Indication extension</link> (SNI, RFC 6066)
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	668 when establishing a connection with the gRPC SSL server.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	669 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	670
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	671 </directive>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	672
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	673
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	674 <directive name="grpc_ssl_session_reuse">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	675 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	676 <default>on</default>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	677 <context>http</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	678 <context>server</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	679 <context>location</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	680
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	681 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	682 Determines whether SSL sessions can be reused when working with
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	683 the gRPC server.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	684 If the errors
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	685 “<literal>SSL3_GET_FINISHED:digest check failed</literal>”
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	686 appear in the logs, try disabling session reuse.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	687 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	688
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	689 </directive>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	690
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	691
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	692 <directive name="grpc_ssl_trusted_certificate">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	693 <syntax><value>file</value></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	694 <default/>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	695 <context>http</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	696 <context>server</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	697 <context>location</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	698
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	699 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	700 Specifies a <value>file</value> with trusted CA certificates in the PEM format
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	701 used to <link id="grpc_ssl_verify">verify</link>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	702 the certificate of the gRPC SSL server.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	703 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	704
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	705 </directive>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	706
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	707
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	708 <directive name="grpc_ssl_verify">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	709 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	710 <default>off</default>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	711 <context>http</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	712 <context>server</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	713 <context>location</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	714
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	715 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	716 Enables or disables verification of the gRPC SSL server certificate.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	717 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	718
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	719 </directive>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	720
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	721
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	722 <directive name="grpc_ssl_verify_depth">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	723 <syntax><value>number</value></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	724 <default>1</default>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	725 <context>http</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	726 <context>server</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	727 <context>location</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	728
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	729 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	730 Sets the verification depth in the gRPC SSL server certificates chain.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	731 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	732
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	733 </directive>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	734
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	735 </section>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	736
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	737 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_grpc_module.xml @ 2976:cbd963190c15