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

annotate xml/en/docs/http/ngx_http_grpc_module.xml @ 2142:ca7568f67dee

Sorted directives alphabetically.

author	Ruslan Ermilov <ru@nginx.com>
date	Tue, 10 Apr 2018 18:39:34 +0300
parents	b7dd3e8ee9c2
children	d765ffffd08c

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"
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	13 rev="1">
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 {
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	32 listen 9000 http2;
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	33
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	34 location / {
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	35 grpc_pass 127.0.0.1:9000;
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	36 }
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	37 }
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	38 </example>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	39 </para>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	40
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	41 </section>
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
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	44 <section id="directives" name="Directives">
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	45
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	46 <directive name="grpc_bind">
1885 6839c258c473 Added <literal> tag to proxy bind transparent. Yaroslav Zhuravlev <yar@nginx.com> parents: 1748 diff changeset	47 <syntax>
6839c258c473 Added <literal> tag to proxy bind transparent. Yaroslav Zhuravlev <yar@nginx.com> parents: 1748 diff changeset	48 <value>address</value>
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	49 [<literal>transparent </literal>] \|
1885 6839c258c473 Added <literal> tag to proxy bind transparent. Yaroslav Zhuravlev <yar@nginx.com> parents: 1748 diff changeset	50 <literal>off</literal></syntax>
772 ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 677 diff changeset	51 <default/>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 677 diff changeset	52 <context>http</context>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 677 diff changeset	53 <context>server</context>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 677 diff changeset	54 <context>location</context>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 677 diff changeset	55
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 677 diff changeset	56 <para>
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	57 Makes outgoing connections to a gRPC server originate
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	58 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	59 Parameter value can contain variables.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	60 The special value <literal>off</literal> cancels the effect
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	61 of the <literal>grpc_bind</literal> directive
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	62 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	63 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	64 </para>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 677 diff changeset	65
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	66 <para id="grpc_bind_transparent">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	67 The <literal>transparent</literal> parameter allows
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	68 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	69 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	70 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	71 <example>
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	72 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	73 </example>
d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1672 diff changeset	74 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	75 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	76 <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	77 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	78 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	79 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	80 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	81 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	82 </para>
d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1672 diff changeset	83
772 ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 677 diff changeset	84 </directive>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 677 diff changeset	85
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules. Vladimir Homutov <vl@nginx.com> parents: 677 diff changeset	86
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	87 <directive name="grpc_buffer_size">
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	88 <syntax><value>size</value></syntax>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	89 <default>4k\|8k</default>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	90 <context>http</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	91 <context>server</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	92 <context>location</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	93
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	94 <para>
1151 4c2324a7eeea Corrected the usage of articles and a comma. Yaroslav Zhuravlev <yar@nginx.com> parents: 1149 diff changeset	95 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	96 received from the gRPC server.
1151 4c2324a7eeea Corrected the usage of articles and a comma. Yaroslav Zhuravlev <yar@nginx.com> parents: 1149 diff changeset	97 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	98 </para>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	99
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	100 </directive>
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
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	103 <directive name="grpc_connect_timeout">
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	104 <syntax><value>time</value></syntax>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	105 <default>60s</default>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	106 <context>http</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	107 <context>server</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	108 <context>location</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	109
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	110 <para>
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	111 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	112 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	113 </para>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	114
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	115 </directive>
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
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	118 <directive name="grpc_hide_header">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	119 <syntax><value>field</value></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	120 <default/>
1337 91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	121 <context>http</context>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	122 <context>server</context>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	123 <context>location</context>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	124
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	125 <para>
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	126 By default,
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	127 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	128 <header>Server</header>, and
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	129 <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	130 server to a client.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	131 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	132 that will not be passed.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	133 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	134 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	135 </para>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	136
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends. Yaroslav Zhuravlev <yar@nginx.com> parents: 1290 diff changeset	137 </directive>
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
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	140 <directive name="grpc_ignore_headers">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	141 <syntax><value>field</value> ...</syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	142 <default/>
675 08140f6b7964 Documented gunzip module and corresponding changes. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	143 <context>http</context>
08140f6b7964 Documented gunzip module and corresponding changes. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	144 <context>server</context>
08140f6b7964 Documented gunzip module and corresponding changes. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	145 <context>location</context>
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	146
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	147 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	148 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	149 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	150 and <header>X-Accel-Charset</header>.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	151 </para>
675 08140f6b7964 Documented gunzip module and corresponding changes. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	152
08140f6b7964 Documented gunzip module and corresponding changes. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	153 <para>
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	154 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	155 effect:
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	156 <list type="bullet" compact="no">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	157
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	158 <listitem>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	159 <header>X-Accel-Redirect</header> performs an
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	160 <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	161 redirect</link> to the specified URI;
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	162 </listitem>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	163
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 <header>X-Accel-Charset</header> sets the desired
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	166 <link doc="ngx_http_charset_module.xml" id="charset"/>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	167 of a response.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	168 </listitem>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	169
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	170 </list>
675 08140f6b7964 Documented gunzip module and corresponding changes. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	171 </para>
08140f6b7964 Documented gunzip module and corresponding changes. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	172
08140f6b7964 Documented gunzip module and corresponding changes. Vladimir Homutov <vl@nginx.com> parents: 589 diff changeset	173 </directive>
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
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	176 <directive name="grpc_intercept_errors">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	177 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	178 <default>off</default>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	179 <context>http</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	180 <context>server</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	181 <context>location</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	182
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	183 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	184 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	185 to 300 should be passed to a client
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	186 or be intercepted and redirected to nginx for processing
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	187 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	188 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	189
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	190 </directive>
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
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	193 <directive name="grpc_next_upstream">
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	194 <syntax>
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 363 diff changeset	195 <literal>error</literal> \|
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 363 diff changeset	196 <literal>timeout</literal> \|
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	197 <literal>invalid_header</literal> \|
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	198 <literal>http_500</literal> \|
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	199 <literal>http_502</literal> \|
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	200 <literal>http_503</literal> \|
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	201 <literal>http_504</literal> \|
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	202 <literal>http_403</literal> \|
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	203 <literal>http_404</literal> \|
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	204 <literal>http_429</literal> \|
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	205 <literal>non_idempotent</literal> \|
364 bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 363 diff changeset	206 <literal>off</literal>
bb51d3e17dd0 Style fixed. Ruslan Ermilov <ru@nginx.com> parents: 363 diff changeset	207 ...</syntax>
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	208 <default>error timeout</default>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	209 <context>http</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	210 <context>server</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	211 <context>location</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	212
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	213 <para>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	214 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	215 <list type="tag">
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	216
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	217 <tag-name><literal>error</literal></tag-name>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	218 <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	219 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	220
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	221 <tag-name><literal>timeout</literal></tag-name>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	222 <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	223 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	224
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	225 <tag-name><literal>invalid_header</literal></tag-name>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	226 <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	227
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	228 <tag-name><literal>http_500</literal></tag-name>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	229 <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	230
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	231 <tag-name><literal>http_502</literal></tag-name>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	232 <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	233
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	234 <tag-name><literal>http_503</literal></tag-name>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	235 <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	236
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	237 <tag-name><literal>http_504</literal></tag-name>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	238 <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	239
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	240 <tag-name><literal>http_403</literal></tag-name>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	241 <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	242
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	243 <tag-name><literal>http_404</literal></tag-name>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	244 <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	245
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	246 <tag-name><literal>http_429</literal></tag-name>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	247 <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	248
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	249 <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	250 <tag-desc>normally, requests with a
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	251 <link url="https://tools.ietf.org/html/rfc7231#section-4.2.2">non-idempotent</link>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	252 method
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	253 (<literal>POST</literal>, <literal>LOCK</literal>, <literal>PATCH</literal>)
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	254 are not passed to the next server
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	255 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	256 enabling this option explicitly allows retrying such requests;
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	257 </tag-desc>
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	258
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	259 <tag-name><literal>off</literal></tag-name>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	260 <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	261
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	262 </list>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	263 </para>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	264
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	265 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	266 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	267 only possible if nothing has been sent to a client yet.
95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 942 diff changeset	268 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	269 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	270 </para>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	271
942 ba3d6ade3513 Elaborate on upstream server failures. Ruslan Ermilov <ru@nginx.com> parents: 878 diff changeset	272 <para>
1289 57fc39924d42 Proxy/memcached/fastcgi/scgi/uwsgi: updated link in _next_upstream directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 1157 diff changeset	273 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	274 <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	275 attempt</link> of communication with a server.
942 ba3d6ade3513 Elaborate on upstream server failures. Ruslan Ermilov <ru@nginx.com> parents: 878 diff changeset	276 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	277 <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	278 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	279 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	280 <literal>http_503</literal>, <literal>http_504</literal>,
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	281 and <literal>http_429</literal> are
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	282 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	283 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	284 are never considered unsuccessful attempts.
942 ba3d6ade3513 Elaborate on upstream server failures. Ruslan Ermilov <ru@nginx.com> parents: 878 diff changeset	285 </para>
ba3d6ade3513 Elaborate on upstream server failures. Ruslan Ermilov <ru@nginx.com> parents: 878 diff changeset	286
1290 f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	287 <para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	288 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	289 <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	290 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	291 </para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	292
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	293 </directive>
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
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	296 <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	297 <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	298 <default>0</default>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	299 <context>http</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	300 <context>server</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	301 <context>location</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	302
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	303 <para>
1672 9c98c4498f08 Rephrased the "proxy_next_upstream_timeout" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1622 diff changeset	304 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	305 <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	306 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	307 </para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	308
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	309 </directive>
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
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	312 <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	313 <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	314 <default>0</default>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	315 <context>http</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	316 <context>server</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	317 <context>location</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	318
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	319 <para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	320 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	321 <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	322 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	323 </para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries. Yaroslav Zhuravlev <yar@nginx.com> parents: 1289 diff changeset	324
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	325 </directive>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	326
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	327
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	328 <directive name="grpc_pass">
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	329 <syntax><value>address</value></syntax>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	330 <default/>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	331 <context>location</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	332 <context>if in location</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	333
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	334 <para>
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	335 Sets the gRPC server address.
1622 c4c1dddfedac Unified _pass address descriptions. Ruslan Ermilov <ru@nginx.com>* parents: 1337 diff changeset	336 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	337 and a port:
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	338 <example>
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	339 grpc_pass localhost:9000;
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	340 </example>
814 f46a132af596 "memcached_pass" can be a UNIX-domain socket. Ruslan Ermilov <ru@nginx.com> parents: 772 diff changeset	341 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	342 <example>
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	343 grpc_pass unix:/tmp/grpc.socket;
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	344 </example>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	345 Alternatively, the “<literal>grpc://</literal>” scheme can be used:
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 grpc_pass grpc://127.0.0.1:9000;
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 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	350 <example>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	351 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	352 </example>
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	353 </para>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	354
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 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	357 used in a round-robin fashion.
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	358 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	359 <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	360 </para>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	361
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	362 </directive>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	363
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	364
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	365 <directive name="grpc_pass_header">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	366 <syntax><value>field</value></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	367 <default/>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	368 <context>http</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	369 <context>server</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	370 <context>location</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	371
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	372 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	373 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	374 fields from a gRPC server to a client.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	375 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	376
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	377 </directive>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	378
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	379
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	380 <directive name="grpc_read_timeout">
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	381 <syntax><value>time</value></syntax>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	382 <default>60s</default>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	383 <context>http</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	384 <context>server</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	385 <context>location</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	386
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	387 <para>
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	388 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	389 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	390 not for the transmission of the whole response.
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	391 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	392 the connection is closed.
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	393 </para>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	394
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	395 </directive>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	396
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	397
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	398 <directive name="grpc_send_timeout">
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	399 <syntax><value>time</value></syntax>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	400 <default>60s</default>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	401 <context>http</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	402 <context>server</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	403 <context>location</context>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	404
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	405 <para>
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	406 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	407 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	408 not for the transmission of the whole request.
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	409 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	410 the connection is closed.
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	411 </para>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	412
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	413 </directive>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	414
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	415
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	416 <directive name="grpc_set_header">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	417 <syntax><value>field</value> <value>value</value></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	418 <default>Content-Length $content_length</default>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	419 <context>http</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	420 <context>server</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	421 <context>location</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	422
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	423 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	424 Allows redefining or appending fields to the request header
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	425 <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	426 The <value>value</value> can contain text, variables, and their combinations.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	427 These directives are inherited from the previous level if and
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	428 only if there are no
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	429 <literal>grpc_set_header</literal>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	430 directives defined on the current level.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	431 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	432
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	433 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	434 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	435 field will not be passed to a gRPC server:
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	436 <example>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	437 grpc_set_header Accept-Encoding "";
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	438 </example>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	439 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	440
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	441 </directive>
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
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	444 <directive name="grpc_ssl_certificate">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	445 <syntax><value>file</value></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	446 <default/>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	447 <context>http</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	448 <context>server</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	449 <context>location</context>
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 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	452 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	453 used for authentication to a gRPC SSL server.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	454 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	455
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	456 </directive>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	457
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	458
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	459 <directive name="grpc_ssl_certificate_key">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	460 <syntax><value>file</value></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	461 <default/>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	462 <context>http</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	463 <context>server</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	464 <context>location</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	465
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	466 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	467 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	468 used for authentication to a gRPC SSL server.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	469 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	470
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	471 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	472 The value
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	473 <literal>engine</literal>:<value>name</value>:<value>id</value>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	474 can be specified instead of the <value>file</value>,
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	475 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	476 from the OpenSSL engine <value>name</value>.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	477 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	478
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	479 </directive>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	480
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	481
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	482 <directive name="grpc_ssl_ciphers">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	483 <syntax><value>ciphers</value></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	484 <default>DEFAULT</default>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	485 <context>http</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	486 <context>server</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	487 <context>location</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	488
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	489 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	490 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	491 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	492 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	493
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	494 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	495 The full list can be viewed using the
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	496 “<command>openssl ciphers</command>” command.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	497 </para>
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 </directive>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	500
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	501
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	502 <directive name="grpc_ssl_crl">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	503 <syntax><value>file</value></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	504 <default/>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	505 <context>http</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	506 <context>server</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	507 <context>location</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	508
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	509 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	510 Specifies a <value>file</value> with revoked certificates (CRL)
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	511 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	512 the certificate of the gRPC SSL server.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	513 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	514
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	515 </directive>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	516
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 <directive name="grpc_ssl_name">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	519 <syntax><value>name</value></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	520 <default>host from grpc_pass</default>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	521 <context>http</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	522 <context>server</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	523 <context>location</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	524
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	525 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	526 Allows overriding the server name used to
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	527 <link id="grpc_ssl_verify">verify</link>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	528 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	529 <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	530 when establishing a connection with the gRPC SSL server.
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
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	533 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	534 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	535 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	536
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	537 </directive>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	538
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	539
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	540 <directive name="grpc_ssl_password_file">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	541 <syntax><value>file</value></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	542 <default/>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	543 <context>http</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	544 <context>server</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	545 <context>location</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	546
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	547 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	548 Specifies a <value>file</value> with passphrases for
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	549 <link id="grpc_ssl_certificate_key">secret keys</link>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	550 where each passphrase is specified on a separate line.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	551 Passphrases are tried in turn when loading the key.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	552 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	553
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	554 </directive>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	555
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	556
2142 ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	557 <directive name="grpc_ssl_protocols">
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	558 <syntax>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	559 [<literal>SSLv2</literal>]
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	560 [<literal>SSLv3</literal>]
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	561 [<literal>TLSv1</literal>]
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	562 [<literal>TLSv1.1</literal>]
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	563 [<literal>TLSv1.2</literal>]
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	564 [<literal>TLSv1.3</literal>]</syntax>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	565 <default>TLSv1 TLSv1.1 TLSv1.2</default>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	566 <context>http</context>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	567 <context>server</context>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	568 <context>location</context>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	569
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	570 <para>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	571 Enables the specified protocols for requests to a gRPC SSL server.
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	572 </para>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	573
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	574 </directive>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	575
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2114 diff changeset	576
2114 b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	577 <directive name="grpc_ssl_server_name">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	578 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	579 <default>off</default>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	580 <context>http</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	581 <context>server</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	582 <context>location</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	583
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	584 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	585 Enables or disables passing of the server name through
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	586 <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	587 Server Name Indication extension</link> (SNI, RFC 6066)
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	588 when establishing a connection with the gRPC SSL server.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	589 </para>
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>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	592
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	593
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	594 <directive name="grpc_ssl_session_reuse">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	595 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	596 <default>on</default>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	597 <context>http</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	598 <context>server</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	599 <context>location</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	600
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	601 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	602 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	603 the gRPC server.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	604 If the errors
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	605 “<literal>SSL3_GET_FINISHED:digest check failed</literal>”
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	606 appear in the logs, try disabling session reuse.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	607 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	608
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	609 </directive>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	610
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 <directive name="grpc_ssl_trusted_certificate">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	613 <syntax><value>file</value></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	614 <default/>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	615 <context>http</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	616 <context>server</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	617 <context>location</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	618
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	619 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	620 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	621 used to <link id="grpc_ssl_verify">verify</link>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	622 the certificate of the gRPC SSL server.
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	623 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	624
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	625 </directive>
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
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	628 <directive name="grpc_ssl_verify">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	629 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	630 <default>off</default>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	631 <context>http</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	632 <context>server</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	633 <context>location</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	634
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	635 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	636 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	637 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	638
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	639 </directive>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	640
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	641
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	642 <directive name="grpc_ssl_verify_depth">
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	643 <syntax><value>number</value></syntax>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	644 <default>1</default>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	645 <context>http</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	646 <context>server</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	647 <context>location</context>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	648
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	649 <para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	650 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	651 </para>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	652
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	653 </directive>
b7dd3e8ee9c2 Documented the gRPC proxy module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2090 diff changeset	654
363 c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	655 </section>
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	656
c7fccbe03827 English translation of ngx_http_memcached_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	657 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_grpc_module.xml @ 2142:ca7568f67dee