<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><!--
        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
              This file is generated from xml source: DO NOT EDIT
        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
      --><title>mod_userdir - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"></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 cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td nowrap="nowrap" valign="top"><span class="help">Description:
                      </span></td><td>User-specific directories</td></tr><tr><td nowrap="nowrap"><a href="module-dict.html#Status" class="help">Status:
                      </a></td><td>Base</td></tr><tr><td nowrap="nowrap"><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>
<p>This module allows user-specific directories to be accessed using the
<code>http://example.com/~user/</code> syntax.</p>
<h2>Directives</h2><ul><li><a href="#userdir">UserDir</a></li></ul><p><strong>See also </strong></p><ul><li><a href="../urlmapping.html">Mapping URLs to the
Filesystem</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 nowrap="nowrap"><strong>Description: 
                  </strong></td><td>Location of the user-specific directories</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Syntax" class="help">Syntax:
                  </a></td><td>UserDir <em>directory-filename</em></td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Default" class="help">Default: 
                    </a></td><td><code>UserDir public_html</code></td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Context" class="help">Context:
                  </a></td><td>server config, virtual
host</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Status" class="help">Status:
                  </a></td><td>Base</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Module" class="help">Module:
                  </a></td><td>mod_userdir</td></tr></table></td></tr></table>

    <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
    <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. It is strongly
      recommended that your configuration include a "<code>UserDir
      disabled root</code>" declaration.  See also the <a href="../mod/core.html#directory" class="directive"><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></blockquote><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></body></html>