mod_userdir.html revision 1b55e9e0a3c5fb40d9e46d3e6f711516a9a807fa
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw This file is generated from xml source: DO NOT EDIT
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw--><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><description>This module provides for user-specific
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwdirectories.</description></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><summary>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw</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 bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets the directory from which to serve files when requests
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwfor a particular user are received, denoted by requests containing
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw~username, such as
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwhttp://server.example.com/~bob/</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><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><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwhost</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
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwform are only available in Apache 1.1 or above. Use of the
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwenabled keyword, or disabled with a
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwlist of usernames, is only available in Apache 1.3 and
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwabove.</td></tr></table></td></tr></table><usage>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <p>The <code class="directive">UserDir</code> directive sets the real
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw directory in a user's home directory to use when a request for a
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw document for a user is received. <em>Directory-filename</em> is
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw one of the following:</p>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States <ul>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <li>The name of a directory or a pattern such as those shown
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw below.</li>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <li>The keyword <code>disabled</code>. This turns off
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <em>all</em> username-to-directory translations except those
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw explicitly named with the <code>enabled</code> keyword (see
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw below).</li>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <li>The keyword <code>disabled</code> followed by a
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw space-delimited list of usernames. Usernames that appear in
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw such a list will <em>never</em> have directory translation
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw performed, even if they appear in an <code>enabled</code>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw clause.</li>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
8d7e41661dc4633488e93b13363137523ce59977jose borrego <li>The keyword <code>enabled</code> followed by a
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw space-delimited list of usernames. These usernames will have
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw directory translation performed even if a global disable is
8d7e41661dc4633488e93b13363137523ce59977jose borrego in effect, but not if they also appear in a
8d7e41661dc4633488e93b13363137523ce59977jose borrego <code>disabled</code> clause.</li>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </ul>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <p>If neither the <code>enabled</code> nor the
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <code>disabled</code> keywords appear in the
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <code>Userdir</code> directive, the argument is treated as a
8d7e41661dc4633488e93b13363137523ce59977jose borrego filename pattern, and is used to turn the name into a directory
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw specification. A request for
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States <code>http://www.foo.com/~bob/one/two.html</code> will be
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States translated to:</p>
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States
7f667e74610492ddbce8ce60f52ece95d2401949jose borrego<table>
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States<tr><th>UserDir directive used</th>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<th>Translated path</th></tr>
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States<tr><td>UserDir public_html</td><td>~bob/public_html/one/two.html</td></tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<tr><td>UserDir /usr/web</td><td>/usr/web/bob/one/two.html</td></tr>
8d7e41661dc4633488e93b13363137523ce59977jose borrego<tr><td>UserDir /home/*/www</td><td>/home/bob/www/one/two.html</td></tr>
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States</table>
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <p>The following directives will send redirects to the client:</p>
7f667e74610492ddbce8ce60f52ece95d2401949jose borrego
7f667e74610492ddbce8ce60f52ece95d2401949jose borrego<table>
7f667e74610492ddbce8ce60f52ece95d2401949jose borrego<tr><th>UserDir directive used</th>
7f667e74610492ddbce8ce60f52ece95d2401949jose borrego<th>Translated path</th></tr>
7f667e74610492ddbce8ce60f52ece95d2401949jose borrego<tr><td>UserDir http://www.foo.com/users</td><td>http://www.foo.com/users/bob/one/two.html</td></tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<tr><td>UserDir
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwhttp://www.foo.com/*/usr</td><td>http://www.foo.com/bob/usr/one/two.html</td></tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<tr><td>UserDir
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwhttp://www.foo.com/~*/</td><td>http://www.foo.com/~bob/one/two.html</td></tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw</table>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States<blockquote><table><tr><td bgcolor="#e0e5f5">
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States <strong>Be careful when using this directive; for instance,
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States <code>"UserDir ./"</code> would map
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States <code>"/~root"</code> to <code>"/"</code> - which is probably
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States undesirable. If you are running Apache 1.3 or above, it is
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States strongly recommended that your configuration include a
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States "<code>UserDir disabled root</code>" declaration.
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States See also the <a href="core.html#directory" class="directive"><code class="directive">Directory</code></a>
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States directive and the <a href="/misc/security_tips.html">Security
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States Tips</a> page for more information.</strong>
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States</td></tr></table></blockquote>
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States<p>Additional examples:</p>
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States<p>To allow a few users to have <code>UserDir</code> directories, but
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United Statesnot anyone else, use the following:</p>
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
8d7e41661dc4633488e93b13363137523ce59977jose borregoUserDir disabled<br>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwUserDir enabled user1 user2 user3
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States</code></td></tr></table></blockquote>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States<p>To allow most users to have <code>UserDir</code> directories, but
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United Statesdeny this to a few, use the following:</p>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United StatesUserDir enabled<br>
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United StatesUserDir disabled user4 user5 user6
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw</code></td></tr></table></blockquote>
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States</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>