<-
Apache > HTTP Server > Documentation > Version 2.2 > Modules

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.

The first column gives the directive name and usage. The second columns shows the default value of the directive, if a default exists. If the default is too large to display, the first characters will be followed by "+".

The third and fourth columns list the contexts where the directive is allowed and the status of the directive according to the legend tables below.

 A  |  B  |  C  |  D  |  E  |  F  |  G  |  H  |  I  |  K  |  L  |  M  |  N  |  O  |  P  |  R  |  S  |  T  |  U  |  V  |  W  |  X  |  Z 
sserver config
vvirtual host
ddirectory
h.htaccess
CCore
MMPM
BBase
EExtension
XExperimental
AcceptErrorsNonFatal ONsM
Treat some errors accepting a new connection as non-fatal to the httpd process.
AcceptFilter protocol accept_filtersC
Configures optimizations for a Protocol's Listener Sockets
AcceptMutex Default|method Default sM
Method that Apache uses to serialize multiple children accepting requests on network sockets
AcceptPathInfo On|Off|Default Default svdhC
Resources accept trailing pathname information
AccessFileName filename [filename] ... .htaccess svC
Name of the distributed configuration file
Action action-type cgi-script [virtual]svdhB
Activates a CGI script for a particular handler or content-type
AddAlt string file [file] ...svdhB
Alternate text to display for a file, instead of an icon selected by filename
AddAltByEncoding string MIME-encoding [MIME-encoding] ...svdhB
Alternate text to display for a file instead of an icon selected by MIME-encoding
AddAltByType string MIME-type [MIME-type] ...svdhB
Alternate text to display for a file, instead of an icon selected by MIME content-type
AddCharset charset extension [extension] ...svdhB
Maps the given filename extensions to the specified content charset
AddDefaultCharset On|Off|charset Off svdhC
Default charset parameter to be added when a response content-type is text/plain or text/html
AddDescription string file [file] ...svdhB
Description to display for a file
AddEncoding MIME-enc extension [extension] ...svdhB
Maps the given filename extensions to the specified encoding type
AddHandler handler-name extension [extension] ...svdhB
Maps the filename extensions to the specified handler
AddIcon icon name [name] ...svdhB
Icon to display for a file selected by name
AddIconByEncoding icon MIME-encoding [MIME-encoding] ...svdhB
Icon to display next to files selected by MIME content-encoding
AddIconByType icon MIME-type [MIME-type] ...svdhB
Icon to display next to files selected by MIME content-type
AddInputFilter filter[;filter...] extension [extension] ...svdhB
Maps filename extensions to the filters that will process client requests
AddLanguage MIME-lang extension [extension] ...svdhB
Maps the given filename extension to the specified content language
AddModuleInfo module-name stringsvE
Adds additional information to the module information displayed by the server-info handler
AddOutputFilter filter[;filter...] extension [extension] ...svdhB
Maps filename extensions to the filters that will process responses from the server
AddOutputFilterByType filter[;filter...] MIME-type [MIME-type] ...svdhC
assigns an output filter to a particular MIME-type
AddServerHeader on|off on (After PM77980, +svC
Determines whether the Server header is added to the response
AddType MIME-type extension [extension] ...svdhB
Maps the given filename extensions onto the specified content type
Alias URL-path file-path|directory-pathsvB
Maps URLs to filesystem locations
AliasMatch regex file-path|directory-pathsvB
Maps URLs to filesystem locations using regular expressions
Allow from all|host|env=env-variable [host|env=env-variable] ...dhB
Controls which hosts can access an area of the server
AllowCONNECT port [port] ... 443 563 svE
Ports that are allowed to CONNECT through the proxy
AllowEncodedSlashes On|Off|NoDecode Off svC
Determines whether encoded path separators in URLs are allowed to be passed through
AllowOverride All|None|directive-type [directive-type] ... All dC
Types of directives that are allowed in .htaccess files
Anonymous user [user] ...dhE
Specifies userIDs that are allowed access without password verification
Anonymous_LogEmail On|Off On dhE
Sets whether the password entered will be logged in the error log
Anonymous_MustGiveEmail On|Off On dhE
Specifies whether blank passwords are allowed
Anonymous_NoUserID On|Off Off dhE
Sets whether the userID field may be empty
Anonymous_VerifyEmail On|Off Off dhE
Sets whether to check the password field for a correctly formatted email address
AuthBasicAuthoritative On|Off On dhB
Sets whether authorization and authentication are passed to lower level modules
AuthBasicProvider provider-name [provider-name] ... file dhB
Sets the authentication provider(s) for this location
AuthDBMGroupFile file-pathdhE
Sets the name of the database file containing the list of user groups for authorization
AuthDBMType default|SDBM|GDBM|NDBM|DB default dhE
Sets the type of database file that is used to store passwords
AuthDBMUserFile file-pathdhE
Sets the name of a database file containing the list of users and passwords for authentication
AuthDefaultAuthoritative On|Off On dhB
Sets whether authentication is passed to lower level modules
AuthDigestAlgorithm MD5|MD5-sess MD5 dhX
Selects the algorithm used to calculate the challenge and response hashes in digest authentication
AuthDigestDomain URI [URI] ...dhX
URIs that are in the same protection space for digest authentication
AuthDigestNcCheck On|Off Off sX
Enables or disables checking of the nonce-count sent by the server
AuthDigestNonceFormat formatdhX
Determines how the nonce is generated
AuthDigestNonceLifetime seconds 300 dhX
How long the server nonce is valid
AuthDigestProvider provider-name [provider-name] ... file dhX
Sets the authentication provider(s) for this location
AuthDigestQop none|auth|auth-int [auth|auth-int] auth dhX
Determines the quality-of-protection to use in digest authentication
AuthDigestShmemSize size 1000 sX
The amount of shared memory to allocate for keeping track of clients
AuthGroupFile file-pathdhB
Sets the name of a text file containing the list of user groups for authorization
AuthLDAPBindDN distinguished-namedhE
Optional DN to use in binding to the LDAP server
AuthLDAPBindPassword passworddhE
Password used in conjuction with the bind DN
AuthLDAPCharsetConfig file-pathsE
Language to charset conversion configuration file
AuthLDAPCompareDNOnServer on|off on dhE
Use the LDAP server to compare the DNs
AuthLDAPDereferenceAliases never|searching|finding|always Always dhE
When will the module de-reference aliases
AuthLDAPGroupAttribute attribute member uniqueMember +dhE
LDAP attributes used to identify the user members of groups.
AuthLDAPGroupAttributeIsDN on|off on dhE
Use the DN of the client username when checking for group membership
AuthLDAPMaxSubGroupDepth Number 10 dhE
Specifies the maximum sub-group nesting depth that will be evaluated before the user search is discontinued.
AuthLDAPRemoteUserAttribute uiddhE
Use the value of the attribute returned during the user query to set the REMOTE_USER environment variable
AuthLDAPRemoteUserIsDN on|off off dhE
Use the DN of the client username to set the REMOTE_USER environment variable
AuthLDAPSubGroupAttribute attribute member uniqueMember +dhE
Specifies the attribute labels, multiple values per directive line, used to distinguish the members of the current group that are sub-groups.
AuthLDAPSubGroupClass LdapObjectClass groupOfNames groupO +dhE
Specifies which LDAP objectClass values identify directory objects that are groups during sub-group processing.
AuthLDAPURL url [NONE|SSL]dhE
URL specifying the LDAP search parameters
AuthName auth-domaindhC
Authorization realm for use in HTTP authentication
AuthType Basic|DigestdhC
Type of user authentication
AuthUserFile file-pathdhB
Sets the name of a text file containing the list of users and passwords for authentication
AuthzDBMAuthoritative On|Off On dhE
Sets whether authorization will be passed on to lower level modules
AuthzDBMType default|SDBM|GDBM|NDBM|DB default dhE
Sets the type of database file that is used to store list of user groups
AuthzDefaultAuthoritative On|Off On dhB
Sets whether authorization is passed to lower level modules
AuthzGroupFileAuthoritative On|Off On dhB
Sets whether authorization will be passed on to lower level modules
AuthzLDAPAuthoritative on|off on dhE
Prevent other authentication modules from authenticating the user if this one fails
AuthzUserAuthoritative On|Off On dhB
Sets whether authorization will be passed on to lower level modules
BalancerMember [balancerurl] url [key=value [key=value ...]]dE
Add a member to a load balancing group
BrowserMatch regex [!]env-variable[=value] [[!]env-variable[=value]] ...svdhB
Sets environment variables conditional on HTTP User-Agent
BrowserMatchNoCase regex [!]env-variable[=value] [[!]env-variable[=value]] ...svdhB
Sets environment variables conditional on User-Agent without respect to case
BufferedLogs On|Off Off sB
Buffer log entries in memory before writing to disk
CacheDefaultExpire seconds 3600 (one hour) svE
The default duration to cache a document when no expiry date is specified.
CacheDirLength length 2 svE
The number of characters in subdirectory names
CacheDirLevels levels 3 svE
The number of levels of subdirectories in the cache.
CacheDisable url-stringsvE
Disable caching of specified URLs
CacheEnable cache_type url-stringsvE
Enable caching of specified URLs using a specified storage manager
CacheFile file-path [file-path] ...sX
Cache a list of file handles at startup time
CacheIgnoreCacheControl On|Off Off svE
Ignore request to not serve cached content to client
CacheIgnoreHeaders header-string [header-string] ... None svE
Do not store the given HTTP header(s) in the cache.
CacheIgnoreNoLastMod On|Off Off svE
Ignore the fact that a response has no Last Modified header.
CacheIgnoreQueryString On|Off Off svE
Ignore query string when caching
CacheLastModifiedFactor float 0.1 svE
The factor used to compute an expiry date based on the LastModified date.
CacheMaxExpire seconds 86400 (one day) svE
The maximum time in seconds to cache a document
CacheMaxFileSize bytes 1000000 svE
The maximum size (in bytes) of a document to be placed in the cache
CacheMinFileSize bytes 1 svE
The minimum size (in bytes) of a document to be placed in the cache
CacheNegotiatedDocs On|Off Off svB
Allows content-negotiated documents to be cached by proxy servers
CacheRoot directorysvE
The directory root under which cache files are stored
CacheSkipAuthorizationCheck On|Off Off sE
Allows cached responses to be served to requests that contain an Authorization header WITHOUT performing any access control
CacheStoreNoStore On|Off Off svE
Attempt to cache requests or responses that have been marked as no-store.
CacheStorePrivate On|Off Off svE
Attempt to cache responses that the server has marked as private
CGIDocumentURIIgnoreDirIndex [on|off] off svdhC
Compatibility flag for DOCUMENT_URI and mod_dir
CGIDScriptTimeout time[s|ms]svdhB
The length of time to wait for more output from the CGI program
CGIMapExtension cgi-path .extensiondhC
Technique for locating the interpreter for CGI scripts
CGIScriptTimeout time[s|ms]svdhB
The length of time to wait for more output from the CGI program
CGISetDocumentNameToFullPath[on|off]svdhC
Set DOCUMENT_ROOT to the dirname of the requested file
CGISetDocumentRootToDirname [on|off] off svdhC
Set DOCUMENT_ROOT to the dirname of the requested file
CGISetDocumentVars [on|off] off svdhC
Set DOCUMENT_ROOT and DOCUMENT_NAME in CGI scripts
CharsetAutoindex fromcharset tocharsetsX
Configures charset translation of output of mod_autoindex
CharsetCompatDefault charset ISO8859-1 svdhX
CharsetCompat to translate into
CharsetCompatSourceEnc charset IBM1047 svdhX
Source charset of files
CharsetDefault charsetsvdhX
Charset to translate into
CharsetOptions option [option] ... DebugLevel=0 Implic +svdhX
Configures charset translation behavior
CharsetSourceEnc charsetsvdhX
Source charset of files
CheckCaseOnly on|off Off svdhE
Limits the action of the speling module to case corrections
CheckSpelling on|off Off svdhE
Enables the spelling module
ContentDigest On|Off Off svdhC
Enables the generation of Content-MD5 HTTP Response headers
CookieDomain domainsvdhE
The domain to which the tracking cookie applies
CookieExpires expiry-periodsvdhE
Expiry time for the tracking cookie
CookieLog filenamesvB
Sets filename for the logging of cookies
CookieName token Apache svdhE
Name of the tracking cookie
CookieStyle Netscape|Cookie|Cookie2|RFC2109|RFC2965 Netscape svdhE
Format of the cookie header field
CookieTracking on|off off svdhE
Enables tracking cookie
CoreDumpDirectory directorysM
Directory where Apache attempts to switch before dumping core
CustomLog file|pipe format|nickname [env=[!]environment-variable]svB
Sets filename and format of log file
Dav On|Off|provider-name Off dE
Enable WebDAV HTTP methods
DavDepthInfinity on|off off svdE
Allow PROPFIND, Depth: Infinity requests
DavGenericLockDB file-pathsvdE
Location of the DAV lock database
DavLockDB file-pathsvE
Location of the DAV lock database
DavMinTimeout seconds 0 svdE
Minimum amount of time the server holds a lock on a DAV resource
DBDExptime time-in-secondssvE
Keepalive time for idle connections
DBDKeep numbersvE
Maximum sustained number of connections
DBDMax numbersvE
Maximum number of connections
DBDMin numbersvE
Minimum number of connections
DBDParams param1=value1[,param2=value2]svE
Parameters for database connection
DBDPersist On|OffsvE
Whether to use persistent connections
DBDPrepareSQL "SQL statement" labelsvE
Define an SQL prepared statement
DBDriver namesvE
Specify an SQL driver
DefaultIcon url-pathsvdhB
Icon to display for files when no specific icon is configured
DefaultLanguage MIME-langsvdhB
Sets all files in the given scope to the specified language
DefaultType MIME-type|none text/plain svdhC
MIME content-type that will be sent if the server cannot determine a type in any other way
DeflateBufferSize value 8096 svE
Fragment size to be compressed at one time by zlib
DeflateCompressionLevel valuesvE
How much compression do we apply to the output
DeflateFilterNote [type] notenamesvE
Places the compression ratio in a note for logging
DeflateInflateLimitRequestBodyvaluesvdhE
Maximum size of inflated request bodies
DeflateInflateRatioBurst valuesvdhE
Maximum number of times the inflation ratio for request bodies can be crossed
DeflateInflateRatioLimit valuesvdhE
Maximum inflation ratio for request bodies
DeflateMemLevel value 9 svE
How much memory should be used by zlib for compression
DeflateWindowSize value 15 svE
Zlib compression window size
Deny from all|host|env=env-variable [host|env=env-variable] ...dhB
Controls which hosts are denied access to the server
DGWScriptCompat [on|off] off svdhC
Set all DGW CGI-related compatibility flags
<Directory directory-path> ... </Directory>svC
Enclose a group of directives that apply only to the named file-system directory and sub-directories
DirectoryIndex local-url [local-url] ... index.html svdhB
List of resources to look for when the client requests a directory
<DirectoryMatch regex> ... </DirectoryMatch>svC
Enclose directives that apply to file-system directories matching a regular expression and their subdirectories
DirectorySlash On|Off On svdhB
Toggle trailing slash redirects on or off
DocumentRoot directory-path /usr/local/apache/h +svC
Directory that forms the main document tree visible from the web
EnableExceptionHook On|Off Off sM
Enables a hook that runs exception handlers after a crash
EnableMMAP On|Off On svdhC
Use memory-mapping to read files during delivery
EnableSendfile On|Off On svdhC
Use the kernel sendfile support to deliver files to the client
ErrorDocument error-code documentsvdhC
What the server will return to the client in case of an error
ErrorLog file-path|syslog[:facility] logs/error_log (Uni +svC
Location where the server will log errors
ExamplesvdhX
Demonstration directive to illustrate the Apache module API
ExpiresActive On|OffsvdhE
Enables generation of Expires headers
ExpiresByType MIME-type <code>secondssvdhE
Value of the Expires header configured by MIME type
ExpiresDefault <code>secondssvdhE
Default algorithm for calculating expiration time
ExtendedStatus On|Off Off sB
Keep track of extended status information for each request
ExtFilterDefine filtername parameterssE
Define an external filter
ExtFilterOptions option [option] ... DebugLevel=0 NoLogS +dE
Configure mod_ext_filter options
FileETag component ... INode MTime Size svdhC
File attributes used to create the ETag HTTP response header
<Files filename> ... </Files>svdhC
Contains directives that apply to matched filenames
<FilesMatch regex> ... </FilesMatch>svdhC
Contains directives that apply to regular-expression matched filenames
FilterChain [+=-@!]filter-name ...svdhB
Configure the filter chain
FilterDeclare filter-name [type]svdhB
Declare a smart filter
FilterProtocol filter-name [provider-name] proto-flagssvdhB
Deal with correct HTTP protocol handling
FilterProvider filter-name provider-name [req|resp|env]=dispatch matchsvdhB
Register a content filter
FilterTrace filter-name levelsvdB
Get debug/diagnostic information from mod_filter
ForceLanguagePriority None|Prefer|Fallback [Prefer|Fallback] Prefer svdhB
Action to take if a single acceptable document is not found
ForceType MIME-type|NonedhC
Forces all matching files to be served with the specified MIME content-type
GlobalLogfile|pipe format|nickname [env=[!]environment-variable| expr=expression]sB
Sets filename and format of log file
GracefulShutDownTimeout secondssM
Specify a timeout after which a gracefully shutdown server will exit.
Group unix-group #-1 sM
Group under which the server will answer requests
Header [condition] set|setifempty|append|add|unset|unset*|echo|edit|edit* header [value] [early|env=[!]variable]svdhE
Configure HTTP response headers
HeaderName filenamesvdhB
Name of the file that will be inserted at the top of the index listing
HostnameLookups On|Off|Double Off svdC
Enables DNS lookups on client IP addresses
HttpProtocolOptions [Strict|Unsafe] [RegisteredMethods|LenientMethods] [Allow0.9|Require1.0] [AllowEmptyFoldedLines|DenyEmptyFoldedLines] Strict LenientMetho +svC
Modify restrictions on HTTP Request Messages
<IfDefine [!]parameter-name> ... </IfDefine>svdhC
Encloses directives that will be processed only if a test is true at startup
<IfFile [!]parameter-name> ... </IfFile>svdhC
Encloses directives that will be processed only if file exists at startup
<IfModule [!]module-file|module-identifier> ... </IfModule>svdhC
Encloses directives that are processed conditional on the presence or absence of a specific module
<IfVersion [[!]operator] version> ... </IfVersion>svdhE
contains version dependent configuration
IHSDrainKeepaliveConnectionsDuringShutdown [on|off] OFF sM
Set graceful process termination options
ImapBase map|referer|URL http://servername/ svdhB
Default base for imagemap files
ImapDefault error|nocontent|map|referer|URL nocontent svdhB
Default action when an imagemap is called with coordinates that are not explicitly mapped
ImapMenu none|formatted|semiformatted|unformattedsvdhB
Action if no coordinates are given when calling an imagemap
Include file-path|directory-pathsvdC
Includes other configuration files from within the server configuration files
IndexIgnore file [file] ...svdhB
Adds to the list of files to hide when listing a directory
IndexOptions [+|-]option [[+|-]option] ...svdhB
Various configuration settings for directory indexing
IndexOrderDefault Ascending|Descending Name|Date|Size|Description Ascending Name svdhB
Sets the default ordering of the directory index
IndexStyleSheet url-pathsvdhB
Adds a CSS stylesheet to the directory index
KeepAlive On|Off On svC
Enables HTTP persistent connections
KeepAliveTimeout num[ms] 5 svC
Amount of time the server will wait for subsequent requests on a persistent connection
KeepAliveTimeoutDelay num[ms] 200ms sC
Amount of time the server will wait past the KeepAliveTimeout before closing the persistent connection
KeyFile /path/to/key.kdb [/prompt] | /saf [owner/]saf-keyring-name svE
Identifies the keyfile containing certificates and private keys.
LanguagePriority MIME-lang [MIME-lang] ...svdhB
The precendence of language variants for cases where the client does not express a preference
LDAPBindTimeoutseconds 0 sE
Specifies the maximum amount of time for a LDAP bind operation to complete
LDAPCacheEntries number 1024 sE
Maximum number of entries in the primary LDAP cache
LDAPCacheTTL seconds 600 sE
Time that cached items remain valid
LDAPConnectionTimeout seconds 0 sE
Specifies the socket connection timeout in seconds
LDAPOpCacheEntries number 1024 sE
Number of entries used to cache LDAP compare operations
LDAPOpCacheTTL seconds 600 sE
Time that entries in the operation cache remain valid
LDAPReferralHopLimit number 5 dhE
The maximum number of referral hops to chase before terminating an LDAP query.
LDAPReferrals On|Off On dhE
Enable referral chasing during queries to the LDAP server.
LDAPRetries number-of-retries 4 (3 on Windows) sE
Configures the number of LDAP server retries.
LDAPSearchTimeout seconds 10 svE
Specifies the number of seconds that an LDAP search request should wait for a response from the LDAP server before timing out.
LDAPSharedCacheFile directory-path/filenamesE
Sets the shared memory cache file
LDAPSharedCacheSize bytessE
Size in bytes of the shared-memory cache
LDAPTrustedClientCert type label svdhE
Sets the label referring to a per connection client certificate.
LDAPTrustedGlobalCert type key_database_name [password]sE
Sets the file or database containing global trusted Certificate Authority and/or global client certificates
LDAPTrustedMode typesvE
Specifies the SSL mode to be used when connecting to an LDAP server.
LDAPVerifyServerCert On|Off On sE
Force server certificate verification
<Limit method [method] ... > ... </Limit>svdhC
Restrict enclosed access controls to only certain HTTP methods
<LimitExcept method [method] ... > ... </LimitExcept>svdhC
Restrict access controls to all HTTP methods except the named ones
LimitInternalRecursion number [number] 10 svC
Determine maximum number of internal redirects and nested subrequests
LimitRequestBody bytes 0 svdhC
Restricts the total size of the HTTP request body sent from the client
LimitRequestFields number 100 sC
Limits the number of HTTP request header fields that will be accepted from the client
LimitRequestFieldsize bytessC
Limits the size of the HTTP request header allowed from the client
LimitRequestLine bytes 8190 sC
Limit the size of the HTTP request line that will be accepted from the client
LimitXMLRequestBody bytes 1000000 svdhC
Limits the size of an XML-based request body
Listen [IP-address:]portnumber [protocol]sM
IP addresses and ports that the server listens to
ListenBacklog backlogsM
Maximum length of the queue of pending connections
LoadFile filename [filename] ...sE
Link in the named object file or library
LoadModule module filenamesE
Links in the object file or library, and adds to the list of active modules
<Location URL-path|URL> ... </Location>svC
Applies the enclosed directives only to matching URLs
<LocationMatch regex> ... </LocationMatch>svC
Applies the enclosed directives only to regular-expression matching URLs
LockFile filename logs/accept.lock sM
Location of the accept serialization lock file
LogFormat format|nickname [nickname] "%h %l %u %t \"%r\" +svB
Describes a format for use in a log file
LogIOTrackTTFB ON|OFF OFF svdhE
Enable tracking of time to first byte (TTFB)
LogIOTrackTTFB ON|OFF OFF svdhE
Enable tracking of time to first byte (TTFB)
LogLevel level warn svC
Controls the verbosity of the ErrorLog
MaxClients numbersM
Maximum number of child processes that will be created to serve requests
MaxKeepAliveRequests number 100 svC
Number of requests allowed on a persistent connection
MaxMemFree KBytes 0 sM
Maximum amount of memory that the main allocator is allowed to hold without calling free()
MaxRequestsPerChild number 10000 sM
Limit on the number of requests that an individual child server will handle during its life
MaxSpareThreads numbersM
Maximum number of idle threads
MCacheMaxObjectCount value 1009 sE
The maximum number of objects allowed to be placed in the cache
MCacheMaxObjectSize bytes 10000 sE
The maximum size (in bytes) of a document allowed in the cache
MCacheMaxStreamingBuffer size_in_bytes the smaller of 1000 +sE
Maximum amount of a streamed response to buffer in memory before declaring the response uncacheable
MCacheMinObjectSize bytes 1 sE
The minimum size (in bytes) of a document to be allowed in the cache
MCacheRemovalAlgorithm LRU|GDSF GDSF sE
The algorithm used to select documents for removal from the cache
MCacheSize KBytes 100 sE
The maximum amount of memory used by the cache in KBytes
MergeSlashes ON|OFF ON svC
Controls whether the server merges consecutive slashes in URLs.
MergeTrailers [on|off] off svC
Determins whether trailers are merged into headers
MetaDir directory .web svdhE
Name of the directory to find CERN-style meta information files
MetaFiles on|off off svdhE
Activates CERN meta-file processing
MetaSuffix suffix .meta svdhE
File name suffix for the file containg CERN-style meta information
MimeMagicFile file-pathsvE
Enable MIME-type determination based on file contents using the specified magic file
MinSpareThreads numbersM
Minimum number of idle threads available to handle request spikes
MMapFile file-path [file-path] ...sX
Map a list of files into memory at startup time
ModMimeUsePathInfo On|Off Off dB
Tells mod_mime to treat path_info components as part of the filename
MPMStatsBusyThreshold ratio 0.9 sE
Sets threshold for "approaching MaxClients..." notice
MPMStatsSystemLog ON|OFF OFF sE
Copies "approacing MaxClients..." notice to z/OS system log
MultiviewsMatch Any|NegotiatedOnly|Filters|Handlers [Handlers|Filters] NegotiatedOnly svdhB
The types of files that will be included when searching for a matching file with MultiViews
MVSDS ON|OFFdE
Enables serving MVS datasets for the enclosing location
MvsdsAlternateHtmlSniff OFF|ONdE
Specifies whether this module will use alternate rules when sniffing if a file is an HTML file or not.
MvsdsDefaultTextType media-type|nonedE
Specify a default media type to assign to response content for which no other media type configuration could be found
MVSDSIndexes ON|OFFdE
Configures generated directory indexes of partitioned data sets
MvsdsNoBinarySniff OFF|ONdE
Specifies whether this module will try to determine if a type-less file is binary
NameVirtualHost addr[:port]sC
Designates an IP address for name-virtual hosting
NetTrace [keyword val]...svE
Configures one or more capture specifications
NetTraceFile filesystem-pathsvE
Configures an external trace file
NoProxy host [host] ...svE
Hosts, domains, or networks that will be connected to directly
Options [+|-]option [[+|-]option] ... All svdhC
Configures what features are available in a particular directory
Order ordering Deny,Allow dhB
Controls the default access state and the order in which Allow and Deny are evaluated.
PassEnv env-variable [env-variable] ...svdhB
Passes environment variables from the shell
PidFile filename logs/httpd.pid sM
File where the server records the process ID of the daemon
<Proxy wildcard-url> ...</Proxy>svE
Container for directives applied to proxied resources
ProxyBadHeader IsError|Ignore|StartBody IsError svE
Determines how to handle bad header lines in a response
ProxyBlock *|word|host|domain [word|host|domain] ...svE
Words, hosts, or domains that are banned from being proxied
ProxyDomain DomainsvE
Default domain name for proxied requests
ProxyErrorOverride On|Off Off svE
Override error pages for proxied content
ProxyFtpDirCharset character set ISO-8859-1 svdE
Define the character set for proxied FTP listings
ProxyFtpEscapeWildcards [on|off]svdE
Whether wildcards in requested filenames are escaped when sent to the FTP server
ProxyFtpListOnWildcard [on|off]svdE
Whether wildcards in requested filenames trigger a file listing
ProxyIOBufferSize bytes 8192 svE
Determine size of internal data throughput buffer
<ProxyMatch regex> ...</ProxyMatch>svE
Container for directives applied to regular-expression-matched proxied resources
ProxyMaxForwards number -1 svE
Maximium number of proxies that a request can be forwarded through
ProxyPass [path] !|url [key=value key=value ...]] [nocanon] [interpolate]svdE
Maps remote servers into the local server URL-space
ProxyPassInterpolateEnv On|Off Off svdE
Enable Environment Variable interpolation in Reverse Proxy configurations
ProxyPassMatch [regex] !|url [key=value [key=value ...]]svdE
Maps remote servers into the local server URL-space using regular expressions
ProxyPassReverse [path] url [interpolate]svdE
Adjusts the URL in HTTP response headers sent from a reverse proxied server
ProxyPassReverseCookieDomain internal-domain public-domain [interpolate]svdE
Adjusts the Domain string in Set-Cookie headers from a reverse- proxied server
ProxyPassReverseCookiePath internal-path public-path [interpolate]svdE
Adjusts the Path string in Set-Cookie headers from a reverse- proxied server
ProxyPreserveHost On|Off Off svE
Use incoming Host HTTP request header for proxy request
ProxyReceiveBufferSize bytes 0 svE
Network buffer size for proxied HTTP and FTP connections
ProxyRemote match remote-serversvE
Remote proxy used to handle certain requests
ProxyRemoteMatch regex remote-serversvE
Remote proxy used to handle requests matched by regular expressions
ProxyRequests On|Off Off svE
Enables forward (standard) proxy requests
ProxySet url key=value [key=value ...]dE
Set various Proxy balancer or member parameters
ProxyStatus Off|On|Full Off svE
Show Proxy LoadBalancer status in mod_status
ProxyTimeout secondssvE
Network timeout for proxied requests
ProxyVia On|Off|Full|Block Off svE
Information provided in the Via HTTP response header for proxied requests
ReadmeName filenamesvdhB
Name of the file that will be inserted at the end of the index listing
ReceiveBufferSize bytes 0 sM
TCP receive buffer size
Redirect [status] URL-path URLsvdhB
Sends an external redirect asking the client to fetch a different URL
RedirectMatch [status] regex URLsvdhB
Sends an external redirect based on a regular expression match of the current URL
RedirectPermanent URL-path URLsvdhB
Sends an external permanent redirect asking the client to fetch a different URL
RedirectTemp URL-path URLsvdhB
Sends an external temporary redirect asking the client to fetch a different URL
RemoveCharset extension [extension] ...vdhB
Removes any character set associations for a set of file extensions
RemoveEncoding extension [extension] ...vdhB
Removes any content encoding associations for a set of file extensions
RemoveHandler extension [extension] ...vdhB
Removes any handler associations for a set of file extensions
RemoveInputFilter extension [extension] ...vdhB
Removes any input filter associations for a set of file extensions
RemoveLanguage extension [extension] ...vdhB
Removes any language associations for a set of file extensions
RemoveOutputFilter extension [extension] ...vdhB
Removes any output filter associations for a set of file extensions
RemoveType extension [extension] ...vdhB
Removes any content type associations for a set of file extensions
ReportInterval #-of-seconds 600 sE
Configures the interval for writing thread statistics
RequestHeader set|setifempty|append|add|unset|unset*|edit|edit* header [value] [replacement] [early|env=[!]variable]svdhE
Configure HTTP request headers
RequestReadTimeout [header=timeout[[-maxtimeout],MinRate=rate] [body=timeout[[-maxtimeout],MinRate=rate] svE
Set timeout values for receiving request headers and body from client.
Require entity-name [entity-name] ...dhC
Selects which authenticated users can access a resource
RewriteBase URL-pathdhE
Sets the base URL for per-directory rewrites
RewriteCond TestString CondPatternsvdhE
Defines a condition under which rewriting will take place
RewriteEngine on|off off svdhE
Enables or disables runtime rewriting engine
RewriteLock file-pathsE
Sets the name of the lock file used for RewriteMap synchronization
RewriteLog file-pathsvE
Sets the name of the file used for logging rewrite engine processing
RewriteLogLevel Level 0 svE
Sets the verbosity of the log file used by the rewrite engine
RewriteMap MapName MapType:MapSource svE
Defines a mapping function for key-lookup
RewriteOptions OptionssvdhE
Sets some special options for the rewrite engine
RewriteRule Pattern Substitution [flags]svdhE
Defines rules for the rewriting engine
RLimitCPU seconds|max [seconds|max]svdhC
Limits the CPU consumption of processes launched by Apache children
RLimitMEM bytes|max [bytes|max]svdhC
Limits the memory consumption of processes launched by Apache children
RLimitNPROC number|max [number|max]svdhC
Limits the number of processes that can be launched by processes launched by Apache children
Satisfy Any|All All dhC
Interaction between host-level access control and user authentication
ScoreBoardFile file-path logs/apache_status sM
Location of the file used to store coordination data for the child processes
Script method cgi-scriptsvdB
Activates a CGI script for a particular request method.
ScriptAlias URL-path file-path|directory-pathsvB
Maps a URL to a filesystem location and designates the target as a CGI script
ScriptAliasMatch regex file-path|directory-pathsvB
Maps a URL to a filesystem location using a regular expression and designates the target as a CGI script
ScriptInterpreterSource Registry|Registry-Strict|Script Script svdhC
Technique for locating the interpreter for CGI scripts
ScriptLog file-pathsvB
Location of the CGI script error logfile
ScriptLogBuffer bytes 1024 svB
Maximum amount of PUT or POST requests that will be recorded in the scriptlog
ScriptLogLength bytes 10385760 svB
Size limit of the CGI script logfile
ScriptSock file-path logs/cgisock sB
The filename prefix of the socket to use for communication with the cgi daemon
SeeRequestTail On|Off Off sB
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.
SendBufferSize bytes 0 sM
TCP buffer size
ServerAdmin email-address|URLsvC
Email address that the server includes in error messages sent to the client
ServerAlias hostname [hostname] ...vC
Alternate names for a host used when matching requests to name-virtual hosts
ServerLimit numbersM
Upper limit on configurable number of processes
ServerName [scheme://]fully-qualified-domain-name[:port]svC
Hostname and port that the server uses to identify itself
ServerPath URL-pathvC
Legacy URL pathname for a name-based virtual host that is accessed by an incompatible browser
ServerRoot directory-path /usr/local/apache sC
Base directory for the server installation
ServerSignature On|Off|EMail Off svdhC
Configures the footer on server-generated documents
ServerTokens Major|Minor|Min[imal]|Prod[uctOnly]|OS|Full Full sC
Configures the Server HTTP response header
ServiceDescription descsM
Appends to the description of the Windows service.
SetEnv env-variable valuesvdhB
Sets environment variables
SetEnvIf attribute regex [!]env-variable[=value] [[!]env-variable[=value]] ...svdhB
Sets environment variables based on attributes of the request
SetEnvIfNoCase attribute regex [!]env-variable[=value] [[!]env-variable[=value]] ...svdhB
Sets environment variables based on attributes of the request without respect to case
SetHandler handler-name|NonesvdhC
Forces all matching files to be processed by a handler
SetInputFilter filter[;filter...]svdhC
Sets the filters that will process client requests and POST input
SetOutputFilter filter[;filter...]svdhC
Sets the filters that will process responses from the server
SlowThreshold seconds | millisecondsmssE
Sets a trigger for modules exceeding a specific timeout
SMFLogDebug ON|OFFdE
Enables debugging
SMFRecord ON|OFFdE
Enables SMF recording of per-request details
SMFReportInterval secondssE
Enables SMF reporting of mpmstats data
SSIEnableAccess on|off off dhB
Enable the -A flag during conditional flow control processing.
SSIEndTag tag "-->" svB
String that ends an include element
SSIErrorMsg message "[an error occurred +svdhB
Error message displayed when there is an SSI error
SSIOptions option ... DollarSignExpansion +dB
Configure SSI options.
SSIStartTag tag "<!--#" svB
String that starts an include element
SSITimeFormat formatstring "%A, %d-%b-%Y %H:%M +svdhB
Configures the format in which date strings are displayed
SSIUndefinedEcho string "(none)" svdhB
String displayed when an unset variable is echoed
SSLAttributeSet [proxy:]gskit-id val [ENUM|NUMERIC|BUFF|BUFFNULL]vE
Directly configures underlying GSKit security library settings.
SSLCheckCertificateExpiration days|-1 ["no_expired"]svE
Checks for expired or expiring certificates at startup.
SSLCipherSpec [ALL|SSLv2|SSLv3|TLSv10|TLSv11|TLSv12] [+|-]cipher-shortname|[+|-]cipher-longname ...svE
Determines which SSL ciphers should be permitted.
SSLCipherSpec cipher-shortname|cipher-longnamesvE
Determines which SSL ciphers should be permitted.
SSLClientAuth none|optional|required|required_reset none svE
Configures IBM HTTP Server to request a client certificate from the browser
SSLCompression ON|OFF OFF vE
Controls server-side support for TLS Compression
SSLDisablesvE
DisablesSSL for the enclosing virtual host
SSLEnablesvE
Enables SSL for the enclosing virtual host
SSLFatalErrorLimit failures 0 vE
Gracefully terminates a process reporting too many fatal handshake errors
SSLFIPSDisable svE
Configures an SSL enabled virtual host to NOT use FIPS 140-2 certified ciphers
SSLFIPSEnablesvE
Configures an SSL enabled virtual host to use FIPS 140-2 certified ciphers
SSLHandshakeTimeout IO-timeout [end-to-end timeout[ms]]vE
Configures timeout on handshake operations
SSLOCSPCacheSize elementsvE
Enables OCSP caching and specifies the maximum number of elements in the cache.
SSLOCSPConnectionTimeout seconds 5 vE
Enables connect() timeout on outobuund OCSP connections
SSLOCSPEnablevE
The SSLOCSPEnable directive enables checking of client certificates through OCSP responders defined in the Authority Information Access (AIA) extension of their certificate.
SSLOCSPResponderURL fully-qualified-urlvE
The SSLOCSPResponderURL directive enables checking of client certificates through a statically configured online certificate status protocol (OCSP) responder.
SSLProtocolDisable SSLv2|SSLv3|TLSv10|TLSv11|TLSv12 ...vE
The SSLProtocolDisable directive allows you to disable individual SSL protocols.
SSLProtocolEnable SSLv2|SSLv3|TLSv10|TLSv11|TLSv12 ...vE
The SSLProtocolEnable directive allows you to enable individual SSL protocols.
SSLProxyEngine on|off offnone svE
Adds SSL support to outgoing reverse proxy connections
SSLRenegotiation on|off|LEGACY_AND_RFC5746 off vE
Controls IBM HTTP Server support of TLS renegotiation
SSLServerCert [cryptograhic token name:]label-name [[cryptograhic token name:]label-name]svE
Identifies the certificate label of a personal certificate that the server should use to authenticate to clients.
SSLSkipCloseNotif ON|OFFsvE
Flag to disable sending a TLS close_notify during Apache socket shutdown
SSLStrictCBCPaddingCheck off|onsE
Enable/Disable strict CBC Padding
SSLSuiteBMode 128|192svE
Enables the "Suite B" profile for the enclosing virtual host
SSLTracesvE
Enables extended tracing for SSL communication
SSLUnknownRevocationStatus ignore|log|log_always|deny ignore vE
Specifies how IBM HTTP Server reacts when IBM HTTP Server cannot readily determine the revocation status, which is coming through CRL or OCSP.
SSLVersion SSLv2|SSLv3|TLSv1|TLSv1.1|TLSv1.2dE
Performs access control based on negotiated TLS version
StartServers numbersM
Number of child server processes created at startup
StartThreads numbersM
Number of threads created on startup
SuexecUserGroup User GroupsvE
User and group permissions for CGI programs
SuppressXPadHeader On | Off Off svC
Prevent the X-Pad header from being added to responses.
ThreadLimit numbersM
Sets the upper limit on the configurable number of threads per child process
ThreadsPerChild numbersM
Number of threads created by each child process
ThreadStackSize sizesM
The size in bytes of the stack used by threads handling client connections
TimeOut seconds 300 svC
Amount of time the server will wait for certain events before failing a request
TLS13Options option[=value] [option[=value] ...]svE
General purpose directive to configure options for the TLSv1.3 protocol.
TraceEnable [on|off|extended] on (IBM HTTP Server +svC
Determines the behaviour on TRACE requests
TrackHooks allhooks | post_read_request | check_userid | check_user_access | auth_checker | handler sE
Enables reporting of time spent in individual Apache phases
TrackHooksOptions millis|permodule|logslow|notice|alloptssE
Enables more detailed tracking of hooks
TrackModules ON|OFFsE
Enables reporting of individual modules busy on a thread
TransferLog file|pipesvB
Specify location of a log file
TypesConfig file-path conf/mime.types sB
The location of the mime.types file
UnsetEnv env-variable [env-variable] ...svdhB
Removes variables from the environment
UseCanonicalName On|Off|DNS Off svdC
Configures how the server determines its own name and port
UseCanonicalPhysicalPort On|Off Off svdC
Configures how the server determines its own name and port
User unix-userid #-1 sM
The userid under which the server will answer requests
UserDir directory-filenamesvB
Location of the user-specific directories
VirtualDocumentRoot interpolated-directory|none none svE
Dynamically configure the location of the document root for a given virtual host
VirtualDocumentRootIP interpolated-directory|none none svE
Dynamically configure the location of the document root for a given virtual host
<VirtualHost addr[:port] [addr[:port]] ...> ... </VirtualHost>sC
Contains directives that apply only to a specific hostname or IP address
VirtualScriptAlias interpolated-directory|none none svE
Dynamically configure the location of the CGI directory for a given virtual host
VirtualScriptAliasIP interpolated-directory|none none svE
Dynamically configure the location of the cgi directory for a given virtual host
Win32DisableAcceptExsM
Use accept() rather than AcceptEx() to accept network connections
wlmCollectionName coll-name CNNONE svdE
Specifies the WLM collection name for matching requests
wlmSubSysType subsystem-name SSNONE sE
Specifies the WLM subsystem type
wlmTranClass class-namesvdE
Specifies the WLM transaction class for matching requests
XBitHack on|off|full off svdhB
Parse SSI directives in files with the execute bit set
ZosConsoleOptions OptionssvdhE
Sets some special options for the zos_cmds module.