- publishing free software manuals
The Apache HTTP Server Reference Manual
by Apache Software Foundation
Paperback (6"x9"), 862 pages
ISBN 9781906966034
RRP £19.95 ($29.95)

Get a printed copy>>>

31.3  Directive Quick Reference

The directive quick reference shows the usage, default, status, and context of each Apache configuration directive. For more information about each of these, see the Directive Dictionary (p. 178).

The first line of each entry gives the directive name and usage. The default value of the directive is shown in the right hand column, if a default exists. If the default is too large to display, the first characters will be followed by "+".

The contexts where the directive is allowed, and the status of the directive, are shown in square brackets using the following abbreviations:

s server config
v virtual host
d directory
h .htaccess
C Core
M MPM
B Base
E Extension
X Experimental
AcceptFilter protocol accept_filter [s,C]
Configures optimizations for a Protocol’s Listener Sockets. (p. 189)
AcceptMutex Default|method Default [s,M]
Method that Apache uses to serialize multiple children accepting requests on network sockets. (p. 999)
AcceptPathInfo On|Off|Default Default [svdh,C]
Resources accept trailing pathname information. (p. 191)
AccessFileName filename [filename] .htaccess [sv,C]
Name of the distributed configuration file. (p. 192)
Action action-type cgi-script [virtual] [svdh,B]
Activates a CGI script for a particular handler or content-type. (p. 272)
AddAlt string file [file] [svdh,B]
Alternate text to display for a file, instead of an icon selected by filename. (p. 402)
AddAltByEncoding string MIME-encoding [MIME-encoding] [svdh,B]
Alternate text to display for a file instead of an icon selected by MIME-encoding. (p. 403)
AddAltByType string MIME-type [MIME-type] [svdh,B]
Alternate text to display for a file, instead of an icon selected by MIME content-type. (p. 403)
AddCharset charset extension [extension] [svdh,B]
Maps the given filename extensions to the specified content charset. (p. 690)
AddDefaultCharset On|Off|charset Off [svdh,C]
Default charset parameter to be added when a response content-type is text/plain or text/html. (p. 194)
AddDescription string file [file] [svdh,B]
Description to display for a file. (p. 404)
AddEncoding MIME-enc extension [extension] [svdh,B]
Maps the given filename extensions to the specified encoding type. (p. 691)
AddHandler handler-name extension [extension] [svdh,B]
Maps the filename extensions to the specified handler. (p. 692)
AddIcon icon name [name] [svdh,B]
Icon to display for a file selected by name. (p. 405)
AddIconByEncoding icon MIME-encoding [MIME-encoding] [svdh,B]
Icon to display next to files selected by MIME content-encoding. (p. 406)
AddIconByType icon MIME-type [MIME-type] [svdh,B]
Icon to display next to files selected by MIME content-type. (p. 406)
AddInputFilter filter[;filter…] extension [extension] [svdh,B]
Maps filename extensions to the filters that will process client requests. (p. 693)
AddLanguage MIME-lang extension [extension] [svdh,B]
Maps the given filename extension to the specified content language. (p. 693)
AddModuleInfo module-name string [sv,E]
Adds additional information to the module information displayed by the server-info handler. (p. 625)
AddOutputFilter filter[;filter…] extension [extension] [svdh,B]
Maps filename extensions to the filters that will process responses from the server. (p. 695)
AddOutputFilterByType filter[;filter…] MIME-type [MIME-type] [svdh,C]
Assigns an output filter to a particular MIME-type. (p. 195)
AddType MIME-type extension [extension] [svdh,B]
Maps the given filename extensions onto the specified content type. (p. 696)
Alias URL-path file-path|directory-path [sv,B]
Maps URLs to filesystem locations. (p. 278)
AliasMatch regex file-path|directory-path [sv,B]
Maps URLs to filesystem locations using regular expressions. (p. 279)
Allow from all|host|env=[!]env-variable [host|env=[!]env-variable] [dh,B]
Controls which hosts can access an area of the server. (p. 379)
AllowCONNECT port [port] 443 563 [sv,E]
Ports that are allowed to CONNECT through the proxy. (p. 740)
AllowEncodedSlashes On|Off Off [sv,C]
Determines whether encoded path separators in URLs are allowed to be passed through. (p. 197)
AllowOverride All|None|directive-type [directive-type] All [d,C]
Types of directives that are allowed in .htaccess files. (p. 197)
Anonymous user [user] [dh,E]
Specifies userIDs that are allowed access without password verification. (p. 315)
Anonymous_LogEmail On|Off On [dh,E]
Sets whether the password entered will be logged in the error log. (p. 316)
Anonymous_MustGiveEmail On|Off On [dh,E]
Specifies whether blank passwords are allowed. (p. 317)
Anonymous_NoUserID On|Off Off [dh,E]
Sets whether the userID field may be empty. (p. 317)
Anonymous_VerifyEmail On|Off Off [dh,E]
Sets whether to check the password field for a correctly formatted email address. (p. 317)
AuthBasicAuthoritative On|Off On [dh,B]
Sets whether authorization and authentication are passed to lower level modules. (p. 295)
AuthBasicProvider provider-name [provider-name] file [dh,B]
Sets the authentication provider(s) for this location. (p. 295)
AuthDBDUserPWQuery query [d,E]
SQL query to look up a password for a user. (p. 323)
AuthDBDUserRealmQuery query [d,E]
SQL query to look up a password hash for a user and realm. . (p. 324)
AuthDBMGroupFile file-path [dh,E]
Sets the name of the database file containing the list of user groups for authorization. (p. 367)
AuthDBMType default|SDBM|GDBM|NDBM|DB default [dh,E]
Sets the type of database file that is used to store passwords. (p. 328)
AuthDBMUserFile file-path [dh,E]
Sets the name of a database file containing the list of users and passwords for authentication. (p. 328)
AuthDefaultAuthoritative On|Off On [dh,B]
Sets whether authentication is passed to lower level modules. (p. 331)
AuthDigestAlgorithm MD5|MD5-sess MD5 [dh,E]
Selects the algorithm used to calculate the challenge and response hashes in digest authentication. (p. 302)
AuthDigestDomain URI [URI] [dh,E]
URIs that are in the same protection space for digest authentication. (p. 302)
AuthDigestNcCheck On|Off Off [s,E]
Enables or disables checking of the nonce-count sent by the server. (p. 303)
AuthDigestNonceFormat format [dh,E]
Determines how the nonce is generated. (p. 303)
AuthDigestNonceLifetime seconds 300 [dh,E]
How long the server nonce is valid. (p. 304)
AuthDigestProvider provider-name [provider-name] file [dh,E]
Sets the authentication provider(s) for this location. (p. 304)
AuthDigestQop none|auth|auth-int [auth|auth-int] auth [dh,E]
Determines the quality-of-protection to use in digest authentication. (p. 305)
AuthDigestShmemSize size 1000 [s,E]
The amount of shared memory to allocate for keeping track of clients. (p. 305)
AuthGroupFile file-path [dh,B]
Sets the name of a text file containing the list of user groups for authorization. (p. 374)
AuthLDAPBindAuthoritativeoff|on on [dh,E]
Determines if other authentication providers are used when a user can be mapped to a DN but the server cannot successfully bind with the user’s credentials.. (p. 357)
AuthLDAPBindDN distinguished-name [dh,E]
Optional DN to use in binding to the LDAP server. (p. 358)
AuthLDAPBindPassword password [dh,E]
Password used in conjuction with the bind DN. (p. 358)
AuthLDAPCharsetConfig file-path [s,E]
Language to charset conversion configuration file. (p. 358)
AuthLDAPCompareDNOnServer on|off on [dh,E]
Use the LDAP server to compare the DNs. (p. 359)
AuthLDAPDereferenceAliases never|searching|finding|always Always [dh,E]
When will the module de-reference aliases. (p. 359)
AuthLDAPGroupAttribute attribute member uniquemember + [dh,E]
LDAP attributes used to check for group membership. (p. 360)
AuthLDAPGroupAttributeIsDN on|off on [dh,E]
Use the DN of the client username when checking for group membership. (p. 360)
AuthLDAPRemoteUserAttribute uid [dh,E]
Use the value of the attribute returned during the user query to set the REMOTE_USER environment variable. (p. 361)
AuthLDAPRemoteUserIsDN on|off off [dh,E]
Use the DN of the client username to set the REMOTE_USER environment variable. (p. 361)
AuthLDAPUrl url [NONE|SSL|TLS|STARTTLS] [dh,E]
URL specifying the LDAP search parameters. (p. 362)
AuthName auth-domain [dh,C]
Authorization realm for use in HTTP authentication. (p. 199)
AuthType Basic|Digest [dh,C]
Type of user authentication. (p. 200)
AuthUserFile file-path [dh,B]
Sets the name of a text file containing the list of users and passwords for authentication. (p. 335)
<AuthnProviderAlias baseProvider Alias> … </AuthnProviderAlias> [s,E]
Enclose a group of directives that represent an extension of a base authentication provider and referenced by the specified alias. (p. 311)
AuthzDBMAuthoritative On|Off On [dh,E]
Sets whether authorization will be passed on to lower level modules. (p. 368)
AuthzDBMType default|SDBM|GDBM|NDBM|DB default [dh,E]
Sets the type of database file that is used to store list of user groups. (p. 369)
AuthzDefaultAuthoritative On|Off On [dh,B]
Sets whether authorization is passed to lower level modules. (p. 371)
AuthzGroupFileAuthoritative On|Off On [dh,B]
Sets whether authorization will be passed on to lower level modules. (p. 375)
AuthzLDAPAuthoritative on|off on [dh,E]
Prevent other authentication modules from authenticating the user if this one fails. (p. 364)
AuthzOwnerAuthoritative On|Off On [dh,E]
Sets whether authorization will be passed on to lower level modules. (p. 391)
AuthzUserAuthoritative On|Off On [dh,B]
Sets whether authorization will be passed on to lower level modules. (p. 394)
BalancerMember [balancerurl] url [key=value [key=value …]] [d,E]
Add a member to a load balancing group. (p. 741)
BrowserMatch regex [!]env-variable[=value] [[!]env-variable[=value]] [svdh,B]
Sets environment variables conditional on HTTP User-Agent . (p. 866)
BrowserMatchNoCase regex [!]env-variable[=value] [[!]env-variable[=value]] [svdh,B]
Sets environment variables conditional on User-Agent without respect to case. (p. 867)
BufferedLogs On|Off Off [s,B]
Buffer log entries in memory before writing to disk. (p. 661)
CGIMapExtension cgi-path .extension [dh,C]
Technique for locating the interpreter for CGI scripts. (p. 201)
CacheDefaultExpire seconds 3600 (one hour) [sv,E]
The default duration to cache a document when no expiry date is specified.. (p. 427)
CacheDirLength length 2 [sv,E]
The number of characters in subdirectory names. (p. 506)
CacheDirLevels levels 3 [sv,E]
The number of levels of subdirectories in the cache.. (p. 507)
CacheDisable url-string [sv,E]
Disable caching of specified URLs. (p. 428)
CacheEnable cache_type url-string [sv,E]
Enable caching of specified URLs using a specified storage manager. (p. 429)
CacheFile file-path [file-path] [s,X]
Cache a list of file handles at startup time. (p. 549)
CacheIgnoreCacheControl On|Off Off [sv,E]
Ignore request to not serve cached content to client. (p. 430)
CacheIgnoreHeaders header-string [header-string] None [sv,E]
Do not store the given HTTP header(s) in the cache. . (p. 431)
CacheIgnoreNoLastMod On|Off Off [sv,E]
Ignore the fact that a response has no Last Modified header.. (p. 433)
CacheIgnoreQueryString On|Off Off [sv,E]
Ignore query string when caching. (p. 433)
CacheIgnoreURLSessionIdentifiers identifier [identifier] None [sv,E]
Ignore defined session identifiers encoded in the URL when caching . (p. 434)
CacheLastModifiedFactor float 0.1 [sv,E]
The factor used to compute an expiry date based on the LastModified date.. (p. 435)
CacheLock on|off off [sv,E]
Enable the thundering herd lock.. (p. 436)
CacheLockMaxAge integer 5 [sv,E]
Set the maximum possible age of a cache lock.. (p. 437)
CacheLockPath directory /tmp/mod_cache-lock + [sv,E]
Set the lock path directory.. (p. 437)
CacheMaxExpire seconds 86400 (one day) [sv,E]
The maximum time in seconds to cache a document. (p. 437)
CacheMaxFileSize bytes 1000000 [sv,E]
The maximum size (in bytes) of a document to be placed in the cache. (p. 507)
CacheMinFileSize bytes 1 [sv,E]
The minimum size (in bytes) of a document to be placed in the cache. (p. 508)
CacheNegotiatedDocs On|Off Off [sv,B]
Allows content-negotiated documents to be cached by proxy servers. (p. 721)
CacheRoot directory [sv,E]
The directory root under which cache files are stored. (p. 509)
CacheStoreNoStore On|Off Off [sv,E]
Attempt to cache requests or responses that have been marked as no-store.. (p. 438)
CacheStorePrivate On|Off Off [sv,E]
Attempt to cache responses that the server has marked as private. (p. 439)
CharsetDefault charset [svdh,E]
Charset to translate into. (p. 458)
CharsetOptions option [option] DebugLevel=0 NoImpl + [svdh,E]
Configures charset translation behavior. (p. 458)
CharsetSourceEnc charset [svdh,E]
Source charset of files. (p. 459)
CheckCaseOnly on|off Off [svdh,E]
Limits the action of the speling module to case corrections. (p. 879)
CheckSpelling on|off Off [svdh,E]
Enables the spelling module. (p. 879)
ChrootDir /path/to/directory [s,M]
Directory for Apache to run chroot(8) after startup.. (p. 1000)
ContentDigest On|Off Off [svdh,C]
Enables the generation of Content-MD5 HTTP Response headers. (p. 201)
CookieDomain domain [svdh,E]
The domain to which the tracking cookie applies. (p. 974)
CookieExpires expiry-period [svdh,E]
Expiry time for the tracking cookie. (p. 975)
CookieLog filename [sv,B]
Sets filename for the logging of cookies. (p. 662)
CookieName token Apache [svdh,E]
Name of the tracking cookie. (p. 976)
CookieStyle Netscape|Cookie|Cookie2|RFC2109|RFC2965 Netscape [svdh,E]
Format of the cookie header field. (p. 976)
CookieTracking on|off off [svdh,E]
Enables tracking cookie. (p. 977)
CoreDumpDirectory directory [s,M]
Directory where Apache attempts to switch before dumping core. (p. 1000)
CustomLog file|pipe format|nickname [env=[!]environment-variable] [sv,B]
Sets filename and format of log file. (p. 662)
DBDExptime time-in-seconds 300 [sv,E]
Keepalive time for idle connections. (p. 482)
DBDKeep number 2 [sv,E]
Maximum sustained number of connections. (p. 482)
DBDMax number 10 [sv,E]
Maximum number of connections. (p. 482)
DBDMin number 1 [sv,E]
Minimum number of connections. (p. 482)
DBDParams param1=value1[,param2=value2] [sv,E]
Parameters for database connection. (p. 483)
DBDPersist On|Off [sv,E]
Whether to use persistent connections. (p. 484)
DBDPrepareSQL "SQL statement" label [sv,E]
Define an SQL prepared statement. (p. 484)
DBDriver name [sv,E]
Specify an SQL driver. (p. 484)
Dav On|Off|provider-name Off [d,E]
Enable WebDAV HTTP methods. (p. 466)
DavDepthInfinity on|off off [svd,E]
Allow PROPFIND, Depth: Infinity requests. (p. 467)
DavGenericLockDB file-path [svd,E]
Location of the DAV lock database. (p. 474)
DavLockDB file-path [sv,E]
Location of the DAV lock database. (p. 471)
DavMinTimeout seconds 0 [svd,E]
Minimum amount of time the server holds a lock on a DAV resource. (p. 468)
DefaultIcon url-path [svdh,B]
Icon to display for files when no specific icon is configured. (p. 407)
DefaultLanguage MIME-lang [svdh,B]
Sets all files in the given scope to the specified language. (p. 697)
DefaultType MIME-type|none text/plain [svdh,C]
MIME content-type that will be sent if the server cannot determine a type in any other way. (p. 202)
DeflateBufferSize value 8096 [sv,E]
Fragment size to be compressed at one time by zlib. (p. 494)
DeflateCompressionLevel value [sv,E]
How much compression do we apply to the output. (p. 495)
DeflateFilterNote [type] notename [sv,E]
Places the compression ratio in a note for logging. (p. 495)
DeflateMemLevel value 9 [sv,E]
How much memory should be used by zlib for compression. (p. 496)
DeflateWindowSize value 15 [sv,E]
Zlib compression window size. (p. 497)
Deny from all|host|env=[!]env-variable [host|env=[!]env-variable] [dh,B]
Controls which hosts are denied access to the server. (p. 382)
<Directory directory-path> … </Directory> [sv,C]
Enclose a group of directives that apply only to the named file-system directory and sub-directories. (p. 203)
DirectoryIndex local-url [local-url] index.html [svdh,B]
List of resources to look for when the client requests a directory. (p. 500)
<DirectoryMatch regex> … </DirectoryMatch> [sv,C]
Enclose directives that apply to file-system directories matching a regular expression and their subdirectories. (p. 207)
DirectorySlash On|Off On [svdh,B]
Toggle trailing slash redirects on or off. (p. 501)
DocumentRoot directory-path /usr/local/apache/h + [sv,C]
Directory that forms the main document tree visible from the web. (p. 208)
DumpIOInput On|Off Off [s,E]
Dump all input data to the error log. (p. 512)
DumpIOLogLevel level debug [s,E]
Controls the logging level of the DumpIO output. (p. 512)
DumpIOOutput On|Off Off [s,E]
Dump all output data to the error log. (p. 513)
EnableExceptionHook On|Off Off [s,M]
Enables a hook that runs exception handlers after a crash. (p. 1001)
EnableMMAP On|Off On [svdh,C]
Use memory-mapping to read files during delivery. (p. 209)
EnableSendfile On|Off On [svdh,C]
Use the kernel sendfile support to deliver files to the client. (p. 210)
ErrorDocument error-code document [svdh,C]
What the server will return to the client in case of an error. (p. 212)
ErrorLog file-path|syslog[:facility] logs/error_log (Uni + [sv,C]
Location where the server will log errors. (p. 214)
Example [svdh,X]
Demonstration directive to illustrate the Apache module API. (p. 525)
ExpiresActive On|Off [svdh,E]
Enables generation of Expires headers. (p. 530)
ExpiresByType MIME-type <code>seconds [svdh,E]
Value of the Expires header configured by MIME type. (p. 530)
ExpiresDefault <code>seconds [svdh,E]
Default algorithm for calculating expiration time. (p. 531)
ExtFilterDefine filtername parameters [s,E]
Define an external filter. (p. 543)
ExtFilterOptions option [option] DebugLevel=0 NoLogS + [d,E]
Configure mod_ext_filter options. (p. 544)
ExtendedStatus On|Off Off [s,B]
Keep track of extended status information for each request. (p. 951)
FallbackResource local-url [svdh,B]
Define a default URL for requests that don’t map to a file. (p. 502)
FileETag component INode MTime Size [svdh,C]
File attributes used to create the ETag HTTP response header for static files. (p. 216)
<Files filename> … </Files> [svdh,C]
Contains directives that apply to matched filenames. (p. 218)
<FilesMatch regex> … </FilesMatch> [svdh,C]
Contains directives that apply to regular-expression matched filenames. (p. 219)
FilterChain [+=-@!]filter-name [svdh,B]
Configure the filter chain. (p. 564)
FilterDeclare filter-name [type] [svdh,B]
Declare a smart filter. (p. 564)
FilterProtocol filter-name [provider-name] proto-flags [svdh,B]
Deal with correct HTTP protocol handling. (p. 565)
FilterProvider filter-name provider-name [req|resp|env]=dispatch match [svdh,B]
Register a content filter. (p. 566)
FilterTrace filter-name level [svd,B]
Get debug/diagnostic information from mod_filter. (p. 567)
ForceLanguagePriority None|Prefer|Fallback [Prefer|Fallback] Prefer [svdh,B]
Action to take if a single acceptable document is not found. (p. 722)
ForceType MIME-type|None [dh,C]
Forces all matching files to be served with the specified MIME content-type. (p. 219)
ForensicLog filename|pipe [sv,E]
Sets filename of the forensic log. (p. 670)
GracefulShutDownTimeout seconds [s,M]
Specify a timeout after which a gracefully shutdown server will exit.. (p. 1002)
Group unix-group #-1 [s,M]
Group under which the server will answer requests. (p. 1002)
Header [condition] set|append|merge|add|unset|echo|edit header [value] [early|env=[!]variable] [svdh,E]
Configure HTTP response headers. (p. 574)
HeaderName filename [svdh,B]
Name of the file that will be inserted at the top of the index listing. (p. 408)
HostnameLookups On|Off|Double Off [svd,C]
Enables DNS lookups on client IP addresses. (p. 221)
ISAPIAppendLogToErrors on|off off [svdh,B]
Record HSE_APPEND_LOG_PARAMETER requests from ISAPI extensions to the error log. (p. 632)
ISAPIAppendLogToQuery on|off on [svdh,B]
Record HSE_APPEND_LOG_PARAMETER requests from ISAPI extensions to the query field. (p. 633)
ISAPICacheFile file-path [file-path] [sv,B]
ISAPI .dll files to be loaded at startup. (p. 633)
ISAPIFakeAsync on|off off [svdh,B]
Fake asynchronous support for ISAPI callbacks. (p. 634)
ISAPILogNotSupported on|off off [svdh,B]
Log unsupported feature requests from ISAPI extensions. (p. 634)
ISAPIReadAheadBuffer size 49152 [svdh,B]
Size of the Read Ahead Buffer sent to ISAPI extensions. (p. 634)
IdentityCheck On|Off Off [svd,E]
Enables logging of the RFC 1413 identity of the remote user. (p. 582)
IdentityCheckTimeout seconds 30 [svd,E]
Determines the timeout duration for ident requests. (p. 583)
<IfDefine [!]parameter-name> … </IfDefine> [svdh,C]
Encloses directives that will be processed only if a test is true at startup. (p. 221)
<IfModule [!]module-file|module-identifier> … </IfModule> [svdh,C]
Encloses directives that are processed conditional on the presence or absence of a specific module. (p. 223)
<IfVersion [[!]operator] version> … </IfVersion> [svdh,E]
contains version dependent configuration. (p. 980)
ImapBase map|referer|URL http://servername/ [svdh,B]
Default base for imagemap files. (p. 593)
ImapDefault error|nocontent|map|referer|URL nocontent [svdh,B]
Default action when an imagemap is called with coordinates that are not explicitly mapped. (p. 593)
ImapMenu none|formatted|semiformatted|unformatted [svdh,B]
Action if no coordinates are given when calling an imagemap. (p. 594)
Include file-path|directory-path [svd,C]
Includes other configuration files from within the server configuration files. (p. 224)
IndexHeadInsert "markup …" [svdh,B]
Inserts text in the HEAD section of an index page.. (p. 409)
IndexIgnore file [file] [svdh,B]
Adds to the list of files to hide when listing a directory. (p. 410)
IndexOptions [+|-]option [[+|-]option] [svdh,B]
Various configuration settings for directory indexing. (p. 410)
IndexOrderDefault Ascending|Descending Name|Date|Size|Description Ascending Name [svdh,B]
Sets the default ordering of the directory index. (p. 418)
IndexStyleSheet url-path [svdh,B]
Adds a CSS stylesheet to the directory index. (p. 418)
KeepAlive On|Off On [sv,C]
Enables HTTP persistent connections. (p. 225)
KeepAliveTimeout seconds 5 [sv,C]
Amount of time the server will wait for subsequent requests on a persistent connection. (p. 226)
LDAPCacheEntries number 1024 [s,E]
Maximum number of entries in the primary LDAP cache. (p. 648)
LDAPCacheTTL seconds 600 [s,E]
Time that cached items remain valid. (p. 648)
LDAPConnectionTimeout seconds [s,E]
Specifies the socket connection timeout in seconds. (p. 649)
LDAPOpCacheEntries number 1024 [s,E]
Number of entries used to cache LDAP compare operations. (p. 649)
LDAPOpCacheTTL seconds 600 [s,E]
Time that entries in the operation cache remain valid. (p. 650)
LDAPSharedCacheFile directory-path/filename [s,E]
Sets the shared memory cache file. (p. 650)
LDAPSharedCacheSize bytes 500000 [s,E]
Size in bytes of the shared-memory cache. (p. 651)
LDAPTrustedClientCert type directory-path/filename/nickname [password] [svdh,E]
Sets the file containing or nickname referring to a per connection client certificate. Not all LDAP toolkits support per connection client certificates.. (p. 651)
LDAPTrustedGlobalCert type directory-path/filename [password] [s,E]
Sets the file or database containing global trusted Certificate Authority or global client certificates. (p. 652)
LDAPTrustedMode type [sv,E]
Specifies the SSL/TLS mode to be used when connecting to an LDAP server.. (p. 653)
LDAPVerifyServerCert On|Off On [s,E]
Force server certificate verification. (p. 654)
LanguagePriority MIME-lang [MIME-lang] [svdh,B]
The precendence of language variants for cases where the client does not express a preference. (p. 723)
<Limit method [method] … > … </Limit> [svdh,C]
Restrict enclosed access controls to only certain HTTP methods. (p. 227)
<LimitExcept method [method] … > … </LimitExcept> [svdh,C]
Restrict access controls to all HTTP methods except the named ones. (p. 228)
LimitInternalRecursion number [number] 10 [sv,C]
Determine maximum number of internal redirects and nested subrequests. (p. 229)
LimitRequestBody bytes 0 [svdh,C]
Restricts the total size of the HTTP request body sent from the client. (p. 230)
LimitRequestFieldSize bytes 8190 [s,C]
Limits the size of the HTTP request header allowed from the client. (p. 231)
LimitRequestFields number 100 [s,C]
Limits the number of HTTP request header fields that will be accepted from the client. (p. 232)
LimitRequestLine bytes 8190 [s,C]
Limit the size of the HTTP request line that will be accepted from the client. (p. 233)
LimitXMLRequestBody bytes 1000000 [svdh,C]
Limits the size of an XML-based request body. (p. 234)
Listen [IP-address:]portnumber [protocol] [s,M]
IP addresses and ports that the server listens to. (p. 1003)
ListenBacklog backlog [s,M]
Maximum length of the queue of pending connections. (p. 1006)
LoadFile filename [filename] [s,E]
Link in the named object file or library. (p. 875)
LoadModule module filename [s,E]
Links in the object file or library, and adds to the list of active modules. (p. 876)
<Location URL-path|URL> … </Location> [sv,C]
Applies the enclosed directives only to matching URLs. (p. 234)
<LocationMatch regex> … </LocationMatch> [sv,C]
Applies the enclosed directives only to regular-expression matching URLs. (p. 237)
LockFile filename logs/accept.lock [s,M]
Location of the accept serialization lock file. (p. 1006)
LogFormat format|nickname [nickname] "%h %l %u %t \"%r\" + [sv,B]
Describes a format for use in a log file. (p. 664)
LogLevel level warn [sv,C]
Controls the verbosity of the ErrorLog. (p. 237)
MCacheMaxObjectCount value 1009 [s,E]
The maximum number of objects allowed to be placed in the cache. (p. 677)
MCacheMaxObjectSize bytes 10000 [s,E]
The maximum size (in bytes) of a document allowed in the cache. (p. 678)
MCacheMaxStreamingBuffer size_in_bytes the smaller of 1000 + [s,E]
Maximum amount of a streamed response to buffer in memory before declaring the response uncacheable. (p. 678)
MCacheMinObjectSize bytes 1 [s,E]
The minimum size (in bytes) of a document to be allowed in the cache. (p. 680)
MCacheRemovalAlgorithm LRU|GDSF GDSF [s,E]
The algorithm used to select documents for removal from the cache. (p. 680)
MCacheSize KBytes 100 [s,E]
The maximum amount of memory used by the cache in KBytes. (p. 681)
MMapFile file-path [file-path] [s,X]
Map a list of files into memory at startup time. (p. 550)
MaxClients number [s,M]
Maximum number of connections that will be processed simultaneously. (p. 1007)
MaxKeepAliveRequests number 100 [sv,C]
Number of requests allowed on a persistent connection. (p. 239)
MaxMemFree KBytes 0 [s,M]
Maximum amount of memory that the main allocator is allowed to hold without calling free(). (p. 1007)
MaxRequestsPerChild number 10000 [s,M]
Limit on the number of requests that an individual child server will handle during its life. (p. 1008)
MaxRequestsPerThread number 0 [s,M]
Limit on the number of requests that an individual thread will handle during its life. (p. 994)
MaxSpareServers number 10 [s,M]
Maximum number of idle child server processes. (p. 1027)
MaxSpareThreads number [s,M]
Maximum number of idle threads. (p. 1009)
MetaDir directory .web [svdh,E]
Name of the directory to find CERN-style meta information files. (p. 443)
MetaFiles on|off off [svdh,E]
Activates CERN meta-file processing. (p. 444)
MetaSuffix suffix .meta [svdh,E]
File name suffix for the file containg CERN-style meta information. (p. 444)
MimeMagicFile file-path [sv,E]
Enable MIME-type determination based on file contents using the specified magic file. (p. 715)
MinSpareServers number 5 [s,M]
Minimum number of idle child server processes. (p. 1028)
MinSpareThreads number [s,M]
Minimum number of idle threads available to handle request spikes. (p. 1010)
ModMimeUsePathInfo On|Off Off [d,B]
Tells mod_mime to treat path_info components as part of the filename. (p. 697)
MultiviewsMatch Any|NegotiatedOnly|Filters|Handlers [Handlers|Filters] NegotiatedOnly [svdh,B]
The types of files that will be included when searching for a matching file with MultiViews. (p. 698)
NWSSLTrustedCerts filename [filename] [s,B]
List of additional client certificates. (p. 726)
NWSSLUpgradeable [IP-address:]portnumber [s,B]
Allows a connection to be upgraded to an SSL connection upon request. (p. 727)
NameVirtualHost addr[:port] [s,C]
Designates an IP address for name-virtual hosting. (p. 239)
NoProxy host [host] [sv,E]
Hosts, domains, or networks that will be connected to directly. (p. 741)
Options [+|-]option [[+|-]option] All [svdh,C]
Configures what features are available in a particular directory. (p. 242)
Order ordering Deny,Allow [dh,B]
Controls the default access state and the order in which Allow and Deny are evaluated.. (p. 383)
PassEnv env-variable [env-variable] [svdh,B]
Passes environment variables from the shell. (p. 519)
PidFile filename logs/httpd.pid [s,M]
File where the server records the process ID of the daemon. (p. 1010)
ProtocolEcho On|Off Off [sv,X]
Turn the echo server on or off. (p. 515)
<Proxy wildcard-url> …</Proxy> [sv,E]
Container for directives applied to proxied resources. (p. 744)
ProxyBadHeader IsError|Ignore|StartBody IsError [sv,E]
Determines how to handle bad header lines in a response. (p. 746)
ProxyBlock *|word|host|domain [word|host|domain] [sv,E]
Words, hosts, or domains that are banned from being proxied. (p. 746)
ProxyDomain Domain [sv,E]
Default domain name for proxied requests. (p. 747)
ProxyErrorOverride On|Off Off [sv,E]
Override error pages for proxied content. (p. 748)
ProxyFtpDirCharset character set ISO-8859-1 [svd,E]
Define the character set for proxied FTP listings. (p. 748)
ProxyIOBufferSize bytes 8192 [sv,E]
Determine size of internal data throughput buffer. (p. 749)
<ProxyMatch regex> …</ProxyMatch> [sv,E]
Container for directives applied to regular-expression-matched proxied resources. (p. 749)
ProxyMaxForwards number -1 [sv,E]
Maximium number of proxies that a request can be forwarded through. (p. 750)
ProxyPass [path] !|url [key=value key=value …]] [nocanon] [interpolate] [svd,E]
Maps remote servers into the local server URL-space. (p. 750)
ProxyPassInterpolateEnv On|Off Off [svd,E]
Enable Environment Variable interpolation in Reverse Proxy configurations. (p. 759)
ProxyPassMatch [regex] !|url [key=value [key=value …]] [svd,E]
Maps remote servers into the local server URL-space using regular expressions. (p. 760)
ProxyPassReverse [path] url [interpolate] [svd,E]
Adjusts the URL in HTTP response headers sent from a reverse proxied server. (p. 762)
ProxyPassReverseCookieDomain internal-domain public-domain [interpolate] [svd,E]
Adjusts the Domain string in Set-Cookie headers from a reverse-proxied server. (p. 763)
ProxyPassReverseCookiePath internal-path public-path [interpolate] [svd,E]
Adjusts the Path string in Set-Cookie headers from a reverse- proxied server. (p. 763)
ProxyPreserveHost On|Off Off [sv,E]
Use incoming Host HTTP request header for proxy request. (p. 764)
ProxyReceiveBufferSize bytes 0 [sv,E]
Network buffer size for proxied HTTP and FTP connections. (p. 764)
ProxyRemote match remote-server [sv,E]
Remote proxy used to handle certain requests. (p. 765)
ProxyRemoteMatch regex remote-server [sv,E]
Remote proxy used to handle requests matched by regular expressions. (p. 766)
ProxyRequests On|Off Off [sv,E]
Enables forward (standard) proxy requests. (p. 766)
ProxySCGIInternalRedirect On|Off On [svd,E]
Enable or disable internal redirect responses from the backend. (p. 818)
ProxySCGISendfile On|Off|Headername Off [svd,E]
Enable evaluation of X-Sendfile pseudo response header. (p. 818)
ProxySet url key=value [key=value …] [d,E]
Set various Proxy balancer or member parameters. (p. 767)
ProxyStatus Off|On|Full Off [sv,E]
Show Proxy LoadBalancer status in mod_status. (p. 769)
ProxyTimeout seconds [sv,E]
Network timeout for proxied requests. (p. 769)
ProxyVia On|Off|Full|Block Off [sv,E]
Information provided in the Via HTTP response header for proxied requests. (p. 770)
RLimitCPU seconds|max [seconds|max] [svdh,C]
Limits the CPU consumption of processes launched by Apache children. (p. 245)
RLimitMEM bytes|max [bytes|max] [svdh,C]
Limits the memory consumption of processes launched by Apache children. (p. 246)
RLimitNPROC number|max [number|max] [svdh,C]
Limits the number of processes that can be launched by processes launched by Apache children. (p. 247)
ReadmeName filename [svdh,B]
Name of the file that will be inserted at the end of the index listing. (p. 419)
ReceiveBufferSize bytes 0 [s,M]
TCP receive buffer size. (p. 1011)
Redirect [status] URL-path URL [svdh,B]
Sends an external redirect asking the client to fetch a different URL. (p. 282)
RedirectMatch [status] regex URL [svdh,B]
Sends an external redirect based on a regular expression match of the current URL. (p. 284)
RedirectPermanent URL-path URL [svdh,B]
Sends an external permanent redirect asking the client to fetch a different URL. (p. 284)
RedirectTemp URL-path URL [svdh,B]
Sends an external temporary redirect asking the client to fetch a different URL. (p. 285)
RemoveCharset extension [extension] [vdh,B]
Removes any character set associations for a set of file extensions. (p. 700)
RemoveEncoding extension [extension] [vdh,B]
Removes any content encoding associations for a set of file extensions. (p. 700)
RemoveHandler extension [extension] [vdh,B]
Removes any handler associations for a set of file extensions. (p. 702)
RemoveInputFilter extension [extension] [vdh,B]
Removes any input filter associations for a set of file extensions. (p. 703)
RemoveLanguage extension [extension] [vdh,B]
Removes any language associations for a set of file extensions. (p. 703)
RemoveOutputFilter extension [extension] [vdh,B]
Removes any output filter associations for a set of file extensions. (p. 704)
RemoveType extension [extension] [vdh,B]
Removes any content type associations for a set of file extensions. (p. 704)
RequestHeader set|append|merge|add|unset|edit header [value] [replacement] [early|env=[!]variable] [svdh,E]
Configure HTTP request headers. (p. 578)
RequestReadTimeout [header=timeout[[-maxtimeout],MinRate=rate] [body=timeout[[-maxtimeout],MinRate=rate] [sv,X]
Set timeout values for receiving request headers and body from client. . (p. 822)
Require entity-name [entity-name] [dh,C]
Selects which authenticated users can access a resource. (p. 248)
RewriteBase URL-path [dh,E]
Sets the base URL for per-directory rewrites. (p. 830)
RewriteCond TestString CondPattern [svdh,E]
Defines a condition under which rewriting will take place . (p. 832)
RewriteEngine on|off off [svdh,E]
Enables or disables runtime rewriting engine. (p. 841)
RewriteLock file-path [s,E]
Sets the name of the lock file used for RewriteMap synchronization. (p. 842)
RewriteLog file-path [sv,E]
Sets the name of the file used for logging rewrite engine processing. (p. 842)
RewriteLogLevel Level 0 [sv,E]
Sets the verbosity of the log file used by the rewrite engine. (p. 843)
RewriteMap MapName MapType:MapSource [sv,E]
Defines a mapping function for key-lookup. (p. 844)
RewriteOptions Options [svdh,E]
Sets some special options for the rewrite engine. (p. 851)
RewriteRule Pattern Substitution [flags] [svdh,E]
Defines rules for the rewriting engine. (p. 851)
SSIETag on|off off [dh,B]
Controls whether ETags are generated by the server.. (p. 612)
SSIEnableAccess on|off off [dh,B]
Enable the -A flag during conditional flow control processing.. (p. 613)
SSIEndTag tag ">" [sv,B]
String that ends an include element. (p. 613)
SSIErrorMsg message "[an error occurred + [svdh,B]
Error message displayed when there is an SSI error. (p. 614)
SSILastModified on|off off [dh,B]
Controls whether Last-Modified headers are generated by the server.. (p. 615)
SSIStartTag tag "<!–#" [sv,B]
String that starts an include element. (p. 615)
SSITimeFormat formatstring "%A, %d-%b-%Y %H:%M + [svdh,B]
Configures the format in which date strings are displayed. (p. 616)
SSIUndefinedEcho string "(none)" [svdh,B]
String displayed when an unset variable is echoed. (p. 617)
SSLCACertificateFile file-path [sv,E]
File of concatenated PEM-encoded CA Certificates for Client Auth. (p. 891)
SSLCACertificatePath directory-path [sv,E]
Directory of PEM-encoded CA Certificates for Client Auth. (p. 892)
SSLCADNRequestFile file-path [sv,E]
File of concatenated PEM-encoded CA Certificates for defining acceptable CA names. (p. 893)
SSLCADNRequestPath directory-path [sv,E]
Directory of PEM-encoded CA Certificates for defining acceptable CA names. (p. 894)
SSLCARevocationFile file-path [sv,E]
File of concatenated PEM-encoded CA CRLs for Client Auth. (p. 894)
SSLCARevocationPath directory-path [sv,E]
Directory of PEM-encoded CA CRLs for Client Auth. (p. 895)
SSLCertificateChainFile file-path [sv,E]
File of PEM-encoded Server CA Certificates. (p. 896)
SSLCertificateFile file-path [sv,E]
Server PEM-encoded X.509 Certificate file. (p. 897)
SSLCertificateKeyFile file-path [sv,E]
Server PEM-encoded Private Key file. (p. 897)
SSLCipherSuite cipher-spec ALL:!ADH:RC4+RSA:+H + [svdh,E]
Cipher Suite available for negotiation in SSL handshake. (p. 898)
SSLCryptoDevice engine builtin [s,E]
Enable use of a cryptographic hardware accelerator. (p. 907)
SSLEngine on|off|optional off [sv,E]
SSL Engine Operation Switch. (p. 907)
SSLFIPS on|off off [s,E]
SSL FIPS mode Switch. (p. 908)
SSLHonorCipherOrder flag [sv,E]
Option to prefer the server’s cipher preference order. (p. 909)
SSLInsecureRenegotiation flag off [sv,E]
Option to enable support for insecure renegotiation. (p. 909)
SSLMutex type none [s,E]
Semaphore for internal mutual exclusion of operations. (p. 910)
SSLOptions [+|-]option [svdh,E]
Configure various SSL engine run-time options. (p. 913)
SSLPassPhraseDialog type builtin [s,E]
Type of pass phrase dialog for encrypted private keys. (p. 915)
SSLProtocol [+|-]protocol all [sv,E]
Configure usable SSL protocol flavors. (p. 916)
SSLProxyCACertificateFile file-path [sv,E]
File of concatenated PEM-encoded CA Certificates for Remote Server Auth. (p. 918)
SSLProxyCACertificatePath directory-path [sv,E]
Directory of PEM-encoded CA Certificates for Remote Server Auth. (p. 918)
SSLProxyCARevocationFile file-path [sv,E]
File of concatenated PEM-encoded CA CRLs for Remote Server Auth. (p. 919)
SSLProxyCARevocationPath directory-path [sv,E]
Directory of PEM-encoded CA CRLs for Remote Server Auth. (p. 920)
SSLProxyCheckPeerCN on|off off [sv,E]
Whether to check the remote server certificates CN field . (p. 921)
SSLProxyCheckPeerExpire on|off off [sv,E]
Whether to check if remote server certificate is expired . (p. 921)
SSLProxyCipherSuite cipher-spec ALL:!ADH:RC4+RSA:+H + [svdh,E]
Cipher Suite available for negotiation in SSL proxy handshake. (p. 922)
SSLProxyEngine on|off off [sv,E]
SSL Proxy Engine Operation Switch. (p. 922)
SSLProxyMachineCertificateFile filename [s,E]
File of concatenated PEM-encoded client certificates and keys to be used by the proxy. (p. 923)
SSLProxyMachineCertificatePath directory [s,E]
Directory of PEM-encoded client certificates and keys to be used by the proxy. (p. 924)
SSLProxyProtocol [+|-]protocol all [sv,E]
Configure usable SSL protocol flavors for proxy usage. (p. 924)
SSLProxyVerify level none [svdh,E]
Type of remote server Certificate verification. (p. 925)
SSLProxyVerifyDepth number 1 [svdh,E]
Maximum depth of CA Certificates in Remote Server Certificate verification. (p. 926)
SSLRandomSeed context source [bytes] [s,E]
Pseudo Random Number Generator (PRNG) seeding source. (p. 927)
SSLRenegBufferSize bytes 131072 [dh,E]
Set the size for the SSL renegotiation buffer. (p. 930)
SSLRequire expression [dh,E]
Allow access only when an arbitrarily complex boolean expression is true. (p. 930)
SSLRequireSSL [dh,E]
Deny access when SSL is not used for the HTTP request. (p. 941)
SSLSessionCache type none [s,E]
Type of the global/inter-process SSL Session Cache. (p. 941)
SSLSessionCacheTimeout seconds 300 [sv,E]
Number of seconds before an SSL session expires in the Session Cache. (p. 943)
SSLStrictSNIVHostCheck on|off off [sv,E]
Whether to allow non SNI clients to access a name based virtual host. . (p. 943)
SSLUserName varname [sdh,E]
Variable name to determine user name. (p. 944)
SSLVerifyClient level none [svdh,E]
Type of Client Certificate verification. (p. 945)
SSLVerifyDepth number 1 [svdh,E]
Maximum depth of CA Certificates in Client Certificate verification. (p. 946)
Satisfy Any|All All [dh,C]
Interaction between host-level access control and user authentication. (p. 250)
ScoreBoardFile file-path logs/apache_status [s,M]
Location of the file used to store coordination data for the child processes. (p. 1012)
Script method cgi-script [svd,B]
Activates a CGI script for a particular request method.. (p. 273)
ScriptAlias URL-path file-path|directory-path [sv,B]
Maps a URL to a filesystem location and designates the target as a CGI script. (p. 285)
ScriptAliasMatch regex file-path|directory-path [sv,B]
Maps a URL to a filesystem location using a regular expression and designates the target as a CGI script. (p. 287)
ScriptInterpreterSource Registry|Registry-Strict|Script Script [svdh,C]
Technique for locating the interpreter for CGI scripts. (p. 251)
ScriptLog file-path [sv,B]
Location of the CGI script error logfile. (p. 449)
ScriptLogBuffer bytes 1024 [sv,B]
Maximum amount of PUT or POST requests that will be recorded in the scriptlog. (p. 450)
ScriptLogLength bytes 10385760 [sv,B]
Size limit of the CGI script logfile. (p. 451)
ScriptSock file-path logs/cgisock [s,B]
The filename prefix of the socket to use for communication with the CGI daemon. (p. 454)
SecureListen [IP-address:]portnumber Certificate-Name [MUTUAL] [s,B]
Enables SSL encryption for the specified port. (p. 727)
SeeRequestTail On|Off Off [s,B]
Determine if mod_status displays the first 63 characters of a request or the last 63, assuming the request itself is greater than 63 chars.. (p. 952)
SendBufferSize bytes 0 [s,M]
TCP buffer size. (p. 1013)
ServerAdmin email-address|URL [sv,C]
Email address that the server includes in error messages sent to the client. (p. 253)
ServerAlias hostname [hostname] [v,C]
Alternate names for a host used when matching requests to name-virtual hosts. (p. 254)
ServerLimit number [s,M]
Upper limit on configurable number of processes. (p. 1013)
ServerName [scheme://]fully-qualified-domain-name[:port] [sv,C]
Hostname and port that the server uses to identify itself. (p. 255)
ServerPath URL-path [v,C]
Legacy URL pathname for a name-based virtual host that is accessed by an incompatible browser. (p. 256)
ServerRoot directory-path /usr/local/apache [s,C]
Base directory for the server installation. (p. 256)
ServerSignature On|Off|EMail Off [svdh,C]
Configures the footer on server-generated documents. (p. 257)
ServerTokens Major|Minor|Min[imal]|Prod[uctOnly]|OS|Full Full [s,C]
Configures the Server HTTP response header. (p. 258)
SetEnv env-variable value [svdh,B]
Sets environment variables. (p. 519)
SetEnvIf attribute regex [!]env-variable[=value] [[!]env-variable[=value]] [svdh,B]
Sets environment variables based on attributes of the request . (p. 868)
SetEnvIfNoCase attribute regex [!]env-variable[=value] [[!]env-variable[=value]] [svdh,B]
Sets environment variables based on attributes of the request without respect to case. (p. 870)
SetHandler handler-name|None [svdh,C]
Forces all matching files to be processed by a handler. (p. 259)
SetInputFilter filter[;filter…] [svdh,C]
Sets the filters that will process client requests and POST input. (p. 260)
SetOutputFilter filter[;filter…] [svdh,C]
Sets the filters that will process responses from the server. (p. 261)
StartServers number [s,M]
Number of child server processes created at startup. (p. 1014)
StartThreads number [s,M]
Number of threads created on startup. (p. 1014)
Substitute s/pattern/substitution/[infq] [dh,E]
Pattern to filter the response content. (p. 954)
SuexecUserGroup User Group [sv,E]
User and group for CGI programs to run as. (p. 958)
ThreadLimit number [s,M]
Sets the upper limit on the configurable number of threads per child process. (p. 1015)
ThreadStackSize size [s,M]
The size in bytes of the stack used by threads handling client connections. (p. 1016)
ThreadsPerChild number [s,M]
Number of threads created by each child process. (p. 1017)
TimeOut seconds 300 [sv,C]
Amount of time the server will wait for certain events before failing a request. (p. 262)
TraceEnable [on|off|extended] on [s,C]
Determines the behaviour on TRACE requests. (p. 262)
TransferLog file|pipe [sv,B]
Specify location of a log file. (p. 665)
TypesConfig file-path conf/mime.types [s,B]
The location of the mime.types file. (p. 705)
UnsetEnv env-variable [env-variable] [svdh,B]
Removes variables from the environment. (p. 520)
UseCanonicalName On|Off|DNS Off [svd,C]
Configures how the server determines its own name and port. (p. 263)
UseCanonicalPhysicalPort On|Off Off [svd,C]
Configures how the server determines its own name and port. (p. 264)
User unix-userid #-1 [s,M]
The userid under which the server will answer requests. (p. 1017)
UserDir directory-filename [directory-filename] [sv,B]
Location of the user-specific directories. (p. 966)
VirtualDocumentRoot interpolated-directory|none none [sv,E]
Dynamically configure the location of the document root for a given virtual host. (p. 989)
VirtualDocumentRootIP interpolated-directory|none none [sv,E]
Dynamically configure the location of the document root for a given virtual host. (p. 990)
<VirtualHost addr[:port] [addr[:port]] …> … </VirtualHost> [s,C]
Contains directives that apply only to a specific hostname or IP address. (p. 266)
VirtualScriptAlias interpolated-directory|none none [sv,E]
Dynamically configure the location of the CGI directory for a given virtual host. (p. 990)
VirtualScriptAliasIP interpolated-directory|none none [sv,E]
Dynamically configure the location of the cgi directory for a given virtual host. (p. 991)
Win32DisableAcceptEx [s,M]
Use accept() rather than AcceptEx() to accept network connections. (p. 1031)
XBitHack on|off|full off [svdh,B]
Parse SSI directives in files with the execute bit set. (p. 618)

ISBN 9781906966034The Apache HTTP Server Reference ManualSee the print edition