Modules | Directives | FAQ | Glossary | Sitemap | Report a bug

Apache HTTP Server Version 2.4

Apache > HTTP Server > Documentation > Version 2.4 > 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 column shows the default value of the directive, if a default exists. If the default is too large to display, it will be truncated and 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  |  Q  |  R  |  S  |  T  |  U  |  V  |  W  |  X

s server config v virtual host d directory h .htaccess p proxy section

C Core M MPM B Base E Extension X Experimental T External

AcceptFilter protocol accept_filter		s	C
Configures optimizations for a Protocol's Listener 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 encoding 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 language-tag 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...] media-type [media-type] ...		svdh	B
assigns an output filter to a particular media-type
AddType media-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
AliasPreservePath OFF|ON	OFF	svd	B
Map the full path after the alias in a location.
Allow from all|host|env=[!]env-variable [host|env=[!]env-variable] ...		dh	D
Controls which hosts can access an area of the server
AllowCONNECT port[-port] [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
AllowMethods reset|HTTP-method [HTTP-method]...	reset	d	X
Restrict access to the listed HTTP methods
AllowOverride All|None|directive-type [directive-type] ...	None	d	C
Types of directives that are allowed in .htaccess files
AllowOverrideList None|directive [directive] ...	None	d	C
Individual 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
AsyncRequestWorkerFactor factor		s	M
Limit concurrent connections per process
AuthBasicAuthoritative On|Off	On	dh	B
Sets whether authorization and authentication are passed to lower level modules
AuthBasicFake off|username [password]		dh	B
Fake basic authentication using the given expressions for username and password
AuthBasicProvider provider-name [provider-name] ...	file	dh	B
Sets the authentication provider(s) for this location
AuthBasicUseDigestAlgorithm MD5|Off	Off	dh	B
Check passwords against the authentication providers as if Digest Authentication was in force instead of Basic Authentication.
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
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
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
AuthFormAuthoritative On|Off	On	dh	B
Sets whether authorization and authentication are passed to lower level modules
AuthFormBody fieldname	httpd_body	d	B
The name of a form field carrying the body of the request to attempt on successful login
AuthFormDisableNoStore On|Off	Off	d	B
Disable the CacheControl no-store header on the login page
AuthFormFakeBasicAuth On|Off	Off	d	B
Fake a Basic Authentication header
AuthFormLocation fieldname	httpd_location	d	B
The name of a form field carrying a URL to redirect to on successful login
AuthFormLoginRequiredLocation url		d	B
The URL of the page to be redirected to should login be required
AuthFormLoginSuccessLocation url		d	B
The URL of the page to be redirected to should login be successful
AuthFormLogoutLocation uri		d	B
The URL to redirect to after a user has logged out
AuthFormMethod fieldname	httpd_method	d	B
The name of a form field carrying the method of the request to attempt on successful login
AuthFormMimetype fieldname	httpd_mimetype	d	B
The name of a form field carrying the mimetype of the body of the request to attempt on successful login
AuthFormPassword fieldname	httpd_password	d	B
The name of a form field carrying the login password
AuthFormProvider provider-name [provider-name] ...	file	dh	B
Sets the authentication provider(s) for this location
AuthFormSitePassphrase secret		d	B
Bypass authentication checks for high traffic sites
AuthFormSize size	8192	d	B
The largest size of the form in bytes that will be parsed for the login details
AuthFormUsername fieldname	httpd_username	d	B
The name of a form field carrying the login username
AuthGroupFile file-path		dh	B
Sets the name of a text file containing the list of user groups for authorization
AuthLDAPAuthorizePrefix prefix	AUTHORIZE_	dh	E
Specifies the prefix for environment variables set during authorization
AuthLDAPBindAuthoritative off|on	on	dh	E
Determines if other authentication providers are used when a user can be mapped to a DN but the server cannot successfully bind with the user's credentials.
AuthLDAPBindDN distinguished-name		dh	E
Optional DN to use in binding to the LDAP server
AuthLDAPBindPassword password		dh	E
Password used in conjunction with the bind DN
AuthLDAPCharsetConfig file-path		s	E
Language to charset conversion configuration file
AuthLDAPCompareAsUser on|off	off	dh	E
Use the authenticated user's credentials to perform authorization comparisons
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
AuthLDAPInitialBindAsUser off|on	off	dh	E
Determines if the server does the initial DN lookup using the basic authentication users' own username, instead of anonymously or with hard-coded credentials for the server
AuthLDAPInitialBindPattern regex substitution	(.*) $1 (remote use +	dh	E
Specifies the transformation of the basic authentication username to be used when binding to the LDAP server to perform a DN lookup
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
AuthLDAPSearchAsUser on|off	off	dh	E
Use the authenticated user's credentials to perform authorization searches
AuthLDAPSubGroupAttribute attribute	member uniqueMember +	dh	E
Specifies the attribute labels, one value per directive line, used to distinguish the members of the current group that are 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|TLS|STARTTLS]		dh	E
URL specifying the LDAP search parameters
AuthMerging Off | And | Or	Off	dh	B
Controls the manner in which each configuration section's authorization logic is combined with that of preceding configuration sections.
AuthName auth-domain		dh	B
Authorization realm for use in HTTP authentication
AuthnCacheContext directory|server|custom-string	directory	d	B
Specify a context string for use in the cache key
AuthnCacheEnable		s	B
Enable Authn caching configured anywhere
AuthnCacheProvideFor authn-provider [...]		dh	B
Specify which authn provider(s) to cache for
AuthnCacheSOCache provider-name[:provider-args]		s