mod_dav_fs.xml revision 860b4efe27e7c1c9a2bf5c872b29c90f76849b51
9d4ec6d2c59bd5845ac8bca5a5d790be9a772862Evan Hunt<?xml version="1.0"?>
9d4ec6d2c59bd5845ac8bca5a5d790be9a772862Evan Hunt<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
9d4ec6d2c59bd5845ac8bca5a5d790be9a772862Evan Hunt<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
9d4ec6d2c59bd5845ac8bca5a5d790be9a772862Evan Hunt<!-- $LastChangedRevision$ -->
9fa5a723e188ddb5e6165af4957ba789e17cfdf5Evan Hunt
f42c0dcca86f2009c089e27ba513cb6fc9ee88baEvan Hunt<!--
f42c0dcca86f2009c089e27ba513cb6fc9ee88baEvan Hunt Licensed to the Apache Software Foundation (ASF) under one or more
f42c0dcca86f2009c089e27ba513cb6fc9ee88baEvan Hunt contributor license agreements. See the NOTICE file distributed with
7aba1a9660630ab7d16792b7388d9b8f56d7bf0fEvan Hunt this work for additional information regarding copyright ownership.
7aba1a9660630ab7d16792b7388d9b8f56d7bf0fEvan Hunt The ASF licenses this file to You under the Apache License, Version 2.0
7aba1a9660630ab7d16792b7388d9b8f56d7bf0fEvan Hunt (the "License"); you may not use this file except in compliance with
682a574e6716cea30386c38e68f4fc6c3d4b20e7Mark Andrews the License. You may obtain a copy of the License at
682a574e6716cea30386c38e68f4fc6c3d4b20e7Mark Andrews
3b9ba6bd74e2cbbc0f821e5483ebf46fa8c4d8deEvan Hunt http://www.apache.org/licenses/LICENSE-2.0
3b9ba6bd74e2cbbc0f821e5483ebf46fa8c4d8deEvan Hunt
3b9ba6bd74e2cbbc0f821e5483ebf46fa8c4d8deEvan Hunt Unless required by applicable law or agreed to in writing, software
3b9ba6bd74e2cbbc0f821e5483ebf46fa8c4d8deEvan Hunt distributed under the License is distributed on an "AS IS" BASIS,
1761ecb90ff770b87d0f021e13ad94d3e8c6f2afFrancis Dupont WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1761ecb90ff770b87d0f021e13ad94d3e8c6f2afFrancis Dupont See the License for the specific language governing permissions and
1761ecb90ff770b87d0f021e13ad94d3e8c6f2afFrancis Dupont limitations under the License.
f48358cffb35bb4b24731c136b07816bdcdce651Evan Hunt-->
f48358cffb35bb4b24731c136b07816bdcdce651Evan Hunt
f48358cffb35bb4b24731c136b07816bdcdce651Evan Hunt<modulesynopsis metafile="mod_dav_fs.xml.meta">
c3b554214416b434c6db7881907c962110aecba9Evan Hunt
c3b554214416b434c6db7881907c962110aecba9Evan Hunt<name>mod_dav_fs</name>
c3b554214416b434c6db7881907c962110aecba9Evan Hunt<description>filesystem provider for <module>mod_dav</module></description>
31707708c585c53b61ca1edb2e224e6bb1b985a5Evan Hunt<status>Extension</status>
31707708c585c53b61ca1edb2e224e6bb1b985a5Evan Hunt<sourcefile>mod_dav_fs.c</sourcefile>
b7e40659efd6cf6f5e6b3b1f904f16f74efb0d16Evan Hunt<identifier>dav_fs_module</identifier>
b7e40659efd6cf6f5e6b3b1f904f16f74efb0d16Evan Hunt
b7e40659efd6cf6f5e6b3b1f904f16f74efb0d16Evan Hunt<summary>
8f1e278931689460a49f0e9be610f2b2cc32c42dEvan Hunt <p>This module <em>requires</em> the service of <module
8f1e278931689460a49f0e9be610f2b2cc32c42dEvan Hunt >mod_dav</module>. It acts as a support module for <module
8f1e278931689460a49f0e9be610f2b2cc32c42dEvan Hunt >mod_dav</module> and provides access to resources located in the
166c4c6c5bafd25283b797979f77d780856fef30Evan Hunt server's file system. The formal name of this provider is
166c4c6c5bafd25283b797979f77d780856fef30Evan Hunt <code>filesystem</code>. <module>mod_dav</module> backend providers
166c4c6c5bafd25283b797979f77d780856fef30Evan Hunt will be invoked by using the <directive module="mod_dav">Dav</directive>
beb12aad6bebb0d6891613e65a4e19a42e6e3f8eMark Andrews directive:</p>
beb12aad6bebb0d6891613e65a4e19a42e6e3f8eMark Andrews
8e15d5eb3a000f1341e6bea0ddbc28d6dd2a0591Mark Andrews <example><title>Example</title>
8e15d5eb3a000f1341e6bea0ddbc28d6dd2a0591Mark Andrews Dav filesystem
8e15d5eb3a000f1341e6bea0ddbc28d6dd2a0591Mark Andrews </example>
1b2a4ce2b112ec91b0f13c411144e721c7952914Evan Hunt
1b2a4ce2b112ec91b0f13c411144e721c7952914Evan Hunt <p>Since <code>filesystem</code> is the default provider for
1b2a4ce2b112ec91b0f13c411144e721c7952914Evan Hunt <module>mod_dav</module>, you may simply use the value
e59937c7283216ca22ce6e7937b06eab6d97f4acEvan Hunt <code>On</code> instead.</p>
e59937c7283216ca22ce6e7937b06eab6d97f4acEvan Hunt</summary>
e59937c7283216ca22ce6e7937b06eab6d97f4acEvan Hunt<seealso><module>mod_dav</module></seealso>
89be55dc9040b119fd85bb33e7dc97d2ad454c6fEvan Hunt
89be55dc9040b119fd85bb33e7dc97d2ad454c6fEvan Hunt<directivesynopsis>
89be55dc9040b119fd85bb33e7dc97d2ad454c6fEvan Hunt<name>DavLockDB</name>
89be55dc9040b119fd85bb33e7dc97d2ad454c6fEvan Hunt<description>Location of the DAV lock database</description>
89be55dc9040b119fd85bb33e7dc97d2ad454c6fEvan Hunt<syntax>DavLockDB <var>file-path</var></syntax>
c6eb92beb1951b0634c349b24891522c273e9f69Mark Andrews<contextlist><context>server config</context><context>virtual host</context>
c6eb92beb1951b0634c349b24891522c273e9f69Mark Andrews</contextlist>
c6eb92beb1951b0634c349b24891522c273e9f69Mark Andrews
c6eb92beb1951b0634c349b24891522c273e9f69Mark Andrews<usage>
bf0441a339755618efcbe0b427afa5cb8e62dc68Evan Hunt <p>Use the <directive>DavLockDB</directive> directive to specify
bf0441a339755618efcbe0b427afa5cb8e62dc68Evan Hunt the full path to the lock database, excluding an extension. If
bf0441a339755618efcbe0b427afa5cb8e62dc68Evan Hunt the path is not absolute, it will be taken relative to <directive
8144dc702beec803d7b847e6f28ce845c57ae468Mark Andrews module="core">ServerRoot</directive>. The implementation of
8144dc702beec803d7b847e6f28ce845c57ae468Mark Andrews <module>mod_dav_fs</module> uses a SDBM database to track user
8144dc702beec803d7b847e6f28ce845c57ae468Mark Andrews locks.</p>
7ee225cf90fd06de61682b442600af88b68b99dbMark Andrews
7ee225cf90fd06de61682b442600af88b68b99dbMark Andrews <!-- XXX: someone should add that tool to the support directory...
5f1dc0d505d7f53f1e89a1a41e4c2415af4934feEvan Hunt The utility <code>modules/dav/util/lockview</code> can be used from
5f1dc0d505d7f53f1e89a1a41e4c2415af4934feEvan Hunt the server to display all locks in a lock database.</p> -->
5f1dc0d505d7f53f1e89a1a41e4c2415af4934feEvan Hunt
276457f7a38f56a5f762238ab89bb45e27948af6Evan Hunt <example><title>Example</title>
276457f7a38f56a5f762238ab89bb45e27948af6Evan Hunt DavLockDB var/DavLock
276457f7a38f56a5f762238ab89bb45e27948af6Evan Hunt </example>
2347c72129ce9393578966225f915284f0730214Mark Andrews
2347c72129ce9393578966225f915284f0730214Mark Andrews <p>The directory containing the lock database file must be
1e34fe9044874422104e84373988d07876f716b6Mark Andrews writable by the <directive module="mod_unixd">User</directive>
1e34fe9044874422104e84373988d07876f716b6Mark Andrews and <directive module="mod_unixd" >Group</directive> under which
1e34fe9044874422104e84373988d07876f716b6Mark Andrews Apache is running. For security reasons, you should create a
30d6dc14e918f9f72ff090c34d6e328ae8e7d68bCurtis Blackburn directory for this purpose rather than changing the permissions on
30d6dc14e918f9f72ff090c34d6e328ae8e7d68bCurtis Blackburn an existing directory. In the above example, Apache will create
5183f9d9daa139cbf000c12709877f62e79dfb14Evan Hunt files in the <code>var/</code> directory under the <directive
5183f9d9daa139cbf000c12709877f62e79dfb14Evan Hunt module="core">ServerRoot</directive> with the base filename
0193e63da91a4da27809b9a528eb043fa6b4da26Mark Andrews <code>DavLock</code> and extension name chosen by the server.</p>
0193e63da91a4da27809b9a528eb043fa6b4da26Mark Andrews
0193e63da91a4da27809b9a528eb043fa6b4da26Mark Andrews</usage>
17a00ff54c51f6bdfddd7d9ceaef6f2dcf387cc1Mark Andrews</directivesynopsis>
17a00ff54c51f6bdfddd7d9ceaef6f2dcf387cc1Mark Andrews
17a00ff54c51f6bdfddd7d9ceaef6f2dcf387cc1Mark Andrews</modulesynopsis>
5f238c3c64dd68100dc1b60f9c1e178522d1b333Mark Andrews
5f238c3c64dd68100dc1b60f9c1e178522d1b333Mark Andrews