Manuel Apache

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 
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
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
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 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
AuthDBDUserPWQuery query d E
SQL query to look up a password for a user
AuthDBDUserRealmQuery query d E
SQL query to look up a password hash for a user and realm.
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 E
Selects the algorithm used to calculate the challenge and response hashes in digest authentication
AuthDigestDomain URI [URI] ... dh E
URIs that are in the same protection space for digest authentication
AuthDigestNcCheck On|Off Off s E
Enables or disables checking of the nonce-count sent by the server
AuthDigestNonceFormat format dh E
Determines how the nonce is generated
AuthDigestNonceLifetime seconds 300 dh E
How long the server nonce is valid
AuthDigestProvider provider-name [provider-name] ... file dh E
Sets the authentication provider(s) for this location
AuthDigestQop none|auth|auth-int [auth|auth-int] auth dh E
Determines the quality-of-protection to use in digest authentication
AuthDigestShmemSize size 1000 s E
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 dh E
LDAP attributes used to check for group membership
AuthLDAPGroupAttributeIsDN on|off on dh E
Use the DN of the client username when checking for group membership
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
AuthLDAPUrl url [NONE|SSL|TLS|STARTTLS] dh E
URL specifying the LDAP search parameters
AuthName auth-domain dh C
Authorization realm for use in HTTP authentication
<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
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
AuthzOwnerAuthoritative On|Off On dh E
Sets whether authorization will be passed on to lower level modules
AuthzUserAuthoritative On|Off On dh B
Sets whether authorization will be passed on to lower level modules
BalancerMember 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
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
CGIMapExtension cgi-path .extension dh C
Technique for locating the interpreter for CGI scripts
CharsetDefault charset svdh X
Charset to translate into
CharsetOptions option [option] ... DebugLevel=0 NoImpl + 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
ChrootDir /path/to/directory s M
Directory for apache to run chroot(8) after startup.
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 300 sv E
Keepalive time for idle connections
DBDKeep number 2 sv E
Maximum sustained number of connections
DBDMax number 10 sv E
Maximum number of connections
DBDMin number 1 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
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
<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
DumpIOInput On|Off Off s E
Dump all input data to the error log
DumpIOLogLevel level debug s E
Controls the logging level of the DumpIO output
DumpIOOutput On|Off Off s E
Dump all output data to the error log
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
ForensicLog filename|pipe sv E
Sets filename of the forensic log
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|append|merge|add|unset|echo|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
IdentityCheck On|Off Off svd E
Enables logging of the RFC 1413 identity of the remote user
IdentityCheckTimeout seconds 30 svd E
Determines the timeout duration for ident requests
<IfDefine [!]parameter-name> ... </IfDefine> svdh C
Encloses directives that will be processed only if a test is true 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
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
ISAPIAppendLogToErrors on|off off svdh B
Record HSE_APPEND_LOG_PARAMETER requests from ISAPI extensions to the error log
ISAPIAppendLogToQuery on|off on svdh B
Record HSE_APPEND_LOG_PARAMETER requests from ISAPI extensions to the query field
ISAPICacheFile file-path [file-path] ... sv B
ISAPI .dll files to be loaded at startup
ISAPIFakeAsync on|off off svdh B
Fake asynchronous support for ISAPI callbacks
ISAPILogNotSupported on|off off svdh B
Log unsupported feature requests from ISAPI extensions
ISAPIReadAheadBuffer size 49152 svdh B
Size of the Read Ahead Buffer sent to ISAPI extensions
KeepAlive On|Off On sv C
Enables HTTP persistent connections
KeepAliveTimeout secon
Remonter Remonter