← Back to branch summary

~ubuntu-branches/ubuntu/feisty/lighttpd/feisty

« back to all changes in this revision

Viewing changes to doc/status.txt

  • Committer: Bazaar Package Importer
  • Author(s): Krzysztof Krzyzaniak (eloy)
  • Date: 2006-01-16 20:06:39 UTC
  • mto: This revision was merged to the branch mainline in revision 6.
  • Revision ID: james.westby@ubuntu.com-20060116200639-nejjwyvlkgjhzasa
Tags: upstream-1.4.9
Import upstream version 1.4.9

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/status.txt
11
11
:Revision: $Revision: 1.2 $
12
12
 
13
13
:abstract:
14
 
  mod_status displays server-status and server-config
 
14
  mod_status displays the server's status and configuration
15
15
  
16
16
.. meta::
17
17
  :keywords: lighttpd, server status
21
21
Description
22
22
===========
23
23
 
24
 
The server status module generates the ... 
 
24
The server status module generates the status overview of the webserver. The
 
25
information covers:
 
26
 
 
27
- uptime
 
28
- average throughput
 
29
- current throughput
 
30
- active connections and their state
 
31
 
 
32
By default the status page is disabled to hide internal information from
 
33
unauthorized users. ::
 
34
 
 
35
  status.status-url = "/server-status"
 
36
 
 
37
If you want to open the status page just for users from the local network
 
38
cover it in a conditional. ::
 
39
 
 
40
  $HTTP["remoteip"] == "10.0.0.0/8" {
 
41
    status.status-url = "/server-status"
 
42
  }
 
43
 
 
44
Or require authorization: ::
 
45
  
 
46
  auth.require = ( "/server-status" => 
 
47
    ( "realm" ... ) )
 
48
 
 
49
 
 
50
Output Format
 
51
-------------
 
52
 
 
53
By default a nice looking HTML page is generated. If you append ?auto to the
 
54
status-url you can get a text version which is simpler to parse. ::
 
55
 
 
56
  Total Accesses: 1234
 
57
  Total kBytes: 1043
 
58
  Uptime: 1234
 
59
  BusyServers: 123
 
60
 
 
61
Total Accesses is the number of handled requests, kBytes the overall outgoing 
 
62
traffic, Uptime the uptime in seconds and BusyServers the number of currently
 
63
active connections.
 
64
 
 
65
The naming is kept compatible to Apache even if we have another concept and
 
66
don't start new servers for each connection.
 
67
 
25
68
 
26
69
Options
27
70
=======
28
71
 
29
72
status.status-url
30
73
 
 
74
  relative URL which is used to retrieve the status-page
 
75
 
31
76
  Default: unset
32
77
 
 
78
  Example: status.status-url = "/server-status"
 
79
 
 
80
status.enable-sort
 
81
  
 
82
  add JavaScript which allows client-side sorting for the connection overview
 
83
 
 
84
  Default: enable
 
85
 
33
86
status.config-url
34
87
 
35
 
  Default: unset
 
88
  relative URL for the config page which displays the loaded modules
 
89
 
 
90
  Default: unset
 
91
 
 
92
  Example: status.status-url = "/server-config"
 
93
 
 
94
status.statistics-url
 
95
 
 
96
  relative URL for a plain-text page containing the internal statistics
 
97
 
 
98
  Default: unset
 
99
 
 
100
  Example: status.status-url = "/server-stats"
 
101