~ubuntu-branches/ubuntu/natty/lighttpd/natty

« back to all changes in this revision

Viewing changes to doc/userdir.txt

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Marek
  • Date: 2005-11-26 11:48:51 UTC
  • Revision ID: james.westby@ubuntu.com-20051126114851-76t9q0rrwbzjnt2t
Tags: upstream-1.4.8
ImportĀ upstreamĀ versionĀ 1.4.8

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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 at 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 include- or a exclude list for username.
 
36
 
 
37
In case you 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
 
50
  usually it should set the "public_html" to take ~/public_html/ as the document-root
 
51
    
 
52
  Default: empty (document-root is the home-directory)
 
53
  Example: ::
 
54
 
 
55
    userdir.path = "public_html"
 
56
 
 
57
userdir.exclude-user
 
58
  list of usernames which should not be able to 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 user may use it)
 
70
 
 
71
userdir.basepath
 
72
  if set, don't check /etc/passwd for homedir