mod_dav.xml revision d1e705efc6b288edbe466fd1af69d228f508361e
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive<?xml version="1.0"?>
530eba85dbd41b8a0fa5255d3648d1440199a661slive<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
e942c741056732f50da2074b36fe59805d370650slive<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive<modulesynopsis>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive<name>mod_dav</name>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive<description>Distributed Authoring and Versioning
d24d4c5159bcb11c25bb294926cfe7105c789ea9slive(<a href="http://www.webdav.org/">WebDAV</a>) functionality</description>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive<status>Extension</status>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive<sourcefile>mod_dav.c</sourcefile>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive<identifier>dav_module</identifier>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive<summary>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive <p>This module provides class 1 and class 2 <a
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive href="http://www.webdav.org">WebDAV</a> ('Web-based Distributed
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive Authoring and Versioning') functionality for Apache. This
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive extension to the HTTP protocol allows creating, moving,
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive copying, and deleting resources and collections on a remote web
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive server.</p>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive</summary>
d1e705efc6b288edbe466fd1af69d228f508361end<seealso><directive module="mod_dav_fs">DavLockDB</directive></seealso>
d1e705efc6b288edbe466fd1af69d228f508361end<seealso><directive module="core">LimitXMLRequestBody</directive></seealso>
d1e705efc6b288edbe466fd1af69d228f508361end<seealso><a href="http://www.webdav.org">WebDAV Resources</a></seealso>
d1e705efc6b288edbe466fd1af69d228f508361end
d1e705efc6b288edbe466fd1af69d228f508361end<section id="example"><title>Enabling WebDAV</title>
d1e705efc6b288edbe466fd1af69d228f508361end <p>To enable <module>mod_dav</module>, add the following to a
d1e705efc6b288edbe466fd1af69d228f508361end container in your <code>httpd.conf</code> file:</p>
d1e705efc6b288edbe466fd1af69d228f508361end
d1e705efc6b288edbe466fd1af69d228f508361end <example>Dav On</example>
d1e705efc6b288edbe466fd1af69d228f508361end
d1e705efc6b288edbe466fd1af69d228f508361end <p>This enables the DAV file system provider, which is implemented by
d1e705efc6b288edbe466fd1af69d228f508361end the <module>mod_dav_fs</module> module. Therefore that module has to
d1e705efc6b288edbe466fd1af69d228f508361end be compiled into the server or has to be loaded at runtime using the
d1e705efc6b288edbe466fd1af69d228f508361end <directive module="mod_so">LoadModule</directive> directive.</p>
d1e705efc6b288edbe466fd1af69d228f508361end
d1e705efc6b288edbe466fd1af69d228f508361end <p>In order to make it work you have to specify a web-server writable
d1e705efc6b288edbe466fd1af69d228f508361end filename for the DAV lock database by adding the following to the
d1e705efc6b288edbe466fd1af69d228f508361end global section in your <code>httpd.conf</code> file:</p>
d1e705efc6b288edbe466fd1af69d228f508361end
d1e705efc6b288edbe466fd1af69d228f508361end <example>
d1e705efc6b288edbe466fd1af69d228f508361end DavLockDB /tmp/DavLock
d1e705efc6b288edbe466fd1af69d228f508361end </example>
d1e705efc6b288edbe466fd1af69d228f508361end
d1e705efc6b288edbe466fd1af69d228f508361end <p>You may wish to add a <directive module="core" type="section"
d1e705efc6b288edbe466fd1af69d228f508361end >Limit</directive> clause inside the <directive module="core"
d1e705efc6b288edbe466fd1af69d228f508361end type="section">Location</directive> directive to limit access to
d1e705efc6b288edbe466fd1af69d228f508361end DAV-enabled locations. If you want to set the maximum amount of
d1e705efc6b288edbe466fd1af69d228f508361end bytes that a DAV client can send at one request, you have to use
d1e705efc6b288edbe466fd1af69d228f508361end the <directive module="core">LimitXMLRequestBody</directive>
d1e705efc6b288edbe466fd1af69d228f508361end directive. The "normal" <directive module="core"
d1e705efc6b288edbe466fd1af69d228f508361end >LimitRequestBody</directive> directive has no effect on DAV
d1e705efc6b288edbe466fd1af69d228f508361end requests.</p>
d1e705efc6b288edbe466fd1af69d228f508361end
d1e705efc6b288edbe466fd1af69d228f508361end <example><title>Full Example</title>
d1e705efc6b288edbe466fd1af69d228f508361end DavLockDB /tmp/DavLock<br />
d1e705efc6b288edbe466fd1af69d228f508361end <br />
d1e705efc6b288edbe466fd1af69d228f508361end &lt;Location /foo&gt;<br />
d1e705efc6b288edbe466fd1af69d228f508361end <indent>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive Dav On<br />
d1e705efc6b288edbe466fd1af69d228f508361end <br />
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive AuthType Basic<br />
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive AuthName DAV<br />
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive AuthUserFile user.passwd<br />
d1e705efc6b288edbe466fd1af69d228f508361end <br />
d1e705efc6b288edbe466fd1af69d228f508361end &lt;LimitExcept GET HEAD OPTIONS&gt;<br />
d1e705efc6b288edbe466fd1af69d228f508361end <indent>
d1e705efc6b288edbe466fd1af69d228f508361end require user admin<br />
d1e705efc6b288edbe466fd1af69d228f508361end </indent>
d1e705efc6b288edbe466fd1af69d228f508361end &lt;/LimitExcept&gt;<br />
d1e705efc6b288edbe466fd1af69d228f508361end </indent>
d1e705efc6b288edbe466fd1af69d228f508361end &lt;/Location&gt;<br />
d1e705efc6b288edbe466fd1af69d228f508361end </example>
d1e705efc6b288edbe466fd1af69d228f508361end
d1e705efc6b288edbe466fd1af69d228f508361end <note type="warning"><title>Security</title>
d1e705efc6b288edbe466fd1af69d228f508361end <p>The use of HTTP Basic Authentication is not recommended. You
d1e705efc6b288edbe466fd1af69d228f508361end should use at least HTTP Digest Authentication, which is provided by
d1e705efc6b288edbe466fd1af69d228f508361end the <module>mod_auth_digest</module> module. Nearly all WebDAV clients
d1e705efc6b288edbe466fd1af69d228f508361end support this authentication method. Of course, Basic Authentication
d1e705efc6b288edbe466fd1af69d228f508361end over an <a href="/ssl/">SSL</a> enabled connection is secure,
d1e705efc6b288edbe466fd1af69d228f508361end too.</p>
d1e705efc6b288edbe466fd1af69d228f508361end </note>
d1e705efc6b288edbe466fd1af69d228f508361end</section>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive<directivesynopsis>
d1e705efc6b288edbe466fd1af69d228f508361end<name>Dav</name>
d1e705efc6b288edbe466fd1af69d228f508361end<description>Enable WebDAV HTTP methods</description>
d1e705efc6b288edbe466fd1af69d228f508361end<syntax>Dav On|Off|<var>provider-name</var></syntax>
d1e705efc6b288edbe466fd1af69d228f508361end<default>Dav Off</default>
d1e705efc6b288edbe466fd1af69d228f508361end<contextlist><context>directory</context></contextlist>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive<usage>
d1e705efc6b288edbe466fd1af69d228f508361end <p>Use the <directive>Dav</directive> directive to enable the
d1e705efc6b288edbe466fd1af69d228f508361end WebDAV HTTP methods for the given container:</p>
d1e705efc6b288edbe466fd1af69d228f508361end
d1e705efc6b288edbe466fd1af69d228f508361end <example>
d1e705efc6b288edbe466fd1af69d228f508361end &lt;Location /foo&gt;<br />
d1e705efc6b288edbe466fd1af69d228f508361end <indent>
d1e705efc6b288edbe466fd1af69d228f508361end Dav On<br />
d1e705efc6b288edbe466fd1af69d228f508361end </indent>
d1e705efc6b288edbe466fd1af69d228f508361end &lt;/Location&gt;
d1e705efc6b288edbe466fd1af69d228f508361end </example>
d1e705efc6b288edbe466fd1af69d228f508361end
d1e705efc6b288edbe466fd1af69d228f508361end <p>The value <code>On</code> is actually an alias for the default
d1e705efc6b288edbe466fd1af69d228f508361end provider <code>filesystem</code> which is served by the <module
d1e705efc6b288edbe466fd1af69d228f508361end >mod_dav_fs</module> module. Note, that once you have DAV enabled
d1e705efc6b288edbe466fd1af69d228f508361end for some location, it <em>cannot</em> be disabled for sublocations.
d1e705efc6b288edbe466fd1af69d228f508361end For a complete configuration example have a look at the <a
d1e705efc6b288edbe466fd1af69d228f508361end href="#example">section above</a>.</p>
d1e705efc6b288edbe466fd1af69d228f508361end
d1e705efc6b288edbe466fd1af69d228f508361end <note type="warning">
d1e705efc6b288edbe466fd1af69d228f508361end Do not enable WebDAV until you have secured your server. Otherwise
d1e705efc6b288edbe466fd1af69d228f508361end everyone will be able to distribute files on your system.
d1e705efc6b288edbe466fd1af69d228f508361end </note>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive</usage>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive</directivesynopsis>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive<directivesynopsis>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive<name>DavMinTimeout</name>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive<description>Minimum amount of time the server holds a lock on
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slivea DAV resource</description>
d1e705efc6b288edbe466fd1af69d228f508361end<syntax>DavMinTimeout <var>seconds</var></syntax>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive<default>DavMinTimeout 0</default>
d1e705efc6b288edbe466fd1af69d228f508361end<contextlist><context>server config</context><context>virtual host</context>
d1e705efc6b288edbe466fd1af69d228f508361end<context>directory</context></contextlist>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive<usage>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive <p>When a client requests a DAV resource lock, it can also
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive specify a time when the lock will be automatically removed by
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive the server. This value is only a request, and the server can
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive ignore it or inform the client of an arbitrary value.</p>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive <p>Use the <directive>DavMinTimeout</directive> directive to specify, in
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive seconds, the minimum lock timeout to return to a client.
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive Microsoft Web Folders defaults to a timeout of 120 seconds; the
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive <directive>DavMinTimeout</directive> can override this to a higher value
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive (like 600 seconds) to reduce the chance of the client losing
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive the lock due to network latency.</p>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive
d1e705efc6b288edbe466fd1af69d228f508361end <example><title>Example</title>
d1e705efc6b288edbe466fd1af69d228f508361end &lt;Location /MSWord&gt;<br />
d1e705efc6b288edbe466fd1af69d228f508361end <indent>
d1e705efc6b288edbe466fd1af69d228f508361end DavMinTimeout 600<br />
d1e705efc6b288edbe466fd1af69d228f508361end </indent>
d1e705efc6b288edbe466fd1af69d228f508361end &lt;/Location&gt;
d1e705efc6b288edbe466fd1af69d228f508361end </example>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive</usage>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive</directivesynopsis>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive<directivesynopsis>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive<name>DavDepthInfinity</name>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive<description>Allow PROPFIND, Depth: Infinity requests</description>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive<syntax>DavDepthInfinity on|off</syntax>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive<default>DavDepthInfinity off</default>
d1e705efc6b288edbe466fd1af69d228f508361end<contextlist><context>server config</context><context>virtual host</context>
d1e705efc6b288edbe466fd1af69d228f508361end<context>directory</context></contextlist>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive<usage>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive <p>Use the <directive>DavDepthInfinity</directive> directive to
d1e705efc6b288edbe466fd1af69d228f508361end allow the processing of <code>PROPFIND</code> requests containing the
d1e705efc6b288edbe466fd1af69d228f508361end header 'Depth: Infinity'. Because this type of request could constitute
d1e705efc6b288edbe466fd1af69d228f508361end a denial-of-service attack, by default it is not allowed.</p>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive</usage>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive</directivesynopsis>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive</modulesynopsis>
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive
c1ce37b2dcce132ff0abf6a15f5225a0e89af5e4slive