changeset 1384:66ee77849563

Documented the use_temp_path parameter of the proxy_cache_path directive.
author Yaroslav Zhuravlev <yar@nginx.com>
date Wed, 24 Dec 2014 19:31:21 +0300
parents 0f63ac5c9463
children f08ae1f79000
files xml/en/docs/http/ngx_http_fastcgi_module.xml xml/en/docs/http/ngx_http_proxy_module.xml xml/en/docs/http/ngx_http_scgi_module.xml xml/en/docs/http/ngx_http_uwsgi_module.xml xml/ru/docs/http/ngx_http_fastcgi_module.xml xml/ru/docs/http/ngx_http_proxy_module.xml xml/ru/docs/http/ngx_http_scgi_module.xml xml/ru/docs/http/ngx_http_uwsgi_module.xml
diffstat 8 files changed, 116 insertions(+), 16 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_fastcgi_module.xml
+++ b/xml/en/docs/http/ngx_http_fastcgi_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_fastcgi_module"
         link="/en/docs/http/ngx_http_fastcgi_module.html"
         lang="en"
-        rev="26">
+        rev="27">
 
 <section id="summary">
 
@@ -323,6 +323,7 @@ will be cached.
 <syntax>
     <value>path</value>
     [<literal>levels</literal>=<value>levels</value>]
+    [<literal>use_temp_path</literal>=<literal>on</literal>|<literal>off</literal>]
     <literal>keys_zone</literal>=<value>name</value>:<value>size</value>
     [<literal>inactive</literal>=<value>time</value>]
     [<literal>max_size</literal>=<value>size</value>]
@@ -357,8 +358,15 @@ different file systems.
 However, be aware that in this case a file is copied
 across two file systems instead of the cheap renaming operation.
 It is thus recommended that for any given location both cache and a directory
-holding temporary files, set by the <link id="fastcgi_temp_path"/> directive,
+holding temporary files
 are put on the same file system.
+A directory for temporary files is set based on
+the <literal>use_temp_path</literal> parameter (1.7.10).
+If this parameter is omitted or set to the value <literal>on</literal>,
+the directory set by the <link id="fastcgi_temp_path"/> directive
+for the given location will be used.
+If the value is set to <literal>off</literal>,
+temporary files will be put directly in the cache directory.
 </para>
 
 <para>
@@ -1350,6 +1358,11 @@ a temporary file might look like this:
 </example>
 </para>
 
+<para>
+See also the <literal>use_temp_path</literal> parameter of the
+<link id="fastcgi_cache_path"/> directive.
+</para>
+
 </directive>
 
 </section>
--- a/xml/en/docs/http/ngx_http_proxy_module.xml
+++ b/xml/en/docs/http/ngx_http_proxy_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_proxy_module"
         link="/en/docs/http/ngx_http_proxy_module.html"
         lang="en"
-        rev="34">
+        rev="35">
 
 <section id="summary">
 
@@ -321,6 +321,7 @@ will be cached.
 <syntax>
     <value>path</value>
     [<literal>levels</literal>=<value>levels</value>]
+    [<literal>use_temp_path</literal>=<literal>on</literal>|<literal>off</literal>]
     <literal>keys_zone</literal>=<value>name</value>:<value>size</value>
     [<literal>inactive</literal>=<value>time</value>]
     [<literal>max_size</literal>=<value>size</value>]
@@ -355,8 +356,15 @@ different file systems.
 However, be aware that in this case a file is copied
 across two file systems instead of the cheap renaming operation.
 It is thus recommended that for any given location both cache and a directory
-holding temporary files, set by the <link id="proxy_temp_path"/> directive,
+holding temporary files
 are put on the same file system.
+A directory for temporary files is set based on
+the <literal>use_temp_path</literal> parameter (1.7.10).
+If this parameter is omitted or set to the value <literal>on</literal>,
+the directory set by the <link id="proxy_temp_path"/> directive
+for the given location will be used.
+If the value is set to <literal>off</literal>,
+temporary files will be put directly in the cache directory.
 </para>
 
 <para>
