[doc] refresh doc/config/*/*

2 years ago · a7136aac8e
11 changed files with 1122 additions and 369 deletions
--- a/doc/config/conf.d/access_log.conf
+++ b/doc/config/conf.d/access_log.conf
@ -22,6 +22,10 @@ accesslog.filename          = log_root + "/access.log"
 ## accesslog.use-syslog setting and uncomment the next line.
 ##
 #accesslog.use-syslog       = "enable"
+##
+## syslog level defaults to 6 ("Informational")
+## https://en.wikipedia.org/wiki/Syslog#Severity_level
+#accesslog.syslog-level     = 6

 #
 #######################################################################
--- a/doc/config/conf.d/auth.conf
+++ b/doc/config/conf.d/auth.conf
@ -3,13 +3,12 @@
 ##  Authentication Module
 ## -----------------------
 ##
-## See https://redmine.lighttpd.net/projects/lighttpd/wiki/docs_modauth
-## for more info.
+## See https://redmine.lighttpd.net/projects/lighttpd/wiki/Docs_ModAuth
+## for more info and many more options.
 ##

 #auth.backend                 = "plain"
 #auth.backend.plain.userfile  = "/etc/lighttpd/lighttpd.user"
-#auth.backend.plain.groupfile = "/etc/lighttpd/lighttpd.group"

 #auth.backend.ldap.hostname = "localhost"
 #auth.backend.ldap.base-dn  = "dc=my-domain,dc=com"
@ -23,5 +22,14 @@
 #                               ),
 #                             )

+##
+## cache passwords/digests in memory to reduce load on the backend
+## max-age is in seconds
+##   cache is checked for expiration every 8 seconds, so actual
+##   caching may be up to 8 seconds longer than configured max-age.
+## default: inactive (no caching)
+##
+#auth.cache = ("max-age" => "600")
+
 ##
 #######################################################################
--- a/doc/config/conf.d/cgi.conf
+++ b/doc/config/conf.d/cgi.conf
@ -29,5 +29,32 @@ cgi.assign                 = ( ".pl"  => "/usr/bin/perl",
 #   cgi.assign = ( "" => "" )
 #}

+##
+## require execute permission (+x) on files for CGI scripts
+## default: disable
+##
+#cgi.execute-x-only = "enable"
+
+##
+## process X-Sendfile (if present) from CGI response
+## https://redmine.lighttpd.net/projects/lighttpd/wiki/Docs_ModFastCGI#X-Sendfile
+## default: disable
+##
+#cgi.x-sendfile = "enable"
+#cgi.x-sendfile-docroot = ( "/srv/www/html", "/srv/www/static" )
+
+##
+## Local Redirect Response optimization
+## https://www.ietf.org/rfc/rfc3875 6.2.2 Local Redirect Response optimization
+## default: disable
+##
+#cgi.local-redir = "enable"
+
+##
+## permit Upgrade, e.g. Upgrade: websocket
+## default: disable
+##
+#cgi.upgrade = "enable"
+
 ##
 #######################################################################
--- a/doc/config/conf.d/deflate.conf
+++ b/doc/config/conf.d/deflate.conf
@ -1,31 +1,62 @@
 #######################################################################
 ##
-##  Output Compression 
+##  Output Compression
 ## --------------------
 ##
-## See https://redmine.lighttpd.net/projects/lighttpd/wiki/docs_moddeflate
+## See https://redmine.lighttpd.net/projects/lighttpd/wiki/Docs_ModDeflate
 ##
 server.modules += ( "mod_deflate" )

 ##
-## where should the compressed files be cached?
-## see the base config for the declaration of the variable.
+## mimetypes to compress
 ##
-## This directory should be changed per vhost otherwise you can
-## run into trouble with overlapping filenames
+#deflate.mimetypes = ("text/")       # prefix matches all text/* Content-Type responses
+#deflate.mimetypes = ("text/html", "text/plain", "text/css", "text/javascript", "text/xml")
+deflate.mimetypes         = ("text/plain", "text/html")
+
+##
+## permitted encodings
+##
+deflate.allowed-encodings = ("brotli", "gzip", "deflate")
+
+##
+## optional
 ##
-deflate.cache-dir         = cache_dir + "/compress"

 ##
-## FileTypes to compress.
-## 
-deflate.filetype          = ("text/plain", "text/html")
+## file cache location
+## lighttpd can store compressed files in cache by path and etag, and can serve
+## compressed files from cache instead of re-compressing files each request
+##
+#deflate.cache-dir = "/path/to/compress/cache"
+#deflate.cache-dir = cache_dir + "/compress"

 ##
-## Maximum response size that will be compressed.
-## Default is 0, which uses internal default of 128 MB as limit.
-## 
+## maximum response size (in KB) that will be compressed
+## default: 131072  # measured in KB (131072 indicates 128 MB)
+## Specifying 0 uses internal default of 128 MB as limit
+##
+#deflate.max-compress-size = 131072
 #deflate.max-compress-size = 0

+##
+## minimum response size that will be compressed
+## default: 256
+##
+#deflate.min-compress-size = 256     # measured in bytes
+
+##
+## system load average limit, above which mod_deflate is temporarily disabled
+##
+#deflate.max-loadavg = "3.50"
+
+##
+## tunables for compression algorithms
+## (often best left at defaults)
+##
+#deflate.compression-level = 9
+#deflate.output-buffer-size = 8192
+#deflate.work-block-size = 2048
+
 ##
 #######################################################################
--- a/doc/config/conf.d/dirlisting.conf
+++ b/doc/config/conf.d/dirlisting.conf
@ -8,14 +8,14 @@

 ##
 ## Enabled Directory listing
-##
-dir-listing.activate      = "disable"
+## default: disable
+#dir-listing.activate      = "enable"

 ##
 ## Hide dot files from the listing?
 ## By default they are hidden (not listed).
-##
-dir-listing.hide-dotfiles = "enable"
+## default: enable
+#dir-listing.hide-dotfiles = "enable"

 ##
 ## list of regular expressions. Files that match any of the specified
@ -33,23 +33,63 @@ dir-listing.exclude       = ( "~$" )
 dir-listing.encoding = "UTF-8"

 ##
-## Specify the url to an optional CSS file. 
+## local URL to optional CSS stylesheet for the directory listing
 ##
 #dir-listing.external-css  = "/dirindex.css"

+##
+## local URL to optional js script to include,
+## e.g. for client side directory list sorting
+##
+#dir-listing.external-js = "/dirindex.js"
+
 ##
 ## Include HEADER.txt files above the directory listing. 
+## default: disable
+##
+#dir-listing.show-header = "enable"
+##
 ## You can disable showing the HEADER.txt in the listing. 
+## default: disable (shows file in listing)
+##
+#dir-listing.hide-header-file = "enable"
 ##
-dir-listing.hide-header-file = "disable"
-dir-listing.show-header = "disable"
+## HTML-encode HEADER.txt
+## (disable to include files as-is, e.g. if files contain valid HTML)
+## default: enable
+##
+#dir-listing.encode-header = "disable"

 ##
 ## Include README.txt files above the directory listing. 
+## default: disable
+##
+#dir-listing.show-readme = "enable"
+##
 ## You can disable showing the README.txt in the listing. 
+## default: disable (shows file in listing)
+##
+#dir-listing.hide-readme-file = "enable"
+##
+## HTML-encode README.txt
+## (disable to include files as-is, e.g. if files contain valid HTML)
+## default: enable
+##
+#dir-listing.encode-readme = "disable"
+
+##
+## displays a string in the footer of a listing page
+## default: value of server.tag directive
+##   "<PACKAGE_NAME>/<PACKAGE_VERSION>" e.g. "lighttpd/1.4.56"
+##
+#dir-listing.set-footer = " "
+
+##
+## Use lighttpd-provided page tags <body> and <html>
+## (disable if HEADER.txt and README.txt provide those tags)
+## default: enable
 ##
-dir-listing.hide-readme-file = "disable"
-dir-listing.show-readme = "disable"
+#dir-listing.auto-layout = "disable"

 ##
 #######################################################################
--- a/doc/config/conf.d/evhost.conf
+++ b/doc/config/conf.d/evhost.conf
@ -15,6 +15,8 @@ server.modules += ( "mod_evhost" )
 ## %2 => domain name without tld
 ## %3 => subdomain 1 name
 ## %4 => subdomain 2 name
+## %_ => full domain name
+## %{M.N} => single character at 1-indexed position N in the domain segment %M (e.g %0 - %9)
 ##
 evhost.path-pattern        = vhosts_dir + "/%3/htdocs/"

--- a/doc/config/conf.d/mime.conf
+++ b/doc/config/conf.d/mime.conf
--- a/doc/config/conf.d/scgi.conf
+++ b/doc/config/conf.d/scgi.conf
@ -1,9 +1,9 @@
 #######################################################################
 ##
-##  FastCGI Module 
+##  SCGI Module 
 ## --------------- 
 ##
-## See https://redmine.lighttpd.net/projects/lighttpd/wiki/Docs_ModFastCGI
+## See https://redmine.lighttpd.net/projects/lighttpd/wiki/Docs_ModSCGI
 ##
 server.modules += ( "mod_scgi" )

--- a/doc/config/conf.d/webdav.conf
+++ b/doc/config/conf.d/webdav.conf
@ -19,15 +19,22 @@ $HTTP["url"] =~ "^/dav($|/)" {
  ##
  #webdav.is-readonly = "enable"

+  ##
+  ## SQLite database for WebDAV properties and WebDAV locks
+  ##
+  webdav.sqlite-db-name = home_dir + "/webdav.db"
+
  ##
  ## Log the XML Request bodies for debugging
  ##
  #webdav.log-xml = "disable"

  ##
-  ##  
+  ## mod_webdav further tunables
+  ## See online doc:
+  ##   https://redmine.lighttpd.net/projects/lighttpd/wiki/Docs_ModWebDAV
  ##
-  webdav.sqlite-db-name = home_dir + "/webdav.db"
+  #webdav.opts = ( ... )
 }
 ##
 #######################################################################
--- a/doc/config/lighttpd.conf
+++ b/doc/config/lighttpd.conf
@ -15,7 +15,7 @@
 ##
 var.log_root    = "/var/log/lighttpd"
 var.server_root = "/srv/www"
-var.state_dir   = "/var/run"
+var.state_dir   = "/run"
 var.home_dir    = "/var/lib/lighttpd"
 var.conf_dir    = "/etc/lighttpd"

@ -401,8 +401,8 @@ include "conf.d/dirlisting.conf"

 ##
 ## Should lighttpd follow symlinks?
-## 
-server.follow-symlink = "enable"
+## default: "enable"
+#server.follow-symlink = "enable"

 ##
 ## force all filenames to be lowercase?
@ -411,8 +411,8 @@ server.follow-symlink = "enable"

 ##
 ## defaults to /var/tmp as we assume it is a local harddisk
-##
-server.upload-dirs = ( "/var/tmp" )
+## default: "/var/tmp"
+#server.upload-dirs = ( "/var/tmp" )

 ##
 #######################################################################
@ -438,7 +438,7 @@ server.upload-dirs = ( "/var/tmp" )
 ##     #ssl.cipher-list             = "HIGH"   # default
 ##
 ##     # (recommended to accept only TLSv1.2 and TLSv1.3)
-##     #ssl.openssl.ssl-conf-cmd = ("Protocol" => "-ALL, TLSv1.2, TLSv1.3")
+##     #ssl.openssl.ssl-conf-cmd = ("MinProtocol" => "TLSv1.2")
 ##
 ##     server.name                 = "www.example.com"
 ##
--- a/doc/config/modules.conf
+++ b/doc/config/modules.conf
@ -12,6 +12,9 @@
 ## You may disable automatic loading of default modules by setting
 ##   server.compat-module-load = "disable"
 ##
+## lighttpd provides many modules, and not all are listed below.  Please see:
+## https://redmine.lighttpd.net/projects/lighttpd/wiki/Docs_ConfigurationOptions
+##
 ## Modules, which are pulled in via conf.d/*.conf
 ##
 ## - mod_accesslog     -> conf.d/access_log.conf
@ -46,14 +49,14 @@
 ##

 server.modules = (
+#  "mod_rewrite",
  "mod_access",
-#  "mod_alias",
+#  "mod_evasive",
 #  "mod_auth",
 #  "mod_authn_file",
-#  "mod_evasive",
-#  "mod_setenv",
 #  "mod_redirect",
-#  "mod_rewrite",
+#  "mod_setenv",
+#  "mod_alias",
 )

 ##
@ -64,6 +67,21 @@ server.modules = (
 ##  Config for various Modules
 ##

+##
+## mod_expire
+##
+#include "conf.d/expire.conf"
+
+##
+## mod_deflate
+##
+#include "conf.d/deflate.conf"
+
+##
+## mod_magnet
+##
+#include "conf.d/magnet.conf"
+
 ##
 ## mod_geoip
 ##
@ -84,21 +102,11 @@ server.modules = (
 ##
 #include "conf.d/webdav.conf"

-##
-## mod_deflate
-##
-#include "conf.d/deflate.conf"
-
 ##
 ## mod_userdir
 ##
 #include "conf.d/userdir.conf"

-##
-## mod_magnet
-##
-#include "conf.d/magnet.conf"
-
 ##
 ## mod_cml
 ##
@ -109,16 +117,6 @@ server.modules = (
 ##
 #include "conf.d/rrdtool.conf"

-##
-## mod_proxy
-##
-#include "conf.d/proxy.conf"
-
-##
-## mod_expire
-##
-#include "conf.d/expire.conf"
-
 ##
 ## mod_secdownload
 ##
@ -129,8 +127,13 @@ server.modules = (

 #######################################################################
 ##
-## CGI modules
+## CGI/proxy modules
+##
+
+##
+## mod_proxy
 ##
+#include "conf.d/proxy.conf"

 ##
 ## SCGI (mod_scgi)