mod_userdir.html revision 72d8c9a30f25171e5c85eeae21e0b87331bac2d9
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<html>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<head>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
3e14f97f673e8a630f076077de35afdd43dc1587Roger A. Faulkner<!--
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chinXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin This file is generated from xml source: DO NOT EDIT
7c2fbfb345896881c631598ee3852ce9ce33fb07April ChinXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin-->
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<title>mod_userdir - Apache HTTP Server</title>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<link href="/style/manual.css" type="text/css" rel="stylesheet">
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</head>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<body>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<blockquote>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<div align="center">
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<img alt="[APACHE DOCUMENTATION]" src="/images/sub.gif"><h3>Apache HTTP Server Version 2.0</h3>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</div>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<h1 align="center">Apache Module mod_userdir</h1>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<table cellspacing="1" cellpadding="0" bgcolor="#cccccc">
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<tr>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<td>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<table bgcolor="#ffffff">
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<tr>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<td><span class="help">Description:</span></td><td>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<description>This module provides for user-specific
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chindirectories.</description>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</td>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</tr>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<tr>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</tr>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<tr>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<td><a href="module-dict.html#ModuleIdentifier" class="help">Module&nbsp;Identifier:</a></td><td>userdir_module</td>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</tr>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</table>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</td>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</tr>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</table>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<h2>Summary</h2>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<summary>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</summary>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<h2>Directives</h2>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<ul>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<li>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<a href="#userdir">UserDir</a>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</li>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</ul>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<hr>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<h2>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<a name="UserDir">UserDir</a> <a name="userdir">Directive</a>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</h2>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<tr>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<td>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<table width="100%" bgcolor="#ffffff">
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<tr>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<td><strong>Description: </strong></td><td>Sets the directory from which to serve files when requests
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chinfor a particular user are received, denoted by requests containing
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin~username, such as
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chinhttp://server.example.com/~bob/</td>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</tr>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<tr>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<syntax>UserDir <em>directory-filename</em>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</syntax>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</td>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</tr>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<tr>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>UserDir public_html</code></td>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</tr>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<tr>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chinhost</td>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</tr>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<tr>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</tr>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<tr>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_userdir</td>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</tr>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<tr>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>All forms except the UserDir public_html
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chinform are only available in Apache 1.1 or above. Use of the
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chinenabled keyword, or disabled with a
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chinlist of usernames, is only available in Apache 1.3 and
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chinabove.</td>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</tr>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</table>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</td>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</tr>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin</table>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<usage>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<p>The <code class="directive">UserDir</code> directive sets the real
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin directory in a user's home directory to use when a request for a
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin document for a user is received. <em>Directory-filename</em> is
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin one of the following:</p>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<ul>
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<li>The name of a directory or a pattern such as those shown
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin 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
<code>http://www.foo.com/~bob/one/two.html</code> will be
translated to:</p>
<table>
<tr>
<th>UserDir directive used</th>
<th>Translated path</th>
</tr>
<tr>
<td>UserDir public_html</td><td>~bob/public_html/one/two.html</td>
</tr>
<tr>
<td>UserDir /usr/web</td><td>/usr/web/bob/one/two.html</td>
</tr>
<tr>
<td>UserDir /home/*/www</td><td>/home/bob/www/one/two.html</td>
</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>
<td>UserDir http://www.foo.com/users</td><td>http://www.foo.com/users/bob/one/two.html</td>
</tr>
<tr>
<td>UserDir
http://www.foo.com/*/usr</td><td>http://www.foo.com/bob/usr/one/two.html</td>
</tr>
<tr>
<td>UserDir
http://www.foo.com/~*/</td><td>http://www.foo.com/~bob/one/two.html</td>
</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>