Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_dav_module.xml @ 371:e5e7d6365612

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
English translation of ngx_http_dav_module.
author Ruslan Ermilov <ru@nginx.com>
date Mon, 30 Jan 2012 07:32:54 +0000
parents
children be54c443235a
comparison
equal deleted inserted replaced
370:66414a4eb347 371:e5e7d6365612
1 <?xml version="1.0"?>
2
3 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
4
5 <module name="Module ngx_http_dav_module"
6 link="/en/docs/http/ngx_http_dav_module.html"
7 lang="en">
8
9 <section id="summary">
10
11 <para>
12 The <literal>ngx_http_dav_module</literal> module processes HTTP and WebDAV
13 methods PUT, DELETE, MKCOL, COPY, and MOVE.
14 </para>
15
16 <para>
17 This module is not built by default, it should be enabled with the
18 <literal>--with-http_dav_module</literal>
19 configuration parameter.
20 </para>
21
22 </section>
23
24
25 <section id="example" name="Example Configuration">
26
27 <para>
28 <example>
29 location / {
30 root /data/www;
31
32 client_body_temp_path /data/client_temp;
33
34 dav_methods PUT DELETE MKCOL COPY MOVE;
35
36 create_full_put_path on;
37 dav_access group:rw all:r;
38
39 limit_except GET {
40 allow 192.168.1.0/32;
41 deny all;
42 }
43 }
44 </example>
45 </para>
46
47 </section>
48
49
50 <section id="directives" name="Directives">
51
52 <directive name="dav_access">
53 <syntax><value>users</value>:<value>permissions</value> ...</syntax>
54 <default>user:rw</default>
55 <context>http</context>
56 <context>server</context>
57 <context>location</context>
58
59 <para>
60 Sets access permissions for newly created files and directories, e.g.:
61 <example>
62 dav_access user:rw group:rw all:r;
63 </example>
64 </para>
65
66 <para>
67 If any <literal>group</literal> or <literal>all</literal> access permissions
68 are specified then <literal>user</literal> permissions may be omitted:
69 <example>
70 dav_access group:rw all:r;
71 </example>
72 </para>
73
74 </directive>
75
76
77 <directive name="dav_methods">
78 <syntax>
79 <literal>off</literal> | <literal>put</literal> |
80 <literal>delete</literal> | <literal>mkcol</literal> |
81 <literal>copy</literal> | <literal>move</literal>
82 ...</syntax>
83 <default>off</default>
84 <context>http</context>
85 <context>server</context>
86 <context>location</context>
87
88 <para>
89 Allows the specified HTTP and WebDAV methods.
90 The parameter <literal>off</literal> denies all methods processed
91 by this module, ignoring other parameters;
92 </para>
93
94 <para>
95 A file uploaded with the PUT method is first written to a temporary file,
96 then a file is renamed.
97 Starting from version 0.8.9 temporary files and the persistent store
98 can be put on different file systems but be aware that in this case
99 a file is copied across two file systems instead of the cheap rename operation.
100 It is thus recommended that for any given location both saved files and a
101 directory holding temporary files set by the
102 <link doc="ngx_http_core_module.xml" id="client_body_temp_path"/>
103 directive are put on the same file system.
104 </para>
105
106 <para>
107 When creating a file with the PUT method, it is possible to specify
108 the modification date by passing it in the <header>Date</header>
109 header field.
110 </para>
111
112 </directive>
113
114
115 <directive name="create_full_put_path">
116 <syntax><literal>on</literal> | <literal>off</literal></syntax>
117 <default>off</default>
118 <context>http</context>
119 <context>server</context>
120 <context>location</context>
121
122 <para>
123 The WebDAV specification only allows to create files in already
124 existing directories.
125 This directive allows to create all needed intermediate directories.
126 </para>
127
128 </directive>
129
130
131 <directive name="min_delete_depth">
132 <syntax><value>number</value></syntax>
133 <default>0</default>
134 <context>http</context>
135 <context>server</context>
136 <context>location</context>
137
138 <para>
139 Allows the DELETE method to remove files provided that
140 the number of elements in a request path is not less than the specified.
141 For example, the directive
142 <example>
143 min_delete_depth 4;
144 </example>
145 allows to remove files on requests
146 <example>
147 /users/00/00/name
148 /users/00/00/name/pic.jpg
149 /users/00/00/page.html
150 </example>
151 and denies the removal of
152 <example>
153 /users/00/00
154 </example>
155 </para>
156
157 </directive>
158
159 </section>
160
161 </module>