]> granicus.if.org Git - apache/blob - docs/manual/mod/mod_dav.html.en
update transformation due to the change of synopsis.xsl
[apache] / docs / manual / mod / mod_dav.html.en
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
4         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
5               This file is generated from xml source: DO NOT EDIT
6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7       --><title>mod_dav - Apache HTTP Server</title><link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /><link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /><link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link href="../images/favicon.ico" rel="shortcut icon" /></head><body><div id="page-header"><p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p><p class="apache">Apache HTTP Server Version 2.0</p><img alt="" src="../images/feather.gif" /></div><div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div><div id="path"><a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs-project/">Documentation</a> &gt; <a href="../">Version 2.0</a> &gt; <a href="./">Modules</a></div><div id="page-content"><div id="preamble"><h1>Apache Module mod_dav</h1><table class="module"><tr><th><a href="module-dict.html#Description">Description:
8                   </a></th><td>Distributed Authoring and Versioning
9 (<a href="http://www.webdav.org/">WebDAV</a>) functionality</td></tr><tr><th><a href="module-dict.html#Status">Status:
10                   </a></th><td>Extension</td></tr><tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:
11                   </a></th><td>dav_module</td></tr><tr><th><a href="module-dict.html#SourceFile">Source File:
12                   </a></th><td>mod_dav.c</td></tr></table><h3>Summary</h3>
13     <p>This module provides class 1 and class 2 <a href="http://www.webdav.org">WebDAV</a> ('Web-based Distributed
14     Authoring and Versioning') functionality for Apache. This
15     extension to the HTTP protocol allows creating, moving,
16     copying, and deleting resources and collections on a remote web
17     server.</p>
18
19     <p>To enable mod_dav, add the following to a container in your
20     <code>httpd.conf</code> file:</p>
21
22 <div class="example"><p><code>Dav On</code></p></div>
23
24     <p>Also, specify a valid filename for the DAV lock database by
25     adding the following to the global section in your
26     <code>httpd.conf</code> file:</p>
27
28 <div class="example"><p><code>DavLockDB /tmp/DavLock    
29       <em>(Any web-server writable filename, without an
30       extension)</em>
31 </code></p></div>
32 </div><div id="quickview"><h3 class="directives">Directives</h3><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#dav">Dav</a></li>
33 <li><img alt="" src="../images/down.gif" /> <a href="#davdepthinfinity">DavDepthInfinity</a></li>
34 <li><img alt="" src="../images/down.gif" /> <a href="#davlockdb">DavLockDB</a></li>
35 <li><img alt="" src="../images/down.gif" /> <a href="#davmintimeout">DavMinTimeout</a></li>
36 </ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="Dav" id="Dav">Dav</a> <a name="dav" id="dav">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description: 
37               </a></th><td>Enable WebDAV HTTP methods</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
38               </a></th><td><code>Dav on|off</code></td></tr><tr><th><a href="directive-dict.html#Default">Default: 
39               </a></th><td><code>Dav off</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
40               </a></th><td>directory</td></tr><tr><th><a href="directive-dict.html#Status">Status:
41               </a></th><td>Extension</td></tr><tr><th><a href="directive-dict.html#Module">Module:
42               </a></th><td>mod_dav</td></tr></table>
43     <p>Use the <code class="directive">Dav</code> directive to enable the
44     WebDAV HTTP methods for the given container. You may wish to add a
45     <code class="directive"><a href="../mod/core.html#limit">&lt;Limit&gt;</a></code> clause
46     inside the <code class="directive"><a href="../mod/core.html#location">&lt;location&gt;</a></code> directive to limit access to
47     DAV-enabled locations.</p>
48
49 <div class="example"><h3>Example</h3><p><code>
50         DavLockDB /tmp/DavLock<br />
51         <br />
52          &lt;Location /foo&gt;<br />
53          Dav On<br />
54         <br />
55          AuthType Basic<br />
56          AuthName DAV<br />
57          AuthUserFile user.passwd<br />
58         <br />
59            &lt;LimitExcept GET HEAD OPTIONS&gt;<br />
60            require user admin<br />
61            &lt;/LimitExcept&gt;<br />
62          &lt;/Location&gt;<br />
63 </code></p></div>
64 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="DavDepthInfinity" id="DavDepthInfinity">DavDepthInfinity</a> <a name="davdepthinfinity" id="davdepthinfinity">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description: 
65               </a></th><td>Allow PROPFIND, Depth: Infinity requests</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
66               </a></th><td><code>DavDepthInfinity on|off</code></td></tr><tr><th><a href="directive-dict.html#Default">Default: 
67               </a></th><td><code>DavDepthInfinity off</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
68               </a></th><td>directory</td></tr><tr><th><a href="directive-dict.html#Status">Status:
69               </a></th><td>Extension</td></tr><tr><th><a href="directive-dict.html#Module">Module:
70               </a></th><td>mod_dav</td></tr></table>
71     <p>Use the <code class="directive">DavDepthInfinity</code> directive to
72     allow the processing of PROPFIND requests containing the header
73     'Depth: Infinity'. Because this type of request could constitute a
74     denial-of-service attack, by default it is not allowed.</p>
75 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="DavLockDB" id="DavLockDB">DavLockDB</a> <a name="davlockdb" id="davlockdb">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description: 
76               </a></th><td>Location of the DAV lock database</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
77               </a></th><td><code>DavLockDB <em>file-path</em></code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
78               </a></th><td>server config, virtual host</td></tr><tr><th><a href="directive-dict.html#Status">Status:
79               </a></th><td>Extension</td></tr><tr><th><a href="directive-dict.html#Module">Module:
80               </a></th><td>mod_dav</td></tr></table>
81     <p>Use the <code class="directive">DavLockDB</code> directive to specify
82     the full path to the lock database, excluding an extension. The
83     default (file system) implementation of mod_dav uses a SDBM
84     database to track user locks. The utility
85     <code>modules/dav/util/lockview</code> can be used from the server
86     to display all locks in a lock database.</p>
87
88 <div class="example"><h3>Example</h3><p><code>
89 DavLockDB /tmp/DavLock
90 </code></p></div>
91 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="DavMinTimeout" id="DavMinTimeout">DavMinTimeout</a> <a name="davmintimeout" id="davmintimeout">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description: 
92               </a></th><td>Minimum amount of time the server holds a lock on
93 a DAV resource</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
94               </a></th><td><code>DavMinTimeout <em>seconds</em></code></td></tr><tr><th><a href="directive-dict.html#Default">Default: 
95               </a></th><td><code>DavMinTimeout 0</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
96               </a></th><td>directory</td></tr><tr><th><a href="directive-dict.html#Status">Status:
97               </a></th><td>Extension</td></tr><tr><th><a href="directive-dict.html#Module">Module:
98               </a></th><td>mod_dav</td></tr></table>
99     <p>When a client requests a DAV resource lock, it can also
100     specify a time when the lock will be automatically removed by
101     the server. This value is only a request, and the server can
102     ignore it or inform the client of an arbitrary value.</p>
103
104     <p>Use the <code class="directive">DavMinTimeout</code> directive to specify, in
105     seconds, the minimum lock timeout to return to a client.
106     Microsoft Web Folders defaults to a timeout of 120 seconds; the
107     <code class="directive">DavMinTimeout</code> can override this to a higher value
108     (like 600 seconds) to reduce the chance of the client losing
109     the lock due to network latency.</p>
110
111 <div class="example"><h3>Example</h3><p><code>
112          &lt;Location /MSWord&gt;<br />
113          DavMinTimeout 600<br />
114          &lt;/Location&gt;<br />
115 </code></p></div>
116 </div></div><div id="footer"><p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p><p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div></body></html>