diff xml/en/docs/http/ngx_http_core_module.xml @ 418:2638f67205ee

Documented the disable_symlinks directive.
author Ruslan Ermilov <ru@nginx.com>
date Wed, 15 Feb 2012 21:45:42 +0000
parents 98dac2bd7598
children 8fa5f2273014
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_core_module.xml	Wed Feb 15 21:44:31 2012 +0000
+++ b/xml/en/docs/http/ngx_http_core_module.xml	Wed Feb 15 21:45:42 2012 +0000
@@ -464,6 +464,57 @@
 </directive>
 
 
+<directive name="disable_symlinks">
+<syntax>
+    <literal>on</literal> |
+    <literal>off</literal> |
+    <literal>if_not_owner</literal></syntax>
+<default>off</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.1.15</appeared-in>
+
+<para>
+Determines how nginx treats symbolic links when opening files:
+<list type="tag">
+
+<tag-name><literal>off</literal></tag-name>
+<tag-desc>
+Symbolic links in the pathname are not processed specially.
+This is the default behavior.
+</tag-desc>
+
+<tag-name><literal>on</literal></tag-name>
+<tag-desc>
+If any component of the pathname is a symbolic link,
+access to a file is denied.
+</tag-desc>
+
+<tag-name><literal>if_not_owner</literal></tag-name>
+<tag-desc>
+Access to a file is denied if any component of the pathname
+is a symbolic link, and the link and object that the link
+points to have different owners.
+</tag-desc>
+
+</list>
+</para>
+
+<para>
+This directive is only available on systems that have the
+<c-func>openat</c-func> and <c-func>fstatat</c-func> interfaces.
+This includes modern versions of FreeBSD, Linux, and Solaris.
+</para>
+
+<para>
+Parameters <literal>on</literal> and <literal>if_not_owner</literal>
+add a processing overhead.
+</para>
+
+</directive>
+
+
 <directive name="error_page">
 <syntax>
     <value>code</value> ...