Directive Quick Reference - Apache HTTP Server

Apache Server 2.0

previous page next page

Apache > HTTP Server > Documentation > Version 2.0 > 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

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`		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_Authoritative On\|Off	Off	dh	E
Configures if authorization will fall-through to other methods
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
AssignUserID `user-id` `group-id`		v	M
Tie a virtual host to a user and group ID
AuthAuthoritative On\|Off	On	dh	B
Sets whether authorization and authentication are passed to lower level modules
AuthDBMAuthoritative On\|Off	On	dh	E
Sets whether authentication and authorization will be passed on to lower level modules
AuthDBMGroupFile `file-path`		dh	E
Sets the name of the database file containing the list of user groups for authentication
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 thename of a database file containing the list of users and passwords for authentication
AuthDigestAlgorithm MD5\|MD5-sess	MD5	dh	X
Selects the algorithm used to calculate the challenge and response hases in digest authentication
AuthDigestDomain `URI` [`URI`] ...		dh	X
URIs that are in the same protection space for digest authentication
AuthDigestFile `file-path`		dh	X
Location of the text file containing the list of users and encoded passwords for digest authentication
AuthDigestGroupFile `file-path`		dh	X
Name of the text file containing the list of groups 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
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 authentication
AuthLDAPAuthoritative on\|off	on	dh	X
Prevent other authentication modules from authenticating the user if this one fails
AuthLDAPBindDN distinguished-name		dh	X
Optional DN to use in binding to the LDAP server
AuthLDAPBindPassword password		dh	X
Password used in conjuction with the bind DN
AuthLDAPCharsetConfig file-path		s	X
Language to charset conversion configuration file
AuthLDAPCompareDNOnServer on\|off	on	dh	X
Use the LDAP server to compare the DNs
AuthLDAPDereferenceAliases never\|searching\|finding\|always	Always	dh	X
When will the module de-reference aliases
AuthLDAPEnabled on\|off	on	dh	X
Turn on or off LDAP authentication
AuthLDAPFrontPageHack on\|off	off	dh	X
Allow LDAP authentication to work with MS FrontPage
AuthLDAPGroupAttribute attribute		dh	X
LDAP attributes used to check for group membership
AuthLDAPGroupAttributeIsDN on\|off	on	dh	X
Use the DN of the client username when checking for group membership
AuthLDAPRemoteUserIsDN on\|off	off	dh	X
Use the DN of the client username to set the REMOTE_USER environment variable
AuthLDAPUrl url		dh	X
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
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
BS2000Account `account`		s	M
Define the non-privileged account on BS2000 machines
BufferedLogs On\|Off	Off	s	B
Buffer log entries in memory before writing to disk
CacheDefaultExpire `seconds`	3600 (one hour)	sv	X
The default duration to cache a document when no expiry date is specified.
CacheDirLength `length`	2	sv	X
The number of characters in subdirectory names
CacheDirLevels `levels`	3	sv	X
The number of levels of subdirectories in the cache.
CacheDisable `url-string`		sv	X
Disable caching of specified URLs
CacheEnable `cache_type` `url-string`		sv	X
Enable caching of specified URLs using a specified storage manager
CacheExpiryCheck On\|Off	On	sv	X
Indicates if the cache observes Expires dates when seeking files
CacheFile `file-path` [`file-path`] ...		s	X
Cache a list of file handles at startup time
CacheForceCompletion `Percentage`	60	sv	X
Percentage of document served, after which the server will complete caching the file even if the request is cancelled.
CacheGcClean `hours` `url-string`	?	sv	X
The time to retain unchanged cached files that match a URL
CacheGcDaily `time`	?	sv	X
The recurring time each day for garbage collection to be run. (24 hour clock)
CacheGcInterval `hours`		sv	X
The interval between garbage collection attempts.
CacheGcMemUsage `KBytes`	?	sv	X
The maximum kilobytes of memory used for garbage collection
CacheGcUnused `hours` `url-string`	?	sv	X
The time to retain unreferenced cached files that match a URL.
CacheIgnoreCacheControl On\|Off	Off	sv	X
Ignore the fact that the client requested the content not be cached.
CacheIgnoreHeaders `header-string` [`header-string`] ...	None	sv	X
Do not store the given HTTP header(s) in the cache.
CacheIgnoreNoLastMod On\|Off	Off	sv	X
Ignore the fact that a response has no Last Modified header.
CacheLastModifiedFactor `float`	0.1	sv	X
The factor used to compute an expiry date based on the LastModified date.
CacheMaxExpire `seconds`	86400 (one day)	sv	X
The maximum time in seconds to cache a document
CacheMaxFileSize `bytes`	1000000	sv	X
The maximum size (in bytes) of a document to be placed in the cache
CacheMinFileSize `bytes`	1	sv	X
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	X
The directory root under which cache files are stored
CacheSize `KBytes`	1000000	sv	X
The maximum amount of disk space that will be used by the cache in KBytes
CacheTimeMargin `?`	?	sv	X
The minimum time margin to cache a document
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
CheckSpelling on\|off	Off	svdh	E
Enables the spelling module
ChildPerUserID `user-id` `group-id` `num-children`		s	M
Specify user ID and group ID for a number of child processes
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
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
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`	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	X
Dump all input data to the error log
DumpIOOutput On\|Off	Off	s	X
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
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
Group `unix-group`	#-1	s	M
Group under which the server will answer requests
Header [`condition`] set\|append\|add\|unset\|echo `header` [`value`] [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	C
Enables logging of the RFC1413 identity of the remote user
<IfDefine [!]`parameter-name`> ... </IfDefine>		svdh	C
Encloses directives that will be processed only if a test is true at startup
<IfModule [!]`module-name`> ... </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
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 `seconds`	15	sv	C
Amount of time the server will wait for subsequent requests on a persistent connection
LanguagePriority `MIME-lang` [`MIME-lang`] ...		svdh	B
The precendence of language variants for cases where the client does not express a preference
LDAPCacheEntries `number`	1024	s	X
Maximum number of entries in the primary LDAP cache
LDAPCacheTTL `seconds`	600	s	X
Time that cached items remain valid
LDAPConnectionTimeout `seconds`		s	X
Specifies the socket connection timeout in seconds
LDAPOpCacheEntries `number`	1024	s	X
Number of entries used to cache LDAP compare operations
LDAPOpCacheTTL `seconds`	600	s	X
Time that entries in the operation cache remain valid
LDAPSharedCacheFile `directory-path/filename`		s	X
Sets the shared memory cache file
LDAPSharedCacheSize `bytes`	102400	s	X
Size in bytes of the shared-memory cache
LDAPTrustedCA `directory-path/filename`		s	X
Sets the file containing the trusted Certificate Authority certificate or database
LDAPTrustedCAType `type`		s	X
Specifies the type of the Certificate Authority file
<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	sv	C
Limits the number of HTTP request header fields that will be accepted from the client
LimitRequestFieldsize `bytes`		sv	C
Limits the size of the HTTP request header allowed from the client
LimitRequestLine `bytes`	8190	sv	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`		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
LogLevel `level`	warn	sv	C
Controls the verbosity of the ErrorLog
MaxClients `number`		s	M
Maximum number of connections that will be processed simultaneously
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()`
MaxRanges default \| unlimited \| none \| `number-of-ranges`	200	svd	C
Number of ranges allowed before returning the complete resource
MaxRequestsPerChild `number`	10000	s	M
Limit on the number of requests that an individual child server will handle during its life
MaxRequestsPerThread `number`	0	s	M
Limit on the number of requests that an individual thread will handle during its life
MaxSpareServers `number`	10	s	M
Maximum number of idle child server processes
MaxSpareThreads `number`		s	M
Maximum number of idle threads
MaxThreads `number`	2048	s	M
Set the maximum number of worker threads
MaxThreadsPerChild `number`	64	s	M
Maximum number of threads per child process
MCacheMaxObjectCount `value`	1009	s	X
The maximum number of objects allowed to be placed in the cache
MCacheMaxObjectSize `bytes`	10000	s	X
The maximum size (in bytes) of a document allowed in the cache
MCacheMaxStreamingBuffer `size_in_bytes`	the smaller of 1000 +	s	X
Maximum amount of a streamed response to buffer in memory before declaring the response uncacheable
MCacheMinObjectSize `bytes`	0	s	X
The minimum size (in bytes) of a document to be allowed in the cache
MCacheRemovalAlgorithm LRU\|GDSF	GDSF	s	X
The algorithm used to select documents for removal from the cache
MCacheSize `KBytes`	100	s	X
The maximum amount of memory used by the cache in KBytes
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
MinSpareServers `number`	5	s	M
Minimum number of idle child server processes
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
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
NameVirtualHost `addr`[:`port`]		s	C
Designates an IP address for name-virtual hosting
NoProxy `host` [`host`] ...		sv	E
Hosts, domains, or networks that will be connected to directly
NumServers `number`	2	s	M
Total number of children alive at the same time
NWSSLTrustedCerts `filename` [`filename`] ...		s	B
List of additional client certificates
NWSSLUpgradeable [`IP-address`:]`portnumber`		s	B
Allows a connection to be upgraded to an SSL connection upon request
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
ProtocolEcho On\|Off	Off	sv	X
Turn the echo server on or off
<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
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`	10	sv	E
Maximium number of proxies that a request can be forwarded through
ProxyPass [`path`] !\|`url`		svd	E
Maps remote servers into the local server URL-space
ProxyPassReverse [`path`] `url`		svd	E
Adjusts the URL in HTTP response headers sent 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
ProxyTimeout `seconds`	300	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
RequestHeader set\|append\|add\|unset `header` [`value` [env=[!]`variable`]]		svdh	E
Configure HTTP request headers
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`	MaxRedirects=10	svdh	E
Sets some special options for the rewrite engine
RewriteRule Pattern Substitution		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	sv	B
The name of the socket to use for communication with the cgi daemon
SecureListen [`IP-address`:]`portnumber` `Certificate-Name` [MUTUAL]		s	B
Enables SSL encryption for the specified port
SendBufferSize `bytes`	0	s	M
TCP buffer size
ServerAdmin `email-address`		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 `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
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
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
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)"	sv	B
String displayed when an unset variable is echoed
SSLCACertificateFile file-path		sv	E
File of concatenated PEM-encoded CA Certificates for Client Auth
SSLCACertificatePath directory-path		sv	E
Directory of PEM-encoded CA Certificates for Client Auth
SSLCARevocationFile file-path		sv	E
File of concatenated PEM-encoded CA CRLs for Client Auth
SSLCARevocationPath directory-path		sv	E
Directory of PEM-encoded CA CRLs for Client Auth
SSLCertificateChainFile file-path		sv	E
File of PEM-encoded Server CA Certificates
SSLCertificateFile file-path		sv	E
Server PEM-encoded X.509 Certificate file
SSLCertificateKeyFile file-path		sv	E
Server PEM-encoded Private Key file
SSLCipherSuite cipher-spec	ALL:!ADH:RC4+RSA:+H +	svdh	E
Cipher Suite available for negotiation in SSL handshake
SSLEngine on\|off	off	sv	E
SSL Engine Operation Switch
SSLHonorCipherOrder flag		sv	E
Option to prefer the server's cipher preference order
SSLInsecureRenegotiation flag	off	sv	E
Option to enable support for insecure renegotiation
SSLMutex type	none	s	E
Semaphore for internal mutual exclusion of operations
SSLOptions [+\|-]option ...		svdh	E
Configure various SSL engine run-time options
SSLPassPhraseDialog type	builtin	s	E
Type of pass phrase dialog for encrypted private keys
SSLProtocol [+\|-]protocol ...	all	sv	E
Configure usable SSL protocol flavors
SSLProxyCACertificateFile file-path		sv	E
File of concatenated PEM-encoded CA Certificates for Remote Server Auth
SSLProxyCACertificatePath directory-path		sv	E
Directory of PEM-encoded CA Certificates for Remote Server Auth
SSLProxyCARevocationFile file-path		sv	E
File of concatenated PEM-encoded CA CRLs for Remote Server Auth
SSLProxyCARevocationPath directory-path		sv	E
Directory of PEM-encoded CA CRLs for Remote Server Auth
SSLProxyCipherSuite cipher-spec	ALL:!ADH:RC4+RSA:+H +	svdh	E
Cipher Suite available for negotiation in SSL proxy handshake
SSLProxyEngine on\|off	off	sv	E
SSL Proxy Engine Operation Switch
SSLProxyMachineCertificateFile filename		s	E
File of concatenated PEM-encoded client certificates and keys to be used by the proxy
SSLProxyMachineCertificatePath directory		s	E
Directory of PEM-encoded client certificates and keys to be used by the proxy
SSLProxyProtocol [+\|-]protocol ...	all	sv	E
Configure usable SSL protocol flavors for proxy usage
SSLProxyVerify level	none	svdh	E
Type of remote server Certificate verification
SSLProxyVerifyDepth number	1	svdh	E
Maximum depth of CA Certificates in Remote Server Certificate verification
SSLRandomSeed context source [bytes]		s	E
Pseudo Random Number Generator (PRNG) seeding source
SSLRequire expression		dh	E
Allow access only when an arbitrarily complex boolean expression is true
SSLRequireSSL		dh	E
Deny access when SSL is not used for the HTTP request
SSLSessionCache type	none	s	E
Type of the global/inter-process SSL Session Cache
SSLSessionCacheTimeout seconds	300	sv	E
Number of seconds before an SSL session expires in the Session Cache
SSLUserName varname		sdh	E
Variable name to determine user name
SSLVerifyClient level	none	svdh	E
Type of Client Certificate verification
SSLVerifyDepth number	1	svdh	E
Maximum depth of CA Certificates in Client Certificate verification
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 for CGI programs to run as
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 `number`	65536	s	M
Determine the stack size for each thread
TimeOut `seconds`	300	sv	C
Amount of time the server will wait for certain events before failing a request
TraceEnable `[on\|off\|extended]`	on	s	C
Determines the behaviour on `TRACE` requests
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	On	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	public_html	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
XBitHack on\|off\|full	off	svdh	B
Parse SSI directives in files with the execute bit set

previous page start next page