Docs ConfigurationOptions » History » Revision 45
Revision 44 (yusufg, 2007-07-25 02:56) → Revision 45/174 (hr, 2007-11-14 16:40)
[[TracNav(DocsToc)]]
= Configuration File Options =
Here you will find a list of all available configuration options for lighttpd. They are grouped by module, and a link to each module configuration will provide with more detail information about each option, as well as examples, and other guidelines.
[[PageOutline(2,Configuration Options by Module,inline)]]
== Lighttpd Core Options ==
'''server.bind''': IP address, hostname or absolute path to the unix-domain socket. [wiki:server.bindDetails Details][[BR]]
'''server.dir-listing''': enable/disable dir listing. [wiki:Docs:ModDirlisting Details][[BR]]
'''server.document-root''': document-root of the webserver. [wiki:server.document-rootDetails Details][[BR]]
'''server.event-handler''': set the event handler. [wiki:server.event-handlerDetails Details] [[BR]]
'''server.errorlog''': pathname of the error-log. [wiki:server.errorlogDetails Details][[BR]]
'''server.errorlog-use-syslog''': send errorlog to syslog. [wiki:server.errorlog-use-syslogDetails Details][[BR]]
'''server.error-handler-404''': uri to call if the requested file results in a 404. [wiki:server.error-handler-404Details Details] [[BR]]
'''server.errorfile-prefix''': path prefix for special status codes pages. [wiki:server.errorfile-prefixDetails Details] [[BR]]
'''server.chroot''': root-directory of the server. [wiki:server.chrootDetails Details][[BR]]
'''server.core-files''': enable core files. [[BR]]
'''server.username''': username used to run the server. [wiki:server.usernameDetails Details] [[BR]]
'''server.groupname''': groupname used to run the server. [wiki:server.groupnameDetails Details] [[BR]]
'''server.follow-symlink''': allow to follow-symlinks. [wiki:server.follow-symlinksDetails Details] [[BR]]
'''server.force-lowercase-filenames''': enable force all filenames to lowercase.[[BR]]
'''server.kbytes-per-second''': limit the throughput for all connections to the given limit in kbyte/s. [wiki:Docs:TrafficShaping Details] [[BR]]
'''connection.kbytes-per-second''': limit the throughput for each single connection to the given limit in kbyte/s. [wiki:Docs:TrafficShaping Details] [[BR]]
'''server.max-connections''': maximum connections. [wiki:server.max-connectionsDetails Details] [[BR]]
'''server.max-read-idle''': maximum number of seconds until a waiting, non keep-alive read times out and closes the connection. [wiki:server.max-read-idleDetails Details][[BR]]
'''server.modules''': modules to load. [wiki:server.modulesDetails Details] [[BR]]
'''server.pid-file''': set the name and location of the .pid-file. [wiki:server.pid-fileDetails Details] [[BR]]
'''server.port''': tcp-port to bind the server to.[wiki:server.portDetails Details][[BR]]
'''server.max-request-size''': maximum size in kbytes of the request. [wiki:server.max-request-sizeDetails Details] [[BR]]
'''server.max-worker''': number of worker processes to spawn. [wiki:server.max-workerDetails Details] [[BR]]
'''server.name''': name of the server/virtual server. [wiki:server.nameDetails Details] [[BR]]
'''server.network-backend''': basic network interface for all platforms at the syscalls read() and write() [wiki:server.network-backendDetails Details][[BR]]
'''server.max-fds''': maximum number of file descriptors. [wiki:server.max-fdsDetails Details] [[BR]]
'''server.max-keep-alive-requests''': maximum number of request within a keep-alive session. [wiki:server.max-keep-alive-requestsDetails Details] [[BR]]
'''server.max-keep-alive-idle''': maximum number of seconds until a idling keep-alive connection is droped. [wiki:server.max-keep-alive-idleDetails Details] [[BR]]
'''server.max-write-idle''': maximum number of seconds until a waiting write call times out. [wiki:server.max-write-idleDetails Details] [[BR]]
'''server.protocol-http11''': defines if HTTP/1.1 is allowed or not. [wiki:server.protocol-http11Details Details] [[BR]]
'''server.range-requests''': defines if range requests are allowed or not. [wiki:server.range-requestsDetails Details] [[BR]]
'''server.stat-cache-engine''': select stat() call caching. [wiki:server.stat-cache-engineDetails Details][[BR]]
'''server.tag''': set the string returned by the server. [wiki:server.use-tagDetails Details][[BR]]
'''server.upload-dirs''': path to upload directory. [wiki:server.upload-dirsDetails Details] [[BR]]
'''server.use-ipv6''': bind to the IPv6 socket. [[BR]]
'''index-file.names''': list of files to search for if a directory is requested. [wiki:index-file-names.Details Details] [[BR]]
'''[wiki:mimetype.assignDetails mimetype.assign]''': list of known mimetype mappings. [wiki:mimetype.assignDetails Details] [[BR]]
'''[wiki:mimetype.use-xattrDetails mimetype.use-xattr]''': try to use XFS-style extended attribute interface for retreiving the Content-Type. [wiki:mimetype.use-xattrDetails Details] [[BR]]
'''static-file.exclude-extensions''': forbid access to the source of some types of files by extension. [[BR]]
'''etag.use-inode''': Determines if inode-value is used in ETag generation [wiki:etag.use-inodeDetails Details] [[BR]]
'''etag.use-mtime''': Determines if mtime-value is used in ETag generation [wiki:etag.use-mtimeDetails Details] [[BR]]
'''etag.use-size''': Determines if size-value is used in ETag generation [wiki:etag.use-sizeDetails Details] [[BR]]
'''static-file.etags''': Determines if ETags are generated or not
=== SSL Options ===
'''ssl.engine''': enable/disable ssl engine.[[BR]]
'''ssl.pemfile''': path to the PEM file for SSL support. [wiki:Docs:SSL Details] [[BR]]
'''ssl.ca-file''': path to the CA file for support of chained certificates. [wiki:Docs:SSL Details] [[BR]]
=== Core Debug Info ===
'''debug.log-request-header''': log all request headers. [[BR]]
'''debug.log-file-not-found''': log if a file wasn't found.[[BR]]
'''debug.log-condition-handling''': log conditionals handling for debugging. [[BR]]
'''debug.log-request-header-on-error''': log request header, but only when there is an error. [[BR]]
'''debug.log-request-handling''': log request handling inside lighttpd.[[BR]]
'''debug.log-state-handling''': log state handling inside lighttpd.[[BR]]
'''debug.log-response-header''': log the header we send out to the client.[[BR]]
'''debug.dump-unknown-headers''': log listing of internally unhandled HTTP-headers. [[BR]]
[wiki:DebugVariables Debug Variable Information]
== Options for mod_access - access restrictions module ==
'''url.access-deny''': Denies access to all files with any of given trailing path names.[[BR]]
[wiki:Docs:ModAccess mod_access documentation][[BR]]
== Options for mod_accesslog - access log files module ==
'''accesslog.use-syslog''': send the accesslog to syslog.[[BR]]
'''accesslog.format''': the format of the logfile. [[BR]]
'''accesslog.filename''': name of the file where the accesslog should be written to if syslog is not used.[[BR]]
[wiki:Docs:ModAccessLog mod_accesslog documentation][[BR]]
== Options for mod_alias - directory aliases module ==
'''alias.url''': rewrites the document-root for a URL-subset.[[BR]]
[wiki:Docs:ModAlias mod_alias documentation][[BR]]
== Options for mod_auth - authentication module ==
'''auth.debug''': enable/disable authentication module debug information.[[BR]]
'''auth.backend''': type of authentication backend.[[BR]]
'''auth.require''': [[BR]]
'''auth.backend.ldap.hostname''': hostname of ldap server. [[BR]]
'''auth.backend.ldap.starttls''': [[BR]]
'''auth.backend.ldap.filter''': [[BR]]
'''auth.backend.ldap.bind-pw''': [[BR]]
'''auth.backend.ldap.ca-file''': [[BR]]
'''auth.backend.ldap.base-dn''': [[BR]]
'''auth.backend.ldap.bind-dn''': [[BR]]
'''auth.backend.plain.userfile''': path to plain userfile. [[BR]]
'''auth.backend.plain.groupfile''': path to plain groupfile. [[BR]]
'''auth.backend.htdigest.userfile''': path to htdigest userfile. [[BR]]
'''auth.backend.htpasswd.userfile''': path to htpassword userfile. [[BR]]
[wiki:Docs:ModAuth mod_auth documentation][[BR]]
== Options for mod_cache - web accelerating module ==
'''cache.bases''': directory arrays which want to save cache files [[BR]]
'''cache.enable''': [[BR]]
'''cache.domains''': domain pcre regex arrays which mod_cache will cache [[BR]]
'''cache.support-queries''': [[BR]]
'''cache.debug''': writes mod_cache debuging messages to error.log or not [[BR]]
'''cache.purge-host''': pcre regex hosts ip which are allowed to PURGE cache file [[BR]]
'''cache.refresh-pattern''': [[BR]]
[wiki:Docs:ModCache mod_cache documentation][[BR]]
== Options for mod_cgi - cgi module ==
'''cgi.assign''': assign cgi handler to an extension.[[BR]]
[wiki:Docs:ModCGI mod_cgi documentation][[BR]]
== Options for mod_cml - Cache Meta Language module ==
'''cml.memcache-namespace''': (not used yet) [[BR]]
'''cml.power-magnet''': a cml file that is executed for each request.[[BR]]
'''cml.memcache-hosts''': hosts for the memcache.* functions.[[BR]]
'''cml.extension''': the file extension that is bound to the cml-module.[[BR]]
[wiki:Docs:ModCML mod_cml documentation][[BR]]
== Options for mod_compress - compress output module ==
'''compress.max-filesize''': maximum size of the original file to be compressed kBytes.[[BR]]
'''compress.cache-dir''': name of the directory where compressed content will be cached.[[BR]]
'''compress.filetype''': mimetypes which might get compressed.[[BR]]
[wiki:Docs:ModCompress mod_compress documentation][[BR]]
== Options for mod_deflate - dynamic compression module (Patch) ==
'''deflate.enabled''': enable/disable deflate support.[[BR]]
'''deflate.compression-level''': level of compression.[[BR]]
'''deflate.mem-level''':[[BR]]
'''deflate.window-size''':[[BR]]
'''deflate.bzip2''': enable/disable bzip support.[[BR]]
'''deflate.min-compress-size''': minimum size document before compressing.[[BR]]
'''deflate.sync-flush''': enable sync flush.[[BR]]
'''deflate.output-buffer-size''': size of buffer for compression.[[BR]]
'''deflate.work-block-size''': minimum block size for compression.[[BR]]
'''deflate.mimetypes''': mimetype listing to be compressed. [[BR]]
'''deflate.debug''': enable debug.[[BR]]
[wiki:Mod_Deflate mod_deflate documentation][[BR]]
== Options for mod_dirlisting - directory listing module ==
'''server.dir-listing''': enable/disable directory listing.[[BR]]
'''dir-listing.activate''': enables virtual directory listings if a directory is requested no index-file was found.[[BR]]
'''dir-listing.external-css''': path to an external css stylesheet for the directory listing.[[BR]]
'''dir-listing.encoding''': set a encoding for the generated directory listing.[[BR]]
'''dir-listing.hide-dotfiles''': if enabled, does not list hidden files in directory listings generated by the dir-listing option.[[BR]]
'''dir-listing.show-header''': include HEADER.txt files above the directory listing..[[BR]]
'''dir-listing.hide-header-file''': enables hide header file from directory listing.[[BR]]
'''dir-listing.show-readme''': include README.txt files above the directory listing.[[BR]]
'''dir-listing.hide-readme-file''': enables displaying readme file in directory listing.[[BR]]
'''dir-listing.exclude''': files that match any of the specified regular expressions will be excluded from listings.[[BR]]
'''dir-listing.set-footer''': displays a string in the footer of a listing page.[[BR]]
[wiki:Docs:ModDirlisting mod_dirlisting documentation][[BR]]
== Options for mod_evasive - evasive module (version 1.5.0) ==
'''evasive.max-conns-per-ip''': upper limit of number of connections per ip allowed.[[BR]]
== Options for mod_evhost - enhanced virtual host module ==
'''evhost.path-pattern''': pattern with wildcards to be replace to build a documentroot.[[BR]]
[wiki:Docs:ModEVhost mod_evhost documentation][[BR]]
== Options for mod_expire - cached expiration module ==
'''expire.url''': assignes a expiration to all files below the specified path. [[BR]]
[wiki:Docs:ModExpire mod_expire documentation][[BR]]
== Options for mod_extforward - extract the client's "real" IP from X-Forwarded-For header ==
'''extforward.forwarder''': set trust level of proxy ip's [[BR]]
[wiki:Docs/ModExtForward mod_extforward documentation][[BR]]
== Options for mod_fastcgi - fastcgi module ==
'''fastcgi.map-extensions''': map multiple extensions to the same fastcgi server.[[BR]]
'''fastcgi.debug''': a value between 0 and 65535 to set the debug-level in the FastCGI module.[[BR]]
'''fastcgi.server''': tell the module where to send FastCGI requests to. [[BR]]
'''host''': is hostname/ip of the FastCGI process.[[BR]]
'''port''': is tcp-port on the "host" used by the FastCGI process. [[BR]]
'''socket''': path to the unix-domain socket.[[BR]]
'''bin-path''': path to the local FastCGI binary which should be started if no local FastCGI is running.[[BR]]
'''bin-environment''': set environment of FastCGI binary.[[BR]]
'''bin-copy-environment''': copy environment from server for FastCGI binary.[[BR]]
'''mode''': is the FastCGI protocol mode. Default is "responder", also "authorizer" mode is implemented.[[BR]]
'''docroot''': docroot on the remote host.[[BR]]
'''allow-x-send-file''': controls if X-LIGHTTPD-send-file and X-Sendfile headers are allowed.[[BR]]
'''broken-scriptfilename''': breaks SCRIPT_FILENAME in a way that PHP can extract PATH_INFO from it.[[BR]]
'''idle-timeout''': number of seconds before a unused process gets terminated.[[BR]]
'''max-procs''': upper limit of processes to start.[[BR]]
''' min-procs''': sets the minium processes to start.[[BR]]
'''min-procs-not-working''': [[BR]]
'''max-load-per-proc''': maximum number of waiting processes on average per process before a new process is spawned.[[BR]]
'''check-local''': enable/disable check for requested file in document root.[[BR]]
'''disable-time''': time to wait before a disabled backend is checked again.[[BR]]
'''strip-request-uri''': strip part of request-uri.[[BR]]
[wiki:Docs:ModFastCGI mod_fastcgi documentation][[BR]]
== Options for mod_flv_streaming - flv streaming module ==
'''flv-streaming.extensions''': extensions of flv files[[BR]]
[http://blog.lighttpd.net/articles/2006/03/09/flv-streaming-with-lighttpd Blog Entry][[BR]]
[http://jan.kneschke.de/projects/flv-streaming/ Additional Information ][[BR]]
[http://www.jeroenwijering.com/embed/streaming.html Flash Video Player 3.5 (Creative Commons)][[BR]]
== Options for mod_mem_cache - local file accelerating ==
'''mem-cache.filetypes''': content-type arrays which want to put into memory [[BR]]
'''mem-cache.enable''': [[BR]]
'''mem-cache.max-memory''': maxium memory in Mbytes mod-mem-cache can use [[BR]]
'''mem-cache.max-file-size''': maxium file size in Kbytes of single file to cache in memory [[BR]]
'''mem-cache.lru-remove-count''': [[BR]]
'''mem-cache.expire-time''': memory cache's expire time in minutes [[BR]]
'''mem-cache.slru-thresold''' : slru threshold (against hit counter) [[BR]]
[wiki:Docs:ModMemCache mod_mem_cache documentation][[BR]]
== Options for mod_mysql_vhost - Mysql virtual hosting module ==
'''mysql-vhost.hostname''': hostname of mysql server.[[BR]]
'''mysql-vhost.db''': database name.[[BR]]
'''mysql-vhost.user''': username to access database.[[BR]]
'''mysql-vhost.pass''': password to access database. [[BR]]
'''mysql-vhost.sql''': SQL statement to execute to obtain docroot.[[BR]]
'''mysql-vhost.port''': port where to connect to database.[[BR]]
'''mysql-vhost.sock''': socket where to connect to database.[[BR]]
[wiki:Docs:ModMySQLVhost mod_mysql_vhost documentation][[BR]]
== Options for mod_proxy - proxy module ==
'''proxy.server''': where to send Proxy requests.[[BR]]
'''host''': ip of host to send requests. [[BR]]
'''port''': listening port of host. [[BR]]
'''proxy.balance''': select type of balancing algorithm (round-robin, hash, fair).[[BR]]
'''proxy.debug''': enable/disable proxy debug information.[[BR]]
[wiki:Docs:ModProxy mod_proxy documentation][[BR]]
== Options for mod_redirect - redirect module ==
'''url.redirect''': redirects a set of URLs externally.[[BR]]
[wiki:Docs:ModRedirect mod_redirect documentation][[BR]]
== Options for mod_rewrite - rewriting module ==
'''url.rewrite-once''': rewrites a set of URLs internally and skip the rest.[[BR]]
'''url.rewrite-repeat''': rewrites a set of URLs internally in the webserver, continue applying rewrite rules.[[BR]]
'''url.rewrite''': same as url.rewrite-once.[[BR]]
'''url.rewrite-final''': same as url.rewrite-once.[[BR]]
[wiki:Docs:ModRewrite mod_rewrite documentation][[BR]]
== Options for mod_rrdtool - rrdtool module ==
'''rrdtool.db-name''': filename of the rrd-database. [[BR]]
'''rrdtool.binary''': path to the rrdtool binary.[[BR]]
[wiki:Docs:ModRRDTool mod_rrdtool documentation][[BR]]
== Options for mod_scgi - SCGI Module ==
'''scgi.map-extensions''': map multiple extensions to the same scgi server.[[BR]]
'''scgi.debug''': a value between 0 and 65535 to set the debug-level in the SCGI module.[[BR]]
'''scgi.server''': tell the module where to send SCGI requests to. [[BR]]
'''host''': is hostname/ip of the SCGI process.[[BR]]
'''port''': is tcp-port on the "host" used by the SCGI process. [[BR]]
'''socket''': path to the unix-domain socket.[[BR]]
'''bin-path''': path to the local SCGI binary which should be started if no local SCGI is running.[[BR]]
'''bin-environment''': set environment of SCGI binary.[[BR]]
'''bin-copy-environment''': copy environment from server for SCGI binary.[[BR]]
'''docroot''': docroot on the remote host.[[BR]]
'''allow-x-send-file''': controls if X-LIGHTTPD-send-file and X-Sendfile headers are allowed.[[BR]]
'''broken-scriptfilename''': breaks SCRIPT_FILENAME in a way that PHP can extract PATH_INFO from it.[[BR]]
'''idle-timeout''': number of seconds before a unused process gets terminated.[[BR]]
'''max-procs''': upper limit of processes to start.[[BR]]
''' min-procs''': sets the minium processes to start.[[BR]]
'''min-procs-not-working''':
'''max-load-per-proc''': maximum number of waiting processes on average per process before a new process is spawned.[[BR]]
'''check-local''': enable/disable check for requested file in document root.[[BR]]
'''disable-time''': time to wait before a disabled backend is checked again.[[BR]]
'''strip-request-uri''': strip part of request-uri.[[BR]]
[wiki:Docs:ModSCGI mod_scgi documentation][[BR]]
== Options for mod_secure_download - secure and fast download module ==
'''secdownload.document-root''': path to the download area.[[BR]]
'''secdownload.timeout''': how long in seconds is the secret valid.[[BR]]
'''secdownload.uri-prefix''': prefix to url for download.[[BR]]
'''secdownload.secret ''': Secret string that will be used for the checksum calculation.[[BR]]
[wiki:Docs:ModSecDownload mod_secure_download documentation][[BR]]
== Options for mod_setenv - set HTTP Environment module ==
'''setenv.add-response-header''': adds a value to the process environment that is passed to the external applications.[[BR]]
'''setenv.add-request-header''': adds a header to the HTTP response sent to the client.[[BR]]
'''setenv.add-environment''': adds a value to the process environment that is passed to the external applications.[[BR]]
[wiki:Docs:ModSetEnv mod_setenv documentation][[BR]]
== Options for mod_simple_vhost - simple virtual host module ==
'''simple-vhost.document-root''': path below the vhost directory. [[BR]]
'''simple-vhost.server-root''': root of the virtual host.[[BR]]
'''simple-vhost.default-host''': use this hostname if the requested hostname does not have its own directory.[[BR]]
'''simple-vhost.debug''': debug simple vhosts module.[[BR]]
[wiki:Docs:ModSimpleVhost mod_simple_vhost documentation][[BR]]
== Options for mod_ssi - server side includes module ==
'''ssi.extension''': extension of files processed by mod_ssi.[[BR]]
[wiki:Docs:ModSSI mod_ssi documentation][[BR]]
== Options for mod_status - server status module ==
'''status.config-url''': relative URL for the config page which displays the loaded modules.[[BR]]
'''status.statistics-url''': relative URL for a plain-text page containing the internal statistics.[[BR]]
'''status.enable-sort''': add !JavaScript which allows client-side sorting for the connection overview.[[BR]]
'''status.status-url''': relative URL which is used to retrieve the status-page.[[BR]]
[wiki:Docs:ModStatus mod_status documentation][[BR]]
== Options for mod_trigger_b4_dl - trigger before download module ==
'''trigger-before-download.trigger-url''': url for trigger pages.[[BR]]
'''trigger-before-download.trigger-timeout''': time for download link to live.[[BR]]
'''trigger-before-download.download-url''': url for downloads. [[BR]]
'''trigger-before-download.deny-url''': url to show when visitor denied a download.[[BR]]
'''trigger-before-download.gdbm-filename''': path to gdm file.[[BR]]
'''trigger-before-download.memcache-hosts''': hosts for the memcache.* functions.[[BR]]
'''trigger-before-download.memcache-namespace''': (not used yet)[[BR]]
'''trigger-before-download.debug''':[[BR]]
[wiki:Docs:ModTriggerBeforeDownload mod_trigger_b4_dl documentation][[BR]]
== Options for mod_userdir - user directories ==
'''userdir.basepath''': if set, don't check /etc/passwd for homedir.[[BR]]
'''userdir.exclude-user''': list of usernames which may not use this feature.[[BR]]
'''userdir.path''': usually it should be set to "public_html" to take ~/public_html/ as the document root.[[BR]]
'''userdir.include-user''': if set, only users from this list may use the feature. [[BR]]
[wiki:Docs:ModUserDir mod_userdir documentation][[BR]]
== Options for mod_uploadprogress - upload progress module (version 1.5.0) ==
'''upload-progress.progress-url''': [[BR]]
== Options for mod_usertrack - user track module (cookies) ==
'''usertrack.cookie-name''':[[BR]]
~~'''usertrack.cookiename'''~~: (deprecated)[[BR]]
'''usertrack.cookie-domain''':[[BR]]
'''usertrack.cookie-max-age''':[[BR]]
[wiki:Docs:ModUserTrack mod_usertrack documentation][[BR]]
== Options for mod_webdav - WebDAV module ==
'''webdav.activate''': enable/disable WebDAV.[[BR]]
'''webdav.is-readonly''': enable/disable read only.[[BR]]
'''webdav.sqlite-db-name''': pathname to SQLite database.[[BR]]
'''webdav.log-xml''': Log the XML Request bodies for debugging. [[BR]]
[wiki:Docs:ModWebDAV mod_webdav documentation][[BR]]