changeset 438:b27974b92a58

- corrected the description of the from= parameter of the disable_symlinks directive, added a note about modules that do not currently respect this directive - mentioned that ngx_http_addition_module's directives also make internal requests
author Ruslan Ermilov <ru@nginx.com>
date Thu, 01 Mar 2012 16:46:47 +0000
parents fd183bec1830
children ad65616d1d78
files xml/en/docs/http/ngx_http_core_module.xml xml/ru/docs/http/ngx_http_core_module.xml
diffstat 2 files changed, 56 insertions(+), 28 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_core_module.xml	Wed Feb 29 14:36:07 2012 +0000
+++ b/xml/en/docs/http/ngx_http_core_module.xml	Thu Mar 01 16:46:47 2012 +0000
@@ -469,7 +469,7 @@
 <syntax>
     <literal>on</literal> |
     <literal>if_not_owner</literal>
-    [<literal>from</literal>=<value>prefix</value>]</syntax>
+    [<literal>from</literal>=<value>part</value>]</syntax>
 <default>off</default>
 <context>http</context>
 <context>server</context>
@@ -499,18 +499,21 @@
 points to have different owners.
 </tag-desc>
 
-<tag-name><literal>from</literal>=<value>prefix</value></tag-name>
+<tag-name><literal>from</literal>=<value>part</value></tag-name>
 <tag-desc>
 When checking symbolic links
 (parameters <literal>on</literal> and <literal>if_not_owner</literal>),
-each component of the pathname is normally checked.
-If however the
-<literal>from</literal>=<value>prefix</value> is also given,
-symbolic links are checked only from the component of the pathname
-specified by <value>prefix</value>.
-The <value>prefix</value> value can contain variables.
-If a value is not a prefix of the checked pathname, the whole
+all components of the pathname are normally checked.
+Checking of symbolic links in the initial part of the pathname
+may be avoided by also specifying the
+<literal>from</literal>=<value>part</value> parameter.
+In this case, symbolic links are checked only from
+the component of the pathname following the specified initial part.
+If a value is not an initial part of the checked pathname, the whole
 pathname is checked as if this parameter was not specified at all.
+If a value fully matches the file name,
+symbolic links are not checked.
+The parameter value can contain variables.
 </tag-desc>
 
 </list>
@@ -534,9 +537,18 @@
 add a processing overhead.
 <note>
 On systems that do not support opening directories for search only,
-the use of these parameters requires that
-worker processes be able to read all intermediate
-directories.
+the use of these parameters requires that worker processes
+have read permissions for all checked directories.
+</note>
+</para>
+
+<para>
+<note>
+The
+<link doc="ngx_http_autoindex_module.xml">ngx_http_autoindex_module</link>,
+<link doc="ngx_http_random_index_module.xml">ngx_http_random_index_module</link>,
+and <link doc="ngx_http_dav_module.xml">ngx_http_dav_module.xml</link>
+modules currently ignore this directive.
 </note>
 </para>
 
@@ -702,8 +714,11 @@
 <listitem>
 subrequests formed by the
 “<command>include virtual</command>”
-command of the module
-<link doc="ngx_http_ssi_module.xml">ngx_http_ssi_module</link>;
+command of the
+<link doc="ngx_http_ssi_module.xml">ngx_http_ssi_module</link>
+module and by the
+<link doc="ngx_http_addition_module.xml">ngx_http_addition_module</link>
+module directives;
 </listitem>
 
 <listitem>
--- a/xml/ru/docs/http/ngx_http_core_module.xml	Wed Feb 29 14:36:07 2012 +0000
+++ b/xml/ru/docs/http/ngx_http_core_module.xml	Thu Mar 01 16:46:47 2012 +0000
@@ -458,7 +458,7 @@
 <syntax>
     <literal>on</literal> |
     <literal>if_not_owner</literal>
-    [<literal>from</literal>=<value>префикс</value>]</syntax>
+    [<literal>from</literal>=<value>часть</value>]</syntax>
 <default>off</default>
 <context>http</context>
 <context>server</context>
@@ -489,18 +489,21 @@
 который она ссылается, имеют разных владельцев.
 </tag-desc>
 
-<tag-name><literal>from</literal>=<value>префикс</value></tag-name>
+<tag-name><literal>from</literal>=<value>часть</value></tag-name>
 <tag-desc>
 При проверке символических ссылок
 (параметры <literal>on</literal> и <literal>if_not_owner</literal>)
-обычно проверяется каждый элемент пути.
-Однако если дополнительно указан параметр
-<literal>from</literal>=<value>префикс</value>,
-символические ссылки проверяются лишь начиная с элемента пути,
-заданного префиксом.
-В значении префикса можно использовать переменные.
-Если значение не является префиксом проверяемого пути,
+обычно проверяются все компоненты пути.
+Можно не проверять символические ссылки в начальной части пути,
+указав дополнительно параметр
+<literal>from</literal>=<value>часть</value>.
+В этом случае символические ссылки проверяются лишь начиная
+с компонента пути, который следует за заданной начальной частью.
+Если значение не является начальной частью проверяемого пути,
 путь проверяется целиком, как если бы этот параметр не был указан вовсе.
+Если значение целиком совпадает с именем файла,
+символические ссылки не проверяются.
+В значении параметра можно использовать переменные.
 </tag-desc>
 
 </list>
@@ -524,11 +527,19 @@
 требуют дополнительных затрат на обработку.
 <note>
 На системах, не поддерживающих операцию открытия каталогов только для поиска,
-использование этих параметров требует, чтобы
-рабочие процессы имели возможность читать все
-промежуточные каталоги.
+использование этих параметров требует, чтобы рабочие процессы
+имели право читать все проверяемые каталоги.
 </note>
-
+</para>
+
+<para>
+<note>
+Модули
+<link doc="ngx_http_autoindex_module.xml">ngx_http_autoindex_module</link>,
+<link doc="ngx_http_random_index_module.xml">ngx_http_random_index_module</link>
+и <link doc="ngx_http_dav_module.xml">ngx_http_dav_module.xml</link>
+в настоящий момент игнорируют эту директиву.
+</note>
 </para>
 
 </directive>
@@ -690,7 +701,9 @@
 подзапросы, формируемые командой
 “<command>include virtual</command>”
 модуля
-<link doc="ngx_http_ssi_module.xml">ngx_http_ssi_module</link>;
+<link doc="ngx_http_ssi_module.xml">ngx_http_ssi_module</link>
+и директивами модуля
+<link doc="ngx_http_addition_module.xml">ngx_http_addition_module</link>;
 </listitem>
 
 <listitem>