@@ -1941,6 +1949,11 @@ a temporary file might look like this:
 </example>
 </para>
 
+<para>
+See also the <literal>use_temp_path</literal> parameter of the
+<link id="proxy_cache_path"/> directive.
+</para>
+
 </directive>
 
 </section>
--- a/xml/en/docs/http/ngx_http_scgi_module.xml
+++ b/xml/en/docs/http/ngx_http_scgi_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_scgi_module"
         link="/en/docs/http/ngx_http_scgi_module.html"
         lang="en"
-        rev="14">
+        rev="15">
 
 <section id="summary">
 
@@ -314,6 +314,7 @@ will be cached.
 <syntax>
     <value>path</value>
     [<literal>levels</literal>=<value>levels</value>]
+    [<literal>use_temp_path</literal>=<literal>on</literal>|<literal>off</literal>]
     <literal>keys_zone</literal>=<value>name</value>:<value>size</value>
     [<literal>inactive</literal>=<value>time</value>]
     [<literal>max_size</literal>=<value>size</value>]
@@ -348,8 +349,15 @@ different file systems.
 However, be aware that in this case a file is copied
 across two file systems instead of the cheap renaming operation.
 It is thus recommended that for any given location both cache and a directory
-holding temporary files, set by the <link id="scgi_temp_path"/> directive,
+holding temporary files
 are put on the same file system.
+A directory for temporary files is set based on
+the <literal>use_temp_path</literal> parameter (1.7.10).
+If this parameter is omitted or set to the value <literal>on</literal>,
+the directory set by the <link id="scgi_temp_path"/> directive
+for the given location will be used.
+If the value is set to <literal>off</literal>,
+temporary files will be put directly in the cache directory.
 </para>
 
 <para>
@@ -1198,6 +1206,11 @@ a temporary file might look like this:
 </example>
 </para>
 
+<para>
+See also the <literal>use_temp_path</literal> parameter of the
+<link id="scgi_cache_path"/> directive.
+</para>
+
 </directive>
 
 </section>
--- a/xml/en/docs/http/ngx_http_uwsgi_module.xml
+++ b/xml/en/docs/http/ngx_http_uwsgi_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_uwsgi_module"
         link="/en/docs/http/ngx_http_uwsgi_module.html"
         lang="en"
-        rev="16">
+        rev="17">
 
 <section id="summary">
 
@@ -314,6 +314,7 @@ will be cached.
 <syntax>
     <value>path</value>
     [<literal>levels</literal>=<value>levels</value>]
+    [<literal>use_temp_path</literal>=<literal>on</literal>|<literal>off</literal>]
     <literal>keys_zone</literal>=<value>name</value>:<value>size</value>
     [<literal>inactive</literal>=<value>time</value>]
     [<literal>max_size</literal>=<value>size</value>]
@@ -348,8 +349,15 @@ different file systems.
 However, be aware that in this case a file is copied
 across two file systems instead of the cheap renaming operation.
 It is thus recommended that for any given location both cache and a directory
-holding temporary files, set by the <link id="uwsgi_temp_path"/> directive,
+holding temporary files
 are put on the same file system.
+A directory for temporary files is set based on
+the <literal>use_temp_path</literal> parameter (1.7.10).
+If this parameter is omitted or set to the value <literal>on</literal>,
+the directory set by the <link id="uwsgi_temp_path"/> directive
+for the given location will be used.
+If the value is set to <literal>off</literal>,
+temporary files will be put directly in the cache directory.
 </para>
 
 <para>
@@ -1455,6 +1463,11 @@ a temporary file might look like this:
 </example>
 </para>
 
+<para>
+See also the <literal>use_temp_path</literal> parameter of the
+<link id="uwsgi_cache_path"/> directive.
+</para>
+
 </directive>
 
 </section>
--- a/xml/ru/docs/http/ngx_http_fastcgi_module.xml
+++ b/xml/ru/docs/http/ngx_http_fastcgi_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_fastcgi_module"
         link="/ru/docs/http/ngx_http_fastcgi_module.html"
         lang="ru"
-        rev="26">
+        rev="27">
 
 <section id="summary">
 
@@ -321,6 +321,7 @@ fastcgi_cache_key localhost:9000$request
 <syntax>
     <value>путь</value>
     [<literal>levels</literal>=<value>уровни</value>]
+    [<literal>use_temp_path</literal>=<literal>on</literal>|<literal>off</literal>]
     <literal>keys_zone</literal>=<value>имя</value>:<value>размер</value>
     [<literal>inactive</literal>=<value>время</value>]
     [<literal>max_size</literal>=<value>размер</value>]
@@ -355,8 +356,14 @@ fastcgi_cache_path /data/nginx/cache lev
 что в этом случае вместо дешёвой операции переименовывания в пределах
 одной файловой системы файл копируется с одной файловой системы на другую.
 Поэтому лучше, если кэш будет находиться на той же файловой
-системе, что и каталог с временными файлами, задаваемый директивой
+системе, что и каталог с временными файлами.
+Какой из каталогов будет использоваться для временных файлов
+определяется параметром <literal>use_temp_path</literal> (1.7.10).
+Если параметр не задан или установлен в значение “<literal>on</literal>”,
+то будет использоваться каталог, задаваемый директивой
 <link id="fastcgi_temp_path"/> для данного location.
+Если параметр установлен в значение “<literal>off</literal>”,
+то временные файлы будут располагаться непосредственно в каталоге кэша.
 </para>
 
 <para>
@@ -1343,6 +1350,11 @@ fastcgi_temp_path /spool/nginx/fastcgi_t
 </example>
 </para>
 
+<para>
+См. также параметр <literal>use_temp_path</literal> директивы
+<link id="fastcgi_cache_path"/>.
+</para>
+
 </directive>
 
 </section>
--- a/xml/ru/docs/http/ngx_http_proxy_module.xml
+++ b/xml/ru/docs/http/ngx_http_proxy_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_proxy_module"
         link="/ru/docs/http/ngx_http_proxy_module.html"
         lang="ru"
-        rev="34">
+        rev="35">
 
 <section id="summary">
 
@@ -319,6 +319,7 @@ proxy_cache_key $scheme$proxy_host$uri$i
 <syntax>
     <value>путь</value>
     [<literal>levels</literal>=<value>уровни</value>]
+    [<literal>use_temp_path</literal>=<literal>on</literal>|<literal>off</literal>]
     <literal>keys_zone</literal>=<value>имя</value>:<value>размер</value>
     [<literal>inactive</literal>=<value>время</value>]
     [<literal>max_size</literal>=<value>размер</value>]
@@ -353,8 +354,14 @@ proxy_cache_path /data/nginx/cache level
 что в этом случае вместо дешёвой операции переименовывания в пределах
 одной файловой системы файл копируется с одной файловой системы на другую.
 Поэтому лучше, если кэш будет находиться на той же файловой
-системе, что и каталог с временными файлами, задаваемый директивой
+системе, что и каталог с временными файлами.
+Какой из каталогов будет использоваться для временных файлов
+определяется параметром <literal>use_temp_path</literal> (1.7.10).
+Если параметр не задан или установлен в значение “<literal>on</literal>”,
+то будет использоваться каталог, задаваемый директивой
 <link id="proxy_temp_path"/> для данного location.
+Если параметр установлен в значение “<literal>off</literal>”,
+то временные файлы будут располагаться непосредственно в каталоге кэша.
 </para>
 
 <para>
@@ -1940,6 +1947,11 @@ proxy_temp_path /spool/nginx/proxy_temp 
 </example>
 </para>
 
+<para>
+См. также параметр <literal>use_temp_path</literal> директивы
+<link id="proxy_cache_path"/>.
+</para>
+
 </directive>
 
 </section>
--- a/xml/ru/docs/http/ngx_http_scgi_module.xml
+++ b/xml/ru/docs/http/ngx_http_scgi_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_scgi_module"
         link="/ru/docs/http/ngx_http_scgi_module.html"
         lang="ru"
-        rev="14">
+        rev="15">
 
 <section id="summary">
 
@@ -312,6 +312,7 @@ scgi_cache_key localhost:9000$request_ur
 <syntax>
     <value>путь</value>
     [<literal>levels</literal>=<value>уровни</value>]
+    [<literal>use_temp_path</literal>=<literal>on</literal>|<literal>off</literal>]
     <literal>keys_zone</literal>=<value>имя</value>:<value>размер</value>
     [<literal>inactive</literal>=<value>время</value>]
     [<literal>max_size</literal>=<value>размер</value>]
@@ -346,8 +347,14 @@ scgi_cache_path /data/nginx/cache levels
 что в этом случае вместо дешёвой операции переименовывания в пределах
 одной файловой системы файл копируется с одной файловой системы на другую.
 Поэтому лучше, если кэш будет находиться на той же файловой
-системе, что и каталог с временными файлами, задаваемый директивой
+системе, что и каталог с временными файлами.
+Какой из каталогов будет использоваться для временных файлов
+определяется параметром <literal>use_temp_path</literal> (1.7.10).
+Если параметр не задан или установлен в значение “<literal>on</literal>”,
+то будет использоваться каталог, задаваемый директивой
 <link id="scgi_temp_path"/> для данного location.
+Если параметр установлен в значение “<literal>off</literal>”,
+то временные файлы будут располагаться непосредственно в каталоге кэша.
 </para>
 
 <para>
@@ -1192,6 +1199,11 @@ scgi_temp_path /spool/nginx/scgi_temp 1 
 </example>
 </para>
 
+<para>
+См. также параметр <literal>use_temp_path</literal> директивы
+<link id="scgi_cache_path"/>.
+</para>
+
 </directive>
 
 </section>
--- a/xml/ru/docs/http/ngx_http_uwsgi_module.xml
+++ b/xml/ru/docs/http/ngx_http_uwsgi_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_uwsgi_module"
         link="/ru/docs/http/ngx_http_uwsgi_module.html"
         lang="ru"
-        rev="16">
+        rev="17">
 
 <section id="summary">
 
@@ -312,6 +312,7 @@ uwsgi_cache_key localhost:9000$request_u
 <syntax>
     <value>путь</value>
     [<literal>levels</literal>=<value>уровни</value>]
+    [<literal>use_temp_path</literal>=<literal>on</literal>|<literal>off</literal>]
     <literal>keys_zone</literal>=<value>имя</value>:<value>размер</value>
     [<literal>inactive</literal>=<value>время</value>]
     [<literal>max_size</literal>=<value>размер</value>]
@@ -346,8 +347,14 @@ uwsgi_cache_path /data/nginx/cache level
 что в этом случае вместо дешёвой операции переименовывания в пределах
 одной файловой системы файл копируется с одной файловой системы на другую.
 Поэтому лучше, если кэш будет находиться на той же файловой
-системе, что и каталог с временными файлами, задаваемый директивой
+системе, что и каталог с временными файлами.
+Какой из каталогов будет использоваться для временных файлов
+определяется параметром <literal>use_temp_path</literal> (1.7.10).
+Если параметр не задан или установлен в значение “<literal>on</literal>”,
+то будет использоваться каталог, задаваемый директивой
 <link id="uwsgi_temp_path"/> для данного location.
+Если параметр установлен в значение “<literal>off</literal>”,
+то временные файлы будут располагаться непосредственно в каталоге кэша.
 </para>
 
 <para>
@@ -1449,6 +1456,11 @@ uwsgi_temp_path /spool/nginx/uwsgi_temp 
 </example>
 </para>
 
+<para>
+См. также параметр <literal>use_temp_path</literal> директивы
+<link id="uwsgi_cache_path"/>.
+</para>
+
 </directive>
 
 </section>