Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_memcached_module.xml @ 1748:be371be7a5c8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documented optional port for proxy_bind and friends.
author Yaroslav Zhuravlev <yar@nginx.com>
date Mon, 20 Jun 2016 18:54:46 +0300
parents d855e7cc3b2f
children 6839c258c473
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
10 <module name="Module ngx_http_memcached_module"
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
11 link="/en/docs/http/ngx_http_memcached_module.html"
589
764fbac1b8b4 Added document revision.
Ruslan Ermilov <ru@nginx.com>
parents: 580
diff changeset
12 lang="en"
1748
be371be7a5c8 Documented optional port for proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1696
diff changeset
13 rev="14">
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>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 942
diff changeset
18 The <literal>ngx_http_memcached_module</literal> module is used to obtain
363
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
19 responses from a memcached server.
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
20 The key is set in the <var>$memcached_key</var> variable.
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 942
diff changeset
21 A response should be put in memcached in advance by means
363
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
22 external to nginx.
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
23 </para>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
24
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
25 </section>
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
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
28 <section id="example" name="Example Configuration">
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
29
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
30 <para>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
31 <example>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
32 server {
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
33 location / {
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
34 set $memcached_key "$uri?$args";
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
35 memcached_pass host:11211;
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
36 error_page 404 502 504 = @fallback;
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
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
39 location @fallback {
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
40 proxy_pass http://backend;
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
41 }
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 </example>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
44 </para>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
45
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
46 </section>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
47
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
48
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
49 <section id="directives" name="Directives">
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
50
772
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents: 677
diff changeset
51 <directive name="memcached_bind">
1696
d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1672
diff changeset
52 <syntax><value>address</value> [transparent] | <literal>off</literal></syntax>
772
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents: 677
diff changeset
53 <default/>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents: 677
diff changeset
54 <context>http</context>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents: 677
diff changeset
55 <context>server</context>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents: 677
diff changeset
56 <context>location</context>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents: 677
diff changeset
57 <appeared-in>0.8.22</appeared-in>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents: 677
diff changeset
58
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents: 677
diff changeset
59 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 942
diff changeset
60 Makes outgoing connections to a memcached server originate
1748
be371be7a5c8 Documented optional port for proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1696
diff changeset
61 from the specified local IP address with an optional port (1.11.2).
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 942
diff changeset
62 Parameter value can contain variables (1.3.12).
815
ed29fd8be462 *_bind: variables support and inheritance.
Ruslan Ermilov <ru@nginx.com>
parents: 814
diff changeset
63 The special value <literal>off</literal> (1.3.12) cancels the effect
ed29fd8be462 *_bind: variables support and inheritance.
Ruslan Ermilov <ru@nginx.com>
parents: 814
diff changeset
64 of the <literal>memcached_bind</literal> directive
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 942
diff changeset
65 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
66 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
67 </para>
ce121bf644f5 Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents: 677
diff changeset
68
1696
d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1672
diff changeset
69 <para id="memcached_bind_transparent">
d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1672
diff changeset
70 The <literal>transparent</literal> parameter (1.11.0) allows
d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1672
diff changeset
71 outgoing connections to a memcached server originate
d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1672
diff changeset
72 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
73 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
74 <example>
d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1672
diff changeset
75 memcached_bind $remote_addr transparent;
d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1672
diff changeset
76 </example>
d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1672
diff changeset
77 In order for this parameter to work,
d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1672
diff changeset
78 it is necessary to run nginx worker processes with the
d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1672
diff changeset
79 <link doc="../ngx_core_module.xml" id="user">superuser</link> privileges
d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1672
diff changeset
80 and configure kernel routing table
d855e7cc3b2f Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1672
diff changeset
81 to intercept network traffic from the memcached server.
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
363
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
87 <directive name="memcached_buffer_size">
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
363
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
96 received from the memcached 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
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
103 <directive name="memcached_connect_timeout">
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>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 942
diff changeset
111 Defines a timeout for establishing a connection with a memcached 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
1337
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1290
diff changeset
118 <directive name="memcached_force_ranges">
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1290
diff changeset
119 <syntax><literal>on</literal> | <literal>off</literal></syntax>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1290
diff changeset
120 <default>off</default>
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 <appeared-in>1.7.7</appeared-in>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1290
diff changeset
125
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1290
diff changeset
126 <para>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1290
diff changeset
127 Enables byte-range support
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1290
diff changeset
128 for both cached and uncached responses from the memcached server
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1290
diff changeset
129 regardless of the <header>Accept-Ranges</header> field in these responses.
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1290
diff changeset
130 </para>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1290
diff changeset
131
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1290
diff changeset
132 </directive>
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1290
diff changeset
133
91a064bdb4f9 Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1290
diff changeset
134
675
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
135 <directive name="memcached_gzip_flag">
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
136 <syntax><value>flag</value></syntax>
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
137 <default></default>
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
138 <context>http</context>
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
139 <context>server</context>
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
140 <context>location</context>
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
141 <appeared-in>1.3.6</appeared-in>
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
142
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
143 <para>
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
144 Enables the test for the <value>flag</value> presence in the memcached
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 942
diff changeset
145 server response and sets the “<literal>Content-Encoding</literal>”
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 942
diff changeset
146 response header field to “<literal>gzip</literal>”
675
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
147 if the flag is set.
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
148 </para>
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
149
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
150 </directive>
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
151
08140f6b7964 Documented gunzip module and corresponding changes.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
152
363
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
153 <directive name="memcached_next_upstream">
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
154 <syntax>
364
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 363
diff changeset
155 <literal>error</literal> |
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 363
diff changeset
156 <literal>timeout</literal> |
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 363
diff changeset
157 <literal>invalid_response</literal> |
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 363
diff changeset
158 <literal>not_found</literal> |
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 363
diff changeset
159 <literal>off</literal>
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 363
diff changeset
160 ...</syntax>
363
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
161 <default>error timeout</default>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
162 <context>http</context>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
163 <context>server</context>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
164 <context>location</context>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
165
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
166 <para>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
167 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
168 <list type="tag">
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
169
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
170 <tag-name><literal>error</literal></tag-name>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
171 <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
172 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
173
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
174 <tag-name><literal>timeout</literal></tag-name>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
175 <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
176 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
177
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
178 <tag-name><literal>invalid_response</literal></tag-name>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 942
diff changeset
179 <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
180
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
181 <tag-name><literal>not_found</literal></tag-name>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
182 <tag-desc>a response was not found on the server;</tag-desc>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
183
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
184 <tag-name><literal>off</literal></tag-name>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
185 <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
186
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
187 </list>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
188 </para>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
189
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
190 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 942
diff changeset
191 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
192 only possible if nothing has been sent to a client yet.
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 942
diff changeset
193 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
194 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
195 </para>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
196
942
ba3d6ade3513 Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents: 878
diff changeset
197 <para>
1289
57fc39924d42 Proxy/memcached/fastcgi/scgi/uwsgi: updated link in _next_upstream directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1157
diff changeset
198 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
199 <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
200 attempt</link> of communication with a server.
942
ba3d6ade3513 Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents: 878
diff changeset
201 The cases of <literal>error</literal>, <literal>timeout</literal> and
ba3d6ade3513 Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents: 878
diff changeset
202 <literal>invalid_header</literal> are always considered unsuccessful attempts,
ba3d6ade3513 Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents: 878
diff changeset
203 even if they are not specified in the directive.
ba3d6ade3513 Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents: 878
diff changeset
204 The case of <literal>not_found</literal>
ba3d6ade3513 Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents: 878
diff changeset
205 is never considered an unsuccessful attempt.
ba3d6ade3513 Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents: 878
diff changeset
206 </para>
ba3d6ade3513 Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents: 878
diff changeset
207
1290
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
208 <para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
209 Passing a request to the next server can be limited by
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
210 <link id="memcached_next_upstream_tries">the number of tries</link>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
211 and by <link id="memcached_next_upstream_timeout">time</link>.
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
212 </para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
213
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
214 </directive>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
215
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
216
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
217 <directive name="memcached_next_upstream_timeout">
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
218 <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
219 <default>0</default>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
220 <context>http</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
221 <context>server</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
222 <context>location</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
223 <appeared-in>1.7.5</appeared-in>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
224
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
225 <para>
1672
9c98c4498f08 Rephrased the "proxy_next_upstream_timeout" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1622
diff changeset
226 Limits the time during which a request can be passed to the
1290
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
227 <link id="memcached_next_upstream">next server</link>.
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
228 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
229 </para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
230
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
231 </directive>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
232
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
233
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
234 <directive name="memcached_next_upstream_tries">
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
235 <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
236 <default>0</default>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
237 <context>http</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
238 <context>server</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
239 <context>location</context>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
240 <appeared-in>1.7.5</appeared-in>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
241
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
242 <para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
243 Limits the number of possible tries for passing a request to the
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
244 <link id="memcached_next_upstream">next server</link>.
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
245 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
246 </para>
f5cc9f2aef9a Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1289
diff changeset
247
363
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
248 </directive>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
249
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
250
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
251 <directive name="memcached_pass">
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
252 <syntax><value>address</value></syntax>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
253 <default/>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
254 <context>location</context>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
255 <context>if in location</context>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
256
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
257 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 942
diff changeset
258 Sets the memcached server address.
1622
c4c1dddfedac Unified *_pass address descriptions.
Ruslan Ermilov <ru@nginx.com>
parents: 1337
diff changeset
259 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
260 and a port:
363
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
261 <example>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
262 memcached_pass localhost:11211;
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
263 </example>
814
f46a132af596 "memcached_pass" can be a UNIX-domain socket.
Ruslan Ermilov <ru@nginx.com>
parents: 772
diff changeset
264 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
265 <example>
f46a132af596 "memcached_pass" can be a UNIX-domain socket.
Ruslan Ermilov <ru@nginx.com>
parents: 772
diff changeset
266 memcached_pass unix:/tmp/memcached.socket;
f46a132af596 "memcached_pass" can be a UNIX-domain socket.
Ruslan Ermilov <ru@nginx.com>
parents: 772
diff changeset
267 </example>
363
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
268 </para>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
269
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 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
272 used in a round-robin fashion.
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
273 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
274 <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
275 </para>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
276
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
277 </directive>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
278
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
279
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
280 <directive name="memcached_read_timeout">
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
281 <syntax><value>time</value></syntax>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
282 <default>60s</default>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
283 <context>http</context>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
284 <context>server</context>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
285 <context>location</context>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
286
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
287 <para>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
288 Defines a timeout for reading a response from the memcached server.
1149
1501e5848052 Corrected the usage of the definite article.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
289 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
290 not for the transmission of the whole response.
1149
1501e5848052 Corrected the usage of the definite article.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
291 If the memcached server does not transmit anything within this time,
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 942
diff changeset
292 the connection is closed.
363
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
293 </para>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
294
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
295 </directive>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
296
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
297
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
298 <directive name="memcached_send_timeout">
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
299 <syntax><value>time</value></syntax>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
300 <default>60s</default>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
301 <context>http</context>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
302 <context>server</context>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
303 <context>location</context>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
304
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
305 <para>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
306 Sets a timeout for transmitting a request to the memcached server.
1149
1501e5848052 Corrected the usage of the definite article.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
307 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
308 not for the transmission of the whole request.
1149
1501e5848052 Corrected the usage of the definite article.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
309 If the memcached server does not receive anything within this time,
1501e5848052 Corrected the usage of the definite article.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
310 the connection is closed.
363
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
311 </para>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
312
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
313 </directive>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
314
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
315 </section>
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
316
1157
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 1151
diff changeset
317
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 1151
diff changeset
318 <section id="variables" name="Embedded Variables">
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 1151
diff changeset
319
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 1151
diff changeset
320 <para>
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 1151
diff changeset
321 <list type="tag">
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 1151
diff changeset
322
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 1151
diff changeset
323 <tag-name id="var_memcached_key"><var>$memcached_key</var></tag-name>
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 1151
diff changeset
324 <tag-desc>
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 1151
diff changeset
325 Defines a key for obtaining response from a memcached server.
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 1151
diff changeset
326 </tag-desc>
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 1151
diff changeset
327
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 1151
diff changeset
328 </list>
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 1151
diff changeset
329 </para>
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 1151
diff changeset
330
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 1151
diff changeset
331 </section>
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 1151
diff changeset
332
363
c7fccbe03827 English translation of ngx_http_memcached_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
333 </module>