mod_userdir.html revision 240a5b8962329911d02566b600be6226e1f857ae
2N/A<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
2N/AXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
2N/A This file is generated from xml source: DO NOT EDIT
2N/AXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
2N/A--><title>mod_userdir - Apache HTTP Server</title><link rel="stylesheet" type="text/css" href="/style/manual.css"/></head><body><blockquote><div align="center"><img src="/images/sub.gif" alt="[APACHE DOCUMENTATION]"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_userdir</h1><table bgcolor="#cccccc" cellpadding="0" cellspacing="1"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td>Provides for user-specific
2N/Adirectories</td></tr><tr><td><a class="help" href="module-dict.html#Status">Status:</a></td><td>Base</td></tr><tr><td><a class="help" href="module-dict.html#ModuleIdentifier">Module&nbsp;Identifier:</a></td><td>userdir_module</td></tr></table></td></tr></table><h2>Summary</h2>
2N/A<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 bgcolor="#cccccc" border="0" cellspacing="0" cellpadding="1"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the directory from which to serve files when requests
2N/Afor a particular user are received, denoted by requests containing
2N/A~username, such as
2N/Ahttp://server.example.com/~bob/</td></tr><tr><td><a class="help" href="directive-dict.html#Syntax">Syntax:</a></td><td>UserDir <em>directory-filename</em></td></tr><tr><td><a class="help" href="directive-dict.html#Default">Default:</a></td><td><code>UserDir public_html</code></td></tr><tr><td><a class="help" href="directive-dict.html#Context">Context:</a></td><td>server config, virtual
2N/Ahost</td></tr><tr><td><a class="help" href="directive-dict.html#Status">Status:</a></td><td>Base</td></tr><tr><td><a class="help" href="directive-dict.html#Module">Module:</a></td><td>mod_userdir</td></tr><tr><td valign="top" align="left"><a class="help" href="directive-dict.html#Compatibility">Compatibility:</a></td><td>All forms except the UserDir public_html
2N/Aform are only available in Apache 1.1 or above. Use of the
2N/Aenabled keyword, or disabled with a
2N/Alist of usernames, is only available in Apache 1.3 and
2N/Aabove.</td></tr></table></td></tr></table>
2N/A
2N/A <p>The <code class="directive">UserDir</code> directive sets the real
2N/A directory in a user's home directory to use when a request for a
2N/A document for a user is received. <em>Directory-filename</em> is
2N/A one of the following:</p>
2N/A
2N/A <ul>
2N/A <li>The name of a directory or a pattern such as those shown
2N/A below.</li>
2N/A
2N/A <li>The keyword <code>disabled</code>. This turns off
2N/A <em>all</em> username-to-directory translations except those
2N/A explicitly named with the <code>enabled</code> keyword (see
2N/A below).</li>
2N/A
2N/A <li>The keyword <code>disabled</code> followed by a
2N/A space-delimited list of usernames. Usernames that appear in
2N/A such a list will <em>never</em> have directory translation
2N/A performed, even if they appear in an <code>enabled</code>
2N/A clause.</li>
2N/A
2N/A <li>The keyword <code>enabled</code> followed by a
2N/A space-delimited list of usernames. These usernames will have
2N/A directory translation performed even if a global disable is
2N/A in effect, but not if they also appear in a
2N/A <code>disabled</code> clause.</li>
2N/A </ul>
2N/A
2N/A <p>If neither the <code>enabled</code> nor the
2N/A <code>disabled</code> keywords appear in the
2N/A <code>Userdir</code> directive, the argument is treated as a
2N/A filename pattern, and is used to turn the name into a directory
2N/A specification. A request for
2N/A <code>http://www.foo.com/~bob/one/two.html</code> will be
2N/A translated to:</p>
2N/A
2N/A<table>
2N/A<tr><th>UserDir directive used</th>
2N/A<th>Translated path</th></tr>
2N/A<tr><td>UserDir public_html</td><td>~bob/public_html/one/two.html</td></tr>
2N/A<tr><td>UserDir /usr/web</td><td>/usr/web/bob/one/two.html</td></tr>
2N/A<tr><td>UserDir /home/*/www</td><td>/home/bob/www/one/two.html</td></tr>
2N/A</table>
2N/A
2N/A <p>The following directives will send redirects to the client:</p>
2N/A
2N/A<table>
2N/A<tr><th>UserDir directive used</th>
2N/A<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 <a class="directive" href="core.html#directory"><code class="directive">Directory</code></a>
directive and the <a href="/misc/security_tips.html">Security
Tips</a> page for more information.</strong>
</td></tr></table></blockquote>
<p>Additional examples:</p>
<p>To allow a few users to have <code>UserDir</code> directories, but
not anyone else, use the following:</p>
<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
UserDir disabled<br/>
UserDir enabled user1 user2 user3
</code></td></tr></table></blockquote>
<p>To allow most users to have <code>UserDir</code> directories, but
deny this to a few, use the following:</p>
<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
UserDir enabled<br/>
UserDir disabled user4 user5 user6
</code></td></tr></table></blockquote>
<hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img src="/images/index.gif" alt="Index"/></a><a href="../"><img src="/images/home.gif" alt="Home"/></a></blockquote></body></html>