]> granicus.if.org Git - apache/blob - docs/manual/mod/mod_dav.html.en
Regenerate HTML files with latest common.xsl.
[apache] / docs / manual / mod / mod_dav.html.en
1 <html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!-- 
2           XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
3                 This file is generated from xml source: DO NOT EDIT
4           XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
5         --><title>mod_dav- Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img src="../images/sub.gif" alt="[APACHE DOCUMENTATION]"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_dav</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td>Distributed Authoring and Versioning
6 (<a href="http://www.webdav.org/">WebDAV</a>) functionality</td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module&nbsp;Identifier:</a></td><td>dav_module</td></tr></table></td></tr></table><h2>Summary</h2>
7     <p>This module provides class 1 and class 2 <a href="http://www.webdav.org">WebDAV</a> ('Web-based Distributed
8     Authoring and Versioning') functionality for Apache. This
9     extension to the HTTP protocol allows creating, moving,
10     copying, and deleting resources and collections on a remote web
11     server.</p>
12
13     <p>To enable mod_dav, add the following to a container in your
14     <code>httpd.conf</code> file:</p>
15
16 <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>Dav On</code></td></tr></table></blockquote>
17
18     <p>Also, specify a valid filename for the DAV lock database by
19     adding the following to the global section in your
20     <code>httpd.conf</code> file:</p>
21
22 <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>DavLockDB /tmp/DavLock&nbsp;&nbsp;&nbsp;&nbsp;
23       <em>(Any web-server writable filename, without an
24       extension)</em>
25 </code></td></tr></table></blockquote>
26 <h2>Directives</h2><ul><li><a href="#dav">Dav</a></li><li><a href="#davdepthinfinity">DavDepthInfinity</a></li><li><a href="#davlockdb">DavLockDB</a></li><li><a href="#davmintimeout">DavMinTimeout</a></li></ul><hr/><h2><a name="Dav">Dav</a> <a name="dav">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td nowrap="nowrap"><strong>Description: </strong></td><td>Enable WebDAV HTTP methods</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>Dav on|off</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Dav off</code></td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_dav</td></tr></table></td></tr></table>
27     <p>Use the <code class="directive">Dav</code> directive to enable the
28     WebDAV HTTP methods for the given container. You may wish to add a
29     <a href="core.html#limit" class="directive"><code class="directive">&lt;Limit&gt;</code></a> clause
30     inside the <a href="core.html#location" class="directive"><code class="directive">&lt;location&gt;</code></a> directive to limit access to
31     DAV-enabled locations.</p>
32
33 <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><p align="center"><strong>Example</strong></p><code>
34         DavLockDB /tmp/DavLock<br>
35         <br>
36          &lt;Location /foo&gt;<br>
37          Dav On<br>
38         <br>
39          AuthType Basic<br>
40          AuthName DAV<br>
41          AuthUserFile user.passwd<br>
42         <br>
43          &nbsp;&nbsp;&lt;LimitExcept GET HEAD OPTIONS&gt;<br>
44          &nbsp;&nbsp;require user admin<br>
45          &nbsp;&nbsp;&lt;/LimitExcept&gt;<br>
46          &lt;/Location&gt;<br>
47 </code></td></tr></table></blockquote>
48 <hr/><h2><a name="DavDepthInfinity">DavDepthInfinity</a> <a name="davdepthinfinity">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td nowrap="nowrap"><strong>Description: </strong></td><td>Allow PROPFIND, Depth: Infinity requests</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>DavDepthInfinity on|off</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>DavDepthInfinity off</code></td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_dav</td></tr></table></td></tr></table>
49     <p>Use the <code class="directive">DavDepthInfinity</code> directive to
50     allow the processing of PROPFIND requests containing the header
51     'Depth: Infinity'. Because this type of request could constitute a
52     denial-of-service attack, by default it is not allowed.</p>
53 <hr/><h2><a name="DavLockDB">DavLockDB</a> <a name="davlockdb">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td nowrap="nowrap"><strong>Description: </strong></td><td>Location of the DAV lock database</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>DavLockDB <em>file-path</em></td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_dav</td></tr></table></td></tr></table>
54     <p>Use the <code class="directive">DavLockDB</code> directive to specify
55     the full path to the lock database, excluding an extension. The
56     default (file system) implementation of mod_dav uses a SDBM
57     database to track user locks. The utility
58     <code>modules/dav/util/lockview</code> can be used from the server
59     to display all locks in a lock database.</p>
60
61 <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><p align="center"><strong>Example</strong></p><code>
62 DavLockDB /tmp/DavLock
63 </code></td></tr></table></blockquote>
64 <hr/><h2><a name="DavMinTimeout">DavMinTimeout</a> <a name="davmintimeout">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td nowrap="nowrap"><strong>Description: </strong></td><td>Minimum amount of time the server holds a lock on
65 a DAV resource</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>DavMinTimeout <em>seconds</em></td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>DavMinTimeout 0</code></td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_dav</td></tr></table></td></tr></table>
66     <p>When a client requests a DAV resource lock, it can also
67     specify a time when the lock will be automatically removed by
68     the server. This value is only a request, and the server can
69     ignore it or inform the client of an arbitrary value.</p>
70
71     <p>Use the <code class="directive">DavMinTimeout</code> directive to specify, in
72     seconds, the minimum lock timeout to return to a client.
73     Microsoft Web Folders defaults to a timeout of 120 seconds; the
74     <code class="directive">DavMinTimeout</code> can override this to a higher value
75     (like 600 seconds) to reduce the chance of the client losing
76     the lock due to network latency.</p>
77
78 <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><p align="center"><strong>Example</strong></p><code>
79          &lt;Location /MSWord&gt;<br>
80          DavMinTimeout 600<br>
81          &lt;/Location&gt;<br>
82 </code></td></tr></table></blockquote>
83 <hr/></blockquote><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img src="../images/index.gif" alt="Index"/></a><a href="../"><img src="../images/home.gif" alt="Home"/></a></body></html>