doc/outdated/userdir.txt

   1 =======
   2 userdir
   3 =======
   4
   5 -------------------
   6 Module: mod_userdir
   7 -------------------
   8
   9 :Author: Jan Kneschke
  10 :Date: $Date: 2004/08/29 09:43:49 $
  11 :Revision: $Revision: 1.1 $
  12
  13 :abstract:
  14   The userdir module ...
  15
  16 .. meta::
  17   :keywords: lighttpd, userdir
  18
  19 .. contents:: Table of Contents
  20
  21 Description
  22 ===========
  23
  24 The userdir module provides a simple way to link user-based directories into the global namespace of the webserver.
  25
  26 Requests in the form ``/~user/page.html`` are rewritten to take the file ``page.html`` from the home directory of the user.
  27 If ``userdir.path`` is set, the path will be appended to the home directory
  28 building the classic mapping of: ::
  29
  30   userdir.path = "public_html"
  31
  32   URL: http://www.example.org/~jan/index.html
  33   Path: /home/jan/public_html/
  34
  35 To control which users should be able to use this feature you can set a list of usernames to include or exclude.
  36
  37 In case your mapping is independent of /etc/passwd you can use
  38 ``userdir.basepath``: ::
  39
  40   userdir.path = "htdocs"
  41   userdir.basepath = "/var/www/users/"
  42
  43   URL: http://www.example.org/~jan/index.html
  44   Path: /var/www/users/jan/htdocs/index.html
  45
  46 Options
  47 =======
  48
  49 userdir.path (required option)
  50   usually it should be set to "public_html" to take ~/public_html/ as the document root
  51
  52   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)
  53   Example: ::
  54
  55     userdir.path = "public_html"
  56
  57 userdir.exclude-user
  58   list of usernames which may not use this feature
  59
  60   Default: empty (all users may use it)
  61   Example: ::
  62
  63     userdir.exclude-user = ( "root", "postmaster" )
  64
  65
  66 userdir.include-user
  67   if set, only users from this list may use the feature
  68
  69   Default: empty (all users may use it)
  70
  71 userdir.basepath
  72   if set, don't check /etc/passwd for homedir