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