Modules | Directives | FAQ | Glossary | Sitemap

Apache HTTP Server Version 2.2

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

s server config v virtual host d directory h .htaccess

C Core M MPM B Base E Extension X Experimental

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

Copyright 2007 The Apache Software Foundation.
Licensed under the Apache License, Version 2.0.

Modules | Directives | FAQ | Glossary | Sitemap