mod_userdir.html revision 72d8c9a30f25171e5c85eeae21e0b87331bac2d9
<html>
<head>
<!--
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-->
<title>mod_userdir - Apache HTTP Server</title>
</head>
<body>
<blockquote>
<div align="center">
</div>
<h1 align="center">Apache Module mod_userdir</h1>
<table cellspacing="1" cellpadding="0" bgcolor="#cccccc">
<tr>
<td>
<table bgcolor="#ffffff">
<tr>
<td><span class="help">Description:</span></td><td>
<description>This module provides for user-specific
directories.</description>
</td>
</tr>
<tr>
</tr>
<tr>
<td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>userdir_module</td>
</tr>
</table>
</td>
</tr>
</table>
<h2>Summary</h2>
<summary>
</summary>
<h2>Directives</h2>
<ul>
<li>
<a href="#userdir">UserDir</a>
</li>
</ul>
<hr>
<h2>
<a name="UserDir">UserDir</a> <a name="userdir">Directive</a>
</h2>
<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
<tr>
<td>
<table width="100%" bgcolor="#ffffff">
<tr>
<td><strong>Description: </strong></td><td>Sets the directory from which to serve files when requests
for a particular user are received, denoted by requests containing
~username, such as
</tr>
<tr>
<syntax>UserDir <em>directory-filename</em>
</syntax>
</td>
</tr>
<tr>
<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>UserDir public_html</code></td>
</tr>
<tr>
host</td>
</tr>
<tr>
</tr>
<tr>
</tr>
<tr>
<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>All forms except the UserDir public_html
form are only available in Apache 1.1 or above. Use of the
enabled keyword, or disabled with a
list of usernames, is only available in Apache 1.3 and
above.</td>
</tr>
</table>
</td>
</tr>
</table>
<usage>
<p>The <code class="directive">UserDir</code> directive sets the real
directory in a user's home directory to use when a request for a
document for a user is received. <em>Directory-filename</em> is
one of the following:</p>
<ul>
<li>The name of a directory or a pattern such as those shown
below.</li>
<li>The keyword <code>disabled</code>. This turns off
<em>all</em> username-to-directory translations except those
explicitly named with the <code>enabled</code> keyword (see
below).</li>
<li>The keyword <code>disabled</code> followed by a
space-delimited list of usernames. Usernames that appear in
such a list will <em>never</em> have directory translation
performed, even if they appear in an <code>enabled</code>
clause.</li>
<li>The keyword <code>enabled</code> followed by a
space-delimited list of usernames. These usernames will have
directory translation performed even if a global disable is
in effect, but not if they also appear in a
<code>disabled</code> clause.</li>
</ul>
<p>If neither the <code>enabled</code> nor the
<code>disabled</code> keywords appear in the
<code>Userdir</code> directive, the argument is treated as a
filename pattern, and is used to turn the name into a directory
specification. A request for
translated to:</p>
<table>
<tr>
<th>UserDir directive used</th>
<th>Translated path</th>
</tr>
<tr>
</tr>
<tr>
</tr>
<tr>
</tr>
</table>
<p>The following directives will send redirects to the client:</p>
<table>
<tr>
<th>UserDir directive used</th>
<th>Translated path</th>
</tr>
<tr>
</tr>
<tr>
<td>UserDir
</tr>
<tr>
<td>UserDir
</tr>
</table>
<blockquote>
<table>
<tr>
<td bgcolor="#e0e5f5">
<strong>Be careful when using this directive; for instance,
<code>"UserDir ./"</code> would map
<code>"/~root"</code> to <code>"/"</code> - which is probably
undesirable. If you are running Apache 1.3 or above, it is
strongly recommended that your configuration include a
"<code>UserDir disabled root</code>" declaration.
See also the <code class="directive"><a href="core.html#directory" class="directive">Directory</a></code>
directive and the <a href="/misc/security_tips.html">Security
Tips</a> page for more information.</strong>
</td>
</tr>
</table>
</blockquote>
</usage>
<hr>
<h3 align="center">Apache HTTP Server Version 2.0</h3>
<a href="./"><img alt="Index" src="/images/index.gif"></a><a href="../"><img alt="Home" src="/images/home.gif"></a>
</blockquote>
</body>
</html>