granicus.if.org Git - apache/blob - docs/server-status/README.md

   1 server-status
   2 =============
   3
   4 `mod_lua` version of the Apache httpd's mod_status using dynamic charts
   5
   6 ## What does it do? ##
   7 This script is an extended version of the known mod_status statistics page for httpd.
   8 It uses the simple Quokka Chart API to visualize many of the elements that are sometimes hard
   9 to properly diagnose using plain text information.
  10
  11 Take a look at https://www.apache.org/server-status to see how it works.
  12
  13 ## Requirements ##
  14 * Apache httpd 2.4.6 or higher
  15 * mod_lua (with either Lua 5.1, 5.2 or LuaJIT)
  16 * mod_status loaded (for enabling traffic statistics)
  17
  18 ## Installing ##
  19 First, install mod_lua (you can enable this during configure time with --enable-lua)
  20
  21 ### Installing as a handler:
  22 To install it as a handler, add the following to your httpd.conf in the appropriate VirtualHost:
  23
  24     LuaMapHandler ^/server-status$ /path/to/server-status.lua
  25
  26 ### Installing as a web app:
  27 To install as a plain web-app, enable .lua scripts to be handled by mod_lua, by adding the following
  28 to your appropriate VirtualHost configuration:
  29
  30     AddHandler lua-script .lua
  31
  32 Then just put the `.lua` script somewhere in your document root and visit the page.
  33
  34 ## Configuring
  35 There are a few options inside the Lua script that can be set to `true` or `false`:
  36
  37 - `show_warning`: Whether or not to show a notice that this page is there on purpose.
  38 - `redact_ips`: Whether or not to replace the last few bits of every IP with 'x.x'
  39 - `show_modules`: Whether to show the list of loaded modules or not
  40 - `show_threads`: Whether to show thread details or not.