Project

General

Profile

Docs ModUserDir » History » Revision 8

Revision 7 (stbuehler, 2008-03-10 11:53) → Revision 8/10 (stbuehler, 2009-02-17 10:45)

h1. Module [[TracNav(DocsToc)]] 

 <pre> 

 #!rst  

 ======= 
 userdir 
 ======= 

 ------------------- 
 Module: mod_userdir 
 ------------------- 

 {{toc}} 

 h2. .. contents:: Table of Contents 



 Description 
 =========== 

 The userdir module provides a simple way to link user-based directories into the global namespace of the webserver. 

 Requests in the form @/~user/page.html@ ``/~user/page.html`` are rewritten to take the file @page.html@ ``page.html`` from the home directory of the user. 
 If @userdir.path@ ``userdir.path`` is set, the path will be appended to the home directory 
 building the classic mapping of: 

 <pre> 
 # :: 

   userdir.path = "public_html" 

   URL: http://www.example.org/~jan/index.html  
 #  
   Path: /home/jan/public_html/ 

 userdir.path = "public_html" 
 </pre> 

 To control which users should be able to use this feature you can set a list of usernames to include or exclude. 

 In case your mapping is independent of /etc/passwd you can use @userdir.basepath@: 

 <pre> 
 # URL: http://www.example.org/~jan/index.html 
 # Path: /var/www/users/jan/htdocs/index.html 

 ``userdir.basepath``: :: 

   userdir.path = "htdocs" 
 
   userdir.basepath = "/var/www/users/" 
 </pre> 

   URL: http://www.example.org/~jan/index.html 
   Path: /var/www/users/jan/htdocs/index.html 

 h2. Options 
 ======= 

 h3. userdir.path (required option) 

 
   usually it should be set to "public_html" to take ~/public_html/ as the document root 
 default: 
    
   Default: unset (mod_userdir disabled; set it to "" if you want the home directory to be the document root as it was the default before 1.4.19) 
 
   Example: 

    :: 

     userdir.path = "public_html" 

 h3. userdir.exclude-user 

 
   list of usernames which may not use this feature 
 default: Default: empty (all users may use it) 
 
   Example: 

    :: 

     userdir.exclude-user = ( "root", "postmaster" ) 

 h3. 


 userdir.include-user 

 
   if set, only users from this list may use the feature 
 default: 

   Default: empty (all users may use it) 

 h3. userdir.basepath 

 
   if set, don't check /etc/passwd for homedir 
 


 </pre>