+

Search Tips | Advanced Search

Modules | Directives | FAQ | Glossary | Sitemap

Apache HTTP Server Version 2.4

Apache > HTTP Server > Documentation > Version 2.4 > Modules

Directive Quick Reference

en | es | zh-cn

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
CCore
M MPM
BBase
E Extension
XExperimental
T External

Directive name and usage Default Context Status
AcceptFilter protocol accept_filter
Configure optimizations for a Protocol's Listener Sockets
s C
AcceptPathInfo On|Off|Default
Resources accept trailing pathname information
Default svdh C
AccessFileName filename [filename] ...
Name of the distributed configuration file
.htaccess sv C
Action action-type cgi-script [virtual]
Activates a CGI script for a particular handler or content-type
svdh B
AddAlt string file [file] ...
Alternate text to display for a file, instead of an icon selected by filename
svdh B
AddAltByEncoding string MIME-encoding [MIME-encoding] ...
Alternate text to display for a file instead of an icon selected by MIME-encoding
svdh B
AddAltByType string MIME-type [MIME-type] ...
Alternate text to display for a file, instead of an icon selected by MIME content-type
svdh B
AddCharset charset extension [extension] ...
Maps the given filename extensions to the specified content charset
svdh B
AddDefaultCharset On|Off|charset
Default charset parameter to be added when a response content-type is text/plain or text/html
Off svdh C
AddDescription string file [file] ...
Description to display for a file
svdh B
AddEncoding encoding extension [extension] ...
Maps the given filename extensions to the specified encoding type
svdh B
AddHandler handler-name extension [extension] ...
Maps the filename extensions to the specified handler
svdh B
AddIcon icon name [name] ...
Icon to display for a file selected by name
svdh B
AddIconByEncoding icon MIME-encoding [MIME-encoding] ...
Icon to display next to files selected by MIME content-encoding
svdh B
AddIconByType icon MIME-type [MIME-type] ...
Icon to display next to files selected by MIME content-type
svdh B
AddInputFilter filter[;filter...] extension [extension] ...
Maps filename extensions to the filters that will process client requests
svdh B
AddLanguage language-tag extension [extension] ...
Maps the given filename extension to the specified content language
svdh B
AddModuleInfo module-name string
Adds additional information to the module information displayed by the server-info handler
sv E
AddOutputFilter filter[;filter...] extension [extension] ...
Maps filename extensions to the filters that will process responses from the server
svdh B
AddOutputFilterByType filter[;filter...] media-type [media-type] ...
assigns an output filter to a particular media-type
svdh B
AddType media-type extension [extension] ...
Maps the given filename extensions onto the specified content type
svdh B
Alias [URL-path] file-path|directory-path
Maps URLs to filesystem locations
svd B
AliasMatch regex file-path|directory-path
Maps URLs to filesystem locations using regular expressions
sv B
Allow from all|host|env=[!]env-variable [host|env=[!]env-variable] ...
Controls which hosts can access an area of the server
dh E
AllowCONNECT port[-port] [port[-port]] ...
Ports that are allowed to CONNECT through the proxy
443 563 sv E
AllowEncodedSlashes On|Off|NoDecode
Determines whether encoded path separators in URLs are allowed to be passed through
Off sv C
AllowMethods reset|HTTP-method [HTTP-method]...
Restrict access to the listed HTTP methods
reset d X
AllowOverride All|None|directive-type [directive-type] ...
Types of directives that are allowed in .htaccess files
None (2.3.9 and lat +) d C
AllowOverrideList None|directive [directive-type] ...
Individual directives that are allowed in .htaccess files
None d C
Anonymous user [user] ...
Specifies userIDs that are allowed access without password verification
dh E
Anonymous_LogEmail On|Off
Sets whether the password entered will be logged in the error log
On dh E
Anonymous_MustGiveEmail On|Off
Specifies whether blank passwords are allowed
On dh E
Anonymous_NoUserID On|Off
Sets whether the userID field may be empty
Off dh E
Anonymous_VerifyEmail On|Off
Sets whether to check the password field for a correctly formatted email address
Off dh E
AsyncRequestWorkerFactor factor
Limit concurrent connections per process
s M
AuthBasicAuthoritative On|Off
Sets whether authorization and authentication are passed to lower level modules
On dh B
AuthBasicFake off|username [password]
Fake basic authentication using the given expressions for username and password
dh B
AuthBasicProvider provider-name [provider-name] ...
Sets the authentication provider(s) for this location
file dh B
AuthBasicUseDigestAlgorithm MD5|Off
Check passwords against the authentication providers as if Digest Authentication was in force instead of Basic Authentication.
Off dh B
AuthDBDUserPWQuery query
SQL query to look up a password for a user
d E
AuthDBDUserRealmQuery query
SQL query to look up a password hash for a user and realm.
d E
AuthDBMGroupFile file-path
Sets the name of the database file containing the list of user groups for authorization
dh E
AuthDBMType default|SDBM|GDBM|NDBM|DB
Sets the type of database file that is used to store passwords
default dh E
AuthDBMUserFile file-path
Sets the name of a database file containing the list of users and passwords for authentication
dh E
AuthDigestAlgorithm MD5|MD5-sess
Selects the algorithm used to calculate the challenge and response hashes in digest authentication
MD5 dh E
AuthDigestDomain URI [URI] ...
URIs that are in the same protection space for digest authentication
dh E
AuthDigestNonceLifetime seconds
How long the server nonce is valid
300 dh E
AuthDigestProvider provider-name [provider-name] ...
Sets the authentication provider(s) for this location
file dh E
AuthDigestQop none|auth|auth-int [auth|auth-int]
Determines the quality-of-protection to use in digest authentication
auth dh E
AuthDigestShmemSize size
The amount of shared memory to allocate for keeping track of clients
1000 s E
AuthFormAuthoritative On|Off
Sets whether authorization and authentication are passed to lower level modules
On dh B
AuthFormBody fieldname
The name of a form field carrying the body of the request to attempt on successful login
d B
AuthFormDisableNoStore On|Off
Disable the CacheControl no-store header on the login page
Off d B
AuthFormFakeBasicAuth On|Off
Fake a Basic Authentication header
Off d B
AuthFormLocation fieldname
The name of a form field carrying a URL to redirect to on successful login
d B
AuthFormLoginRequiredLocation url
The URL of the page to be redirected to should login be required
d B
AuthFormLoginSuccessLocation url
The URL of the page to be redirected to should login be successful
d B
AuthFormLogoutLocation uri
The URL to redirect to after a user has logged out
d B
AuthFormMethod fieldname
The name of a form field carrying the method of the request to attempt on successful login
d B
AuthFormMimetype fieldname
The name of a form field carrying the mimetype of the body of the request to attempt on successful login
d B
AuthFormPassword fieldname
The name of a form field carrying the login password
d B
AuthFormProvider provider-name [provider-name] ...
Sets the authentication provider(s) for this location
file dh B
AuthFormSitePassphrase secret
Bypass authentication checks for high traffic sites
d B
AuthFormSize size
The largest size of the form in bytes that will be parsed for the login details
d B
AuthFormUsername fieldname
The name of a form field carrying the login username
d B
AuthGroupFile file-path
Sets the name of a text file containing the list of user groups for authorization
dh B
AuthLDAPAuthorizePrefix prefix
Specifies the prefix for environment variables set during authorization
AUTHORIZE_ dh E
AuthLDAPBindAuthoritative off|on
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.
on dh E
AuthLDAPBindDN distinguished-name
Optional DN to use in binding to the LDAP server
dh E
AuthLDAPBindPassword password
Password used in conjunction with the bind DN
dh E
AuthLDAPCharsetConfig file-path
Language to charset conversion configuration file
s E
AuthLDAPCompareAsUser on|off
Use the authenticated user's credentials to perform authorization comparisons
off dh E
AuthLDAPCompareDNOnServer on|off
Use the LDAP server to compare the DNs
on dh E
AuthLDAPDereferenceAliases never|searching|finding|always
When will the module de-reference aliases
always dh E
AuthLDAPGroupAttribute attribute
LDAP attributes used to identify the user members of groups.
member uniquemember + dh E
AuthLDAPGroupAttributeIsDN on|off
Use the DN of the client username when checking for group membership
on dh E
AuthLDAPInitialBindAsUser off|on
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
off dh E
AuthLDAPInitialBindPattern regex substitution
Specifies the transformation of the basic authentication username to be used when binding to the LDAP server to perform a DN lookup
(.*) $1 (remote use + dh E
AuthLDAPMaxSubGroupDepth Number
Specifies the maximum sub-group nesting depth that will be evaluated before the user search is discontinued.
10 dh E
AuthLDAPRemoteUserAttribute uid
Use the value of the attribute returned during the user query to set the REMOTE_USER environment variable
dh E
AuthLDAPRemoteUserIsDN on|off
Use the DN of the client username to set the REMOTE_USER environment variable
off dh E
AuthLDAPSearchAsUser on|off
Use the authenticated user's credentials to perform authorization searches
off dh E
AuthLDAPSubGroupAttribute attribute
Specifies the attribute labels, one value per directive line, used to distinguish the members of the current group that are groups.
dh E
AuthLDAPSubGroupClass LdapObjectClass
Specifies which LDAP objectClass values identify directory objects that are groups during sub-group processing.
groupOfNames groupO + dh E
AuthLDAPUrl url [NONE|SSL|TLS|STARTTLS]
URL specifying the LDAP search parameters
dh E
AuthMerging Off | And | Or
Controls the manner in which each configuration section's authorization logic is combined with that of preceding configuration sections.
Off dh B
AuthName auth-domain
Authorization realm for use in HTTP authentication
dh B
AuthnCacheContext directory|server|custom-string
Specify a context string for use in the cache key
d B
AuthnCacheEnable
Enable Authn caching configured anywhere
s B
AuthnCacheProvideFor authn-provider [...]
Specify which authn provider(s) to cache for
dh B
AuthnCacheSOCache provider-name[:provider-args]
Select socache backend provider to use
s B
AuthnCacheTimeout timeout (seconds)
Set a timeout for cache entries
dh B
<AuthnProviderAlias baseProvider Alias> ... </AuthnProviderAlias>
Enclose a group of directives that represent an extension of a base authentication provider and referenced by the specified alias
s B
AuthnzFcgiCheckAuthnProvider provider-name|None option ...
Enables a FastCGI application to handle the check_authn authentication hook.
d E
AuthnzFcgiDefineProvider type provider-name backend-address
Defines a FastCGI application as a provider for authentication and/or authorization
s E
AuthType None|Basic|Digest|Form
Type of user authentication
dh B
AuthUserFile file-path
Sets the name of a text file containing the list of users and passwords for authentication
dh B
AuthzDBDLoginToReferer On|Off
Determines whether to redirect the Client to the Referring page on successful login or logout if a Referer request header is present
Off d E
AuthzDBDQuery query
Specify the SQL Query for the required operation
d E
AuthzDBDRedirectQuery query
Specify a query to look up a login page for the user
d E
AuthzDBMType default|SDBM|GDBM|NDBM|DB
Sets the type of database file that is used to store list of user groups
default dh E
<AuthzProviderAlias baseProvider Alias Require-Parameters> ... </AuthzProviderAlias>
Enclose a group of directives that represent an extension of a base authorization provider and referenced by the specified alias
s B
AuthzSendForbiddenOnFailure On|Off
Send '403 FORBIDDEN' instead of '401 UNAUTHORIZED' if authentication succeeds but authorization fails
Off dh B
BalancerGrowth #
Number of additional Balancers that can be added Post-configuration
5 sv E
BalancerInherit On|Off
Inherit ProxyPassed Balancers/Workers from the main server
On sv E
BalancerMember [balancerurl] url [key=value [key=value ...]]
Add a member to a load balancing group
d E
BalancerPersist On|Off
Attempt to persist changes made by the Balancer Manager across restarts.
Off sv E
BrotliAlterETag AddSuffix|NoChange|Remove
How the outgoing ETag header should be modified during compression
AddSuffix sv E
BrotliCompressionMaxInputBlock value
Maximum input block size
sv E
BrotliCompressionQuality value
Compression quality
5 sv E
BrotliCompressionWindow value
Brotli sliding compression window size
18 sv E
BrotliFilterNote [type] notename
Places the compression ratio in a note for logging
sv E
BrowserMatch regex [!]env-variable[=value] [[!]env-variable[=value]] ...
Sets environment variables conditional on HTTP User-Agent
svdh B
BrowserMatchNoCase regex [!]env-variable[=value] [[!]env-variable[=value]] ...
Sets environment variables conditional on User-Agent without respect to case
svdh B
BufferedLogs On|Off
Buffer log entries in memory before writing to disk
Off s B
BufferSize integer
Maximum size in bytes to buffer by the buffer filter
131072 svdh E
CacheDefaultExpire seconds
The default duration to cache a document when no expiry date is specified.
3600 (one hour) svdh E
CacheDetailHeader on|off
Add an X-Cache-Detail header to the response.
off svdh E
CacheDirLength length
The number of characters in subdirectory names
2 sv E
CacheDirLevels levels
The number of levels of subdirectories in the cache.
2 sv E
CacheDisable url-string | on
Disable caching of specified URLs
svdh E
CacheEnable cache_type [url-string]
Enable caching of specified URLs using a specified storage manager
svd E
CacheFile file-path [file-path] ...
Cache a list of file handles at startup time
s X
CacheHeader on|off
Add an X-Cache header to the response.
off svdh E
CacheIgnoreCacheControl On|Off
Ignore request to not serve cached content to client
Off sv E
CacheIgnoreHeaders header-string [header-string] ...
Do not store the given HTTP header(s) in the cache.
None sv E
CacheIgnoreNoLastMod On|Off
Ignore the fact that a response has no Last Modified header.
Off svdh E
CacheIgnoreQueryString On|Off
Ignore query string when caching
Off sv E
CacheIgnoreURLSessionIdentifiers identifier [identifier] ...
Ignore defined session identifiers encoded in the URL when caching
None sv E
CacheKeyBaseURL URL
Override the base URL of reverse proxied cache keys.
http://example.com sv E
CacheLastModifiedFactor float
The factor used to compute an expiry date based on the LastModified date.
0.1 svdh E
CacheLock on|off
Enable the thundering herd lock.
off sv E
CacheLockMaxAge integer
Set the maximum possible age of a cache lock.
5 sv E
CacheLockPath directory
Set the lock path directory.
/tmp/mod_cache-lock + sv E
CacheMaxExpire seconds
The maximum time in seconds to cache a document
86400 (one day) svdh E
CacheMaxFileSize bytes
The maximum size (in bytes) of a document to be placed in the cache
1000000 svdh E
CacheMinExpire seconds
The minimum time in seconds to cache a document
0 svdh E
CacheMinFileSize bytes
The minimum size (in bytes) of a document to be placed in the cache
1 svdh E
CacheNegotiatedDocs On|Off
Allows content-negotiated documents to be cached by proxy servers
Off sv B
CacheQuickHandler on|off
Run the cache from the quick handler.
on sv E
CacheReadSize bytes
The minimum size (in bytes) of the document to read and be cached before sending the data downstream
0 svdh E
CacheReadTime milliseconds
The minimum time (in milliseconds) that should elapse while reading before data is sent downstream
0 svdh E
CacheRoot directory
The directory root under which cache files are stored
sv E
CacheSocache type[:args]
The shared object cache implementation to use
sv E
CacheSocacheMaxSize bytes
The maximum size (in bytes) of an entry to be placed in the cache
102400 svdh E
CacheSocacheMaxTime seconds
The maximum time (in seconds) for a document to be placed in the cache
86400 svdh E
CacheSocacheMinTime seconds
The minimum time (in seconds) for a document to be placed in the cache
600 svdh E
CacheSocacheReadSize bytes
The minimum size (in bytes) of the document to read and be cached before sending the data downstream
0 svdh E
CacheSocacheReadTime milliseconds
The minimum time (in milliseconds) that should elapse while reading before data is sent downstream
0 svdh E
CacheStaleOnError on|off
Serve stale content in place of 5xx responses.
on svdh E
CacheStoreExpired On|Off
Attempt to cache responses that the server reports as expired
Off svdh E
CacheStoreNoStore On|Off
Attempt to cache requests or responses that have been marked as no-store.
Off svdh E
CacheStorePrivate On|Off
Attempt to cache responses that the server has marked as private
Off svdh E
CGIDScriptTimeout time[s|ms]
The length of time to wait for more output from the CGI program
svdh B
CGIMapExtension cgi-path .extension
Technique for locating the interpreter for CGI scripts
dh C
CGIPassAuth On|Off
Enables passing HTTP authorization headers to scripts as CGI variables
Off dh C
CGIVar variable rule
Controls how some CGI variables are set
dh C
CharsetDefault charset
Charset to translate into
svdh E
CharsetOptions option [option] ...
Configures charset translation behavior
ImplicitAdd svdh E
CharsetSourceEnc charset
Source charset of files
svdh E
CheckCaseOnly on|off
Limits the action of the speling module to case corrections
Off svdh E
CheckSpelling on|off
Enables the spelling module
Off svdh E
ChrootDir /path/to/directory
Directory for apache to run chroot(8) after startup.
s B
ContentDigest On|Off
Enables the generation of Content-MD5 HTTP Response headers
Off svdh C
CookieDomain domain
The domain to which the tracking cookie applies
svdh E
CookieExpires expiry-period
Expiry time for the tracking cookie
svdh E
CookieName token
Name of the tracking cookie
Apache svdh E
CookieStyle Netscape|Cookie|Cookie2|RFC2109|RFC2965
Format of the cookie header field
Netscape svdh E
CookieTracking on|off
Enables tracking cookie
off svdh E
CoreDumpDirectory directory
Directory where Apache HTTP Server attempts to switch before dumping core
s M
CustomLog file|pipe format|nickname [env=[!]environment-variable| expr=expression]
Sets filename and format of log file
sv B
Dav On|Off|provider-name
Enable WebDAV HTTP methods
Off d E
DavDepthInfinity on|off
Allow PROPFIND, Depth: Infinity requests
off svd E
DavGenericLockDB file-path
Location of the DAV lock database
svd E
DavLockDB file-path
Location of the DAV lock database
sv E
DavMinTimeout seconds
Minimum amount of time the server holds a lock on a DAV resource
0 svd E
DBDExptime time-in-seconds
Keepalive time for idle connections
300 sv E
DBDInitSQL "SQL statement"
Execute an SQL statement after connecting to a database
sv E
DBDKeep number
Maximum sustained number of connections
2 sv E
DBDMax number
Maximum number of connections
10 sv E
DBDMin number
Minimum number of connections
1 sv E
DBDParams param1=value1[,param2=value2]
Parameters for database connection
sv E
DBDPersist On|Off
Whether to use persistent connections
sv E
DBDPrepareSQL "SQL statement" label
Define an SQL prepared statement
sv E
DBDriver name
Specify an SQL driver
sv E
DefaultIcon url-path
Icon to display for files when no specific icon is configured
svdh B
DefaultLanguage language-tag
Defines a default language-tag to be sent in the Content-Language header field for all resources in the current context that have not been assigned a language-tag by some other means.
svdh B
DefaultRuntimeDir directory-path
Base directory for the server run-time files
DEFAULT_REL_RUNTIME + s C
DefaultType media-type|none
This directive has no effect other than to emit warnings if the value is not none. In prior versions, DefaultType would specify a default media type to assign to response content for which no other media type configuration could be found.
none svdh C
Define parameter-name [parameter-value]
Define a variable
svd C
DeflateBufferSize value
Fragment size to be compressed at one time by zlib
8096 sv E
DeflateCompressionLevel value
How much compression do we apply to the output
sv E
DeflateFilterNote [type] notename
Places the compression ratio in a note for logging
sv E
DeflateInflateLimitRequestBodyvalue
Maximum size of inflated request bodies
svdh E
DeflateInflateRatioBurst value
Maximum number of times the inflation ratio for request bodies can be crossed
svdh E
DeflateInflateRatioLimit value
Maximum inflation ratio for request bodies
svdh E
DeflateMemLevel value
How much memory should be used by zlib for compression
9 sv E
DeflateWindowSize value
Zlib compression window size
15 sv E
Deny from all|host|env=[!]env-variable [host|env=[!]env-variable] ...
Controls which hosts are denied access to the server
dh E
<Directory directory-path> ... </Directory>
Enclose a group of directives that apply only to the named file-system directory, sub-directories, and their contents.
sv C
DirectoryCheckHandler On|Off
Toggle how this module responds when another handler is configured
Off svdh B
DirectoryIndex disabled | local-url [local-url] ...
List of resources to look for when the client requests a directory
index.html svdh B
DirectoryIndexRedirect on | off | permanent | temp | seeother | 3xx-code
Configures an external redirect for directory indexes.
off svdh B
<DirectoryMatch regex> ... </DirectoryMatch>
Enclose directives that apply to the contents of file-system directories matching a regular expression.
sv C
DirectorySlash On|Off
Toggle trailing slash redirects on or off
On svdh B
DocumentRoot directory-path
Directory that forms the main document tree visible from the web
"/usr/local/apache/ + sv C
DTracePrivileges On|Off
Determines whether the privileges required by dtrace are enabled.
Off s X
DumpIOInput On|Off
Dump all input data to the error log
Off s E
DumpIOOutput On|Off
Dump all output data to the error log
Off s E
<Else ... </Else>
Contains directives that apply only if the condition of a previous <If or <ElseIf section is not satisfied by a request at runtime
svdh C
<ElseIf expression> ... </ElseIf>
Contains directives that apply only if a condition is satisfied by a request at runtime while the condition of a previous <If or <ElseIf section is not satisfied
svdh C
EnableExceptionHook On|Off
Enables a hook that runs exception handlers after a crash
Off s M
EnableMMAP On|Off
Use memory-mapping to read files during delivery
On svdh C
EnableSendfile On|Off
Use the kernel sendfile support to deliver files to the client
Off svdh C
Error message
Abort configuration parsing with a custom error message
svdh C
ErrorDocument error-code document
What the server will return to the client in case of an error
svdh C
ErrorLog file-path|syslog[:facility]
Location where the server will log errors
logs/error_log (Uni +) sv C
ErrorLogFormat [connection|request] format
Format specification for error log entries
sv C
Example
Demonstration directive to illustrate the Apache module API
svdh X
ExpiresActive On|Off
Enables generation of Expires headers
Off svdh E
ExpiresByType MIME-type <code>seconds
Value of the Expires header configured by MIME type
svdh E
ExpiresDefault <code>seconds
Default algorithm for calculating expiration time
svdh E
ExtendedStatus On|Off
Keep track of extended status information for each request
Off[*] s C
ExtFilterDefine filtername parameters
Define an external filter
s E
ExtFilterOptions option [option] ...
Configure mod_ext_filter options
NoLogStderr d E
FallbackResource disabled | local-url
Define a default URL for requests that don't map to a file
svdh B
FileETag component ...
File attributes used to create the ETag HTTP response header for static files
MTime Size svdh C
<Files filename> ... </Files>
Contains directives that apply to matched filenames
svdh C
<FilesMatch regex> ... </FilesMatch>
Contains directives that apply to regular-expression matched filenames
svdh C
FilterChain [+=-@!]filter-name ...
Configure the filter chain
svdh B
FilterDeclare filter-name [type]
Declare a smart filter
svdh B
FilterProtocol filter-name [provider-name] proto-flags
Deal with correct HTTP protocol handling
svdh B
FilterProvider filter-name provider-name expression
Register a content filter
svdh B
FilterTrace filter-name level
Get debug/diagnostic information from mod_filter
svd B
ForceLanguagePriority None|Prefer|Fallback [Prefer|Fallback]
Action to take if a single acceptable document is not found
Prefer svdh B
ForceType media-type|None
Forces all matching files to be served with the specified media type in the HTTP Content-Type header field
dh C
ForensicLog filename|pipe
Sets filename of the forensic log
sv E
GlobalLogfile|pipe format|nickname [env=[!]environment-variable| expr=expression]
Sets filename and format of log file
s B
GprofDir /tmp/gprof/|/tmp/gprof/%
Directory to write gmon.out profiling data to.
sv C
GracefulShutdownTimeout seconds
Specify a timeout after which a gracefully shutdown server will exit.
0 s M
Group unix-group
Group under which the server will answer requests
#-1 s B
H2CopyFiles on|off
Determine file handling in responses
off svdh E
H2Direct on|off
H2 Direct Protocol Switch
on for h2c, off for + sv E
H2EarlyHints on|off
Determine sending of 103 status codes
off sv E
H2MaxSessionStreams n
Maximum number of active streams per HTTP/2 session.
100 sv E
H2MaxWorkerIdleSeconds n
Maximum number of seconds h2 workers remain idle until shut down.
600 s E
H2MaxWorkers n
Maximum number of worker threads to use per child process.
s E
H2MinWorkers n
Minimal number of worker threads to use per child process.
s E
H2ModernTLSOnly on|off
Require HTTP/2 connections to be "modern TLS" only
on sv E
H2Push on|off
H2 Server Push Switch
on sv E
H2PushDiarySize n
H2 Server Push Diary Size
256 sv E
H2PushPriority mime-type [after|before|interleaved] [weight]
H2 Server Push Priority
* After 16 sv E
H2PushResource [add] path [critical]
Declares resources for early pushing to the client
svdh E
H2SerializeHeaders on|off
Serialize Request/Response Processing Switch
off sv E
H2StreamMaxMemSize bytes
Maximum amount of output data buffered per stream.
65536 sv E
H2TLSCoolDownSecs seconds
1 sv E
H2TLSWarmUpSize amount
-
1048576 sv E
H2Upgrade on|off
H2 Upgrade Protocol Switch
on for h2c, off for +sv E
H2WindowSize bytes
Size of Stream Window for upstream data.
65535 sv E
Header [condition] add|append|echo|edit|edit*|merge|set|setifempty|unset|note header [[expr=]value [replacement] [early|env=[!]varname|expr=expression]]
Configure HTTP response headers
svdh E
HeaderName filename
Name of the file that will be inserted at the top of the index listing
svdh B
HeartbeatAddress addr:port
Multicast address for heartbeat packets
s X
HeartbeatListenaddr:port
multicast address to listen for incoming heartbeat requests
s X
HeartbeatMaxServers number-of-servers
Specifies the maximum number of servers that will be sending heartbeat requests to this server
10 s X
HeartbeatStorage file-path
Path to store heartbeat data
logs/hb.dat s X
HeartbeatStorage file-path
Path to read heartbeat data
logs/hb.dat s X
HostnameLookups On|Off|Double
Enables DNS lookups on client IP addresses
Off svd C
HttpProtocolOptions [Strict|Unsafe] [RegisteredMethods|LenientMethods]
Modify restrictions on HTTP Request Messages [Allow0.9|Require1.0]
Strict LenientMetho +sv C
IdentityCheck On|Off
Enables logging of the RFC 1413 identity of the remote user
Off svd E
IdentityCheckTimeout seconds
Determines the timeout duration for ident requests
30 svd E
<If expression> ... </If>
Contains directives that apply only if a condition is satisfied by a request at runtime
svdh C
<IfDefine [!]parameter-name> ... </IfDefine>
Encloses directives that will be processed only if a test is true at startup
svdh C
<IfModule [!]module-file|module-identifier> ... </IfModule>
Encloses directives that are processed conditional on the presence or absence of a specific module
svdh C
<IfVersion [[!]operator] version> ... </IfVersion>
contains version dependent configuration
svdh E
ImapBase map|referer|URL
Default base for imagemap files
http://servername/ svdh B
ImapDefault error|nocontent|map|referer|URL
Default action when an imagemap is called with coordinates that are not explicitly mapped
nocontent svdh B
ImapMenu none|formatted|semiformatted|unformatted
Action if no coordinates are given when calling an imagemap
formatted svdh B
Include file-path|directory-path|wildcard
Includes other configuration files from within the server configuration files
svd C
IncludeOptional file-path|directory-path|wildcard
Includes other configuration files from within the server configuration files
svd C
IndexHeadInsert "markup ..."
Inserts text in the HEAD section of an index page.
svdh B
IndexIgnore file [file] ...
Adds to the list of files to hide when listing a directory
"." svdh B
IndexIgnoreReset ON|OFF
Empties the list of files to hide when listing a directory
svdh B
IndexOptions [+|-]option [[+|-]option] ...
Various configuration settings for directory indexing
svdh B
IndexOrderDefault Ascending|Descending Name|Date|Size|Description
Sets the default ordering of the directory index
Ascending Name svdh B
IndexStyleSheet url-path
Adds a CSS stylesheet to the directory index
svdh B
InputSed sed-command
Sed command to filter request data (typically POST data)
dh X
ISAPIAppendLogToErrors on|off
Record HSE_APPEND_LOG_PARAMETER requests from ISAPI extensions to the error log
off svdh B
ISAPIAppendLogToQuery on|off
Record HSE_APPEND_LOG_PARAMETER requests from ISAPI extensions to the query field
on svdh B
ISAPICacheFile file-path [file-path] ...
ISAPI .dll files to be loaded at startup
sv B
ISAPIFakeAsync on|off
Fake asynchronous support for ISAPI callbacks
off svdh B
ISAPILogNotSupported on|off
Log unsupported feature requests from ISAPI extensions
off svdh B
ISAPIReadAheadBuffer size
Size of the Read Ahead Buffer sent to ISAPI extensions
49152 svdh B
KeepAlive On|Off
Enables HTTP persistent connections
On sv C
KeepAliveTimeout num[ms]
Amount of time the server will wait for subsequent requests on a persistent connection
5 sv C
KeptBodySize maximum size in bytes
Keep the request body instead of discarding it up to the specified maximum size, for potential use by filters such as mod_include.
0 d B
LanguagePriority MIME-lang [MIME-lang] ...
The precedence of language variants for cases where the client does not express a preference
svdh B
LDAPCacheEntries number
Maximum number of entries in the primary LDAP cache
1024 s E
LDAPCacheTTL seconds
Time that cached items remain valid
600 s E
LDAPConnectionPoolTTL n
Discard backend connections that have been sitting in the connection pool too long
-1 sv E
LDAPConnectionTimeout seconds
Specifies the socket connection timeout in seconds
s E
LDAPLibraryDebug 7
Enable debugging in the LDAP SDK
s E
LDAPOpCacheEntries number
Number of entries used to cache LDAP compare operations
1024 s E
LDAPOpCacheTTL seconds
Time that entries in the operation cache remain valid
600 s E
LDAPReferralHopLimit number
The maximum number of referral hops to chase before terminating an LDAP query.
dh E
LDAPReferrals On|Off|default
Enable referral chasing during queries to the LDAP server.
On dh E
LDAPRetries number-of-retries
Configures the number of LDAP server retries.
3 s E
LDAPRetryDelay seconds
Configures the delay between LDAP server retries.
0 s E
LDAPSharedCacheFile directory-path/filename
Sets the shared memory cache file
s E
LDAPSharedCacheSize bytes
Size in bytes of the shared-memory cache
500000 s E
LDAPTimeout seconds
Specifies the timeout for LDAP search and bind operations, in seconds
60 s E
LDAPTrustedClientCert type directory-path/filename/nickname [password]
Sets the file containing or nickname referring to a per connection client certificate. Not all LDAP toolkits support per connection client certificates.
dh E
LDAPTrustedGlobalCert type directory-path/filename [password]
Sets the file or database containing global trusted Certificate Authority or global client certificates
s E
LDAPTrustedMode type
Specifies the SSL/TLS mode to be used when connecting to an LDAP server.
sv E
LDAPVerifyServerCert On|Off
Force server certificate verification
On s E
<Limit method [method] ... > ... </Limit>
Restrict enclosed access controls to only certain HTTP methods
dh C
<LimitExcept method [method] ... > ... </LimitExcept>
Restrict access controls to all HTTP methods except the named ones
dh C
LimitInternalRecursion number [number]
Determine maximum number of internal redirects and nested subrequests
10 sv C
LimitRequestBody bytes
Restricts the total size of the HTTP request body sent from the client
0 svdh C
LimitRequestFields number
Limits the number of HTTP request header fields that will be accepted from the client
100 sv C
LimitRequestFieldSize bytes
Limits the size of the HTTP request header allowed from the client
8190 sv C
LimitRequestLine bytes
Limit the size of the HTTP request line that will be accepted from the client
8190 sv C
LimitXMLRequestBody bytes
Limits the size of an XML-based request body
1000000 svdh C
Listen [IP-address:]portnumber [protocol]
IP addresses and ports that the server listens to
s M
ListenBacklog backlog
Maximum length of the queue of pending connections
s M
ListenCoresBucketsRatio ratio
Ratio between the number of CPU cores (online) and the number of listeners' buckets
0 (disabled) s M
LoadFile filename [filename] ...
Link in the named object file or library
sv E
LoadModule module filename
Links in the object file or library, and adds to the list of active modules
sv E
<Location URL-path|URL> ... </Location>
Applies the enclosed directives only to matching URLs
sv C
<LocationMatch regex> ... </LocationMatch>
Applies the enclosed directives only to regular-expression matching URLs
sv C
LogFormat format|nickname [nickname]
Describes a format for use in a log file
"%h %l %u %t \"%r\" +sv B
LogIOTrackTTFB ON|OFF
Enable tracking of time to first byte (TTFB)
OFF svdh E
LogLevel [module:]level [module:level] ...
Controls the verbosity of the ErrorLog
warn svd C
LogMessage message [hook=hook] [expr=expression]
Log user-defined message to error log
d X
LuaAuthzProvider provider_name /path/to/lua/script.lua function_name
Plug an authorization provider function into mod_authz_core
s X
LuaCodeCache stat|forever|never
Configure the compiled code cache.
stat svdh X
LuaHookAccessChecker /path/to/lua/script.lua hook_function_name [early|late]
Provide a hook for the access_checker phase of request processing
svdh X
LuaHookAuthChecker /path/to/lua/script.lua hook_function_name [early|late]
Provide a hook for the auth_checker phase of request processing
svdh X
LuaHookCheckUserID /path/to/lua/script.lua hook_function_name [early|late]
Provide a hook for the check_user_id phase of request processing
svdh X
LuaHookFixups /path/to/lua/script.lua hook_function_name
Provide a hook for the fixups phase of a request processing
svdh X
LuaHookInsertFilter /path/to/lua/script.lua hook_function_name
Provide a hook for the insert_filter phase of request processing
svdh X
LuaHookLog /path/to/lua/script.lua log_function_name
Provide a hook for the access log phase of a request processing
svdh X
LuaHookMapToStorage /path/to/lua/script.lua hook_function_name
Provide a hook for the map_to_storage phase of request processing
svdh X
LuaHookTranslateName /path/to/lua/script.lua hook_function_name [early|late]
Provide a hook for the translate name phase of request processing
sv X
LuaHookTypeChecker /path/to/lua/script.lua hook_function_name
Provide a hook for the type_checker phase of request processing
svdh X
LuaInherit none|parent-first|parent-last
Controls how parent configuration sections are merged into children
parent-first svdh X
LuaInputFilter filter_name /path/to/lua/script.lua function_name
Provide a Lua function for content input filtering
s X
LuaMapHandler uri-pattern /path/to/lua/script.lua [function-name]
Map a path to a lua handler
svdh X
LuaOutputFilter filter_name /path/to/lua/script.lua function_name
Provide a Lua function for content output filtering
s X
LuaPackageCPath /path/to/include/?.soa
Add a directory to lua's package.cpath
svdh X
LuaPackagePath /path/to/include/?.lua
Add a directory to lua's package.path
svdh X
LuaQuickHandler /path/to/script.lua hook_function_name
Provide a hook for the quick handler of request processing
sv X
LuaRoot /path/to/a/directory
Specify the base path for resolving relative paths for mod_lua directives
svdh X
LuaScope once|request|conn|thread|server [min] [max]
One of once, request, conn, thread -- default is once
once svdh X
<Macro name [par1 .. parN]> ... </Macro>
Define a configuration file macro
svd B
MaxConnectionsPerChild number
Limit on the number of connections that an individual child server will handle during its life
0 s M
MaxKeepAliveRequests number
Number of requests allowed on a persistent connection
100 sv C
MaxMemFree KBytes
Maximum amount of memory that the main allocator is allowed to hold without calling free()
2048 s M
MaxRangeOverlaps default | unlimited | none | number-of-ranges
Number of overlapping ranges (eg: 100-200,150-300) allowed before returning the complete resource
20 svd C
MaxRangeReversals default | unlimited | none | number-of-ranges
Number of range reversals (eg: 100-200,50-70) allowed before returning the complete resource
20 svd C
MaxRanges default | unlimited | none | number-of-ranges
Number of ranges allowed before returning the complete resource
200 svd C
MaxRequestWorkers number
Maximum number of connections that will be processed simultaneously
s M
MaxSpareServers number
Maximum number of idle child server processes
10 s M
MaxSpareThreads number
Maximum number of idle threads
s M
MaxThreads number
Set the maximum number of worker threads
2048 s M
MemcacheConnTTL num[units]
Keepalive time for idle connections
15s sv E
MergeTrailers [on|off]
Determines whether trailers are merged into headers
off sv C
MetaDir directory
Name of the directory to find CERN-style meta information files
.web svdh E
MetaFiles on|off
Activates CERN meta-file processing
off svdh E
MetaSuffix suffix
File name suffix for the file containing CERN-style meta information
.meta svdh E
MimeMagicFile file-path
Enable MIME-type determination based on file contents using the specified magic file
sv E
MinSpareServers number
Minimum number of idle child server processes
5 s M
MinSpareThreads number
Minimum number of idle threads available to handle request spikes
s M
MMapFile file-path [file-path] ...
Map a list of files into memory at startup time
s X
ModemStandard V.21|V.26bis|V.32|V.34|V.92
Modem standard to simulate
d X
ModMimeUsePathInfo On|Off
Tells mod_mime to treat path_info components as part of the filename
Off d B
MultiviewsMatch Any|NegotiatedOnly|Filters|Handlers [Handlers|Filters]
The types of files that will be included when searching for a matching file with MultiViews
NegotiatedOnly svdh B
Mutex mechanism [default|mutex-name] ... [OmitPID]
Configures mutex mechanism and lock file directory for all or specified mutexes
default s C
NameVirtualHost addr[:port]
DEPRECATED: Designates an IP address for name-virtual hosting
s C
NoProxy host [host] ...
Hosts, domains, or networks that will be connected to directly
sv E
NWSSLTrustedCerts filename [filename] ...
List of additional client certificates
s B
NWSSLUpgradeable [IP-address:]portnumber
Allows a connection to be upgraded to an SSL connection upon request
s B
Options [+|-]option [[+|-]option] ...
Configures what features are available in a particular directory
FollowSymlinks svdh C
Order ordering
Controls the default access state and the order in which Allow and Deny are evaluated.
Deny,Allow dh E
OutputSed sed-command
Sed command for filtering response content
dh X
PassEnv env-variable [env-variable] ...
Passes environment variables from the shell
svdh B
PidFile filename
File where the server records the process ID of the daemon
logs/httpd.pid s M
PrivilegesMode FAST|SECURE|SELECTIVE
Trade off processing speed and efficiency vs security against malicious privileges-aware code.
FAST svd X
Protocol protocol
Protocol for a listening socket
sv C
ProtocolEcho On|Off
Turn the echo server on or off
Off sv X
Protocols protocol ...
Protocols available for a server/virtual host
http/1.1 sv C
ProtocolsHonorOrder On|Off
Determines if order of Protocols determines precedence during negotiation
On sv C
<Proxy wildcard-url> ...</Proxy>
Container for directives applied to proxied resources
sv E
ProxyAddHeaders Off|On
Add proxy information in X-Forwarded-* headers
On svd E
ProxyBadHeader IsError|Ignore|StartBody
Determines how to handle bad header lines in a response
IsError sv E
ProxyBlock *|word|host|domain [word|host|domain] ...
Words, hosts, or domains that are banned from being proxied
sv E
ProxyDomain Domain
Default domain name for proxied requests
sv E
ProxyErrorOverride On|Off
Override error pages for proxied content
Off svd E
ProxyExpressDBMFile <pathname>
Pathname to DBM file.
sv E
ProxyExpressDBMFile <type>
DBM type of file.
sv E
ProxyExpressEnable [on|off]
Enable the module functionality.
sv E
ProxyFCGIBackendType FPM|GENERIC
Specify the type of backend FastCGI application
FPM svdh E
ProxyFCGISetEnvIf conditional-expression [!]environment-variable-name [value-expression]
a href="http://setgetweb.com/p/Apache24/mod/mod_access_compat.html#allow">Allow variables sent to FastCGI servers to be fixed up
svdh E
ProxyFtpDirCharset character set
Define the character set for proxied FTP listings
ISO-8859-1 svd E
ProxyFtpEscapeWildcards [on|off]
Whether wildcards in requested filenames are escaped when sent to the FTP server
svd E
ProxyFtpListOnWildcard [on|off]
Whether wildcards in requested filenames trigger a file listing
svd E
ProxyHCExpr name {ap_expr expression}
Creates a named condition expression to use to determine health of the backend based on its response.
sv E
ProxyHCTemplate name parameter=setting <...>
Creates a named template for setting various health check parameters
sv E
ProxyHCTPsize <size>
Sets the total server-wide size of the threadpool used for the health check workers.
s E
ProxyHTMLBufSize bytes
Sets the buffer size increment for buffering inline scripts and stylesheets.
svd B
ProxyHTMLCharsetOut Charset | *
ProxyHTMLDocType fpi [SGML|XML]
Specify a charset for mod_proxy_html output.
svd B
ProxyHTMLDocType HTML|XHTML [Legacy]
OR
Sets an HTML or XHTML document type declaration.
svd B
ProxyHTMLEnable On|Off
Turns the proxy_html filter on or off.
Off svd B
ProxyHTMLEvents attribute [attribute ...]
Specify attributes to treat as scripting events.
svd B
ProxyHTMLExtended On|Off
Determines whether to fix links in inline scripts, stylesheets, and scripting events.
Off svd B
ProxyHTMLFixups [lowercase] [dospath] [reset]
Fixes for simple HTML errors.
svd B
ProxyHTMLInterp On|Off
Enables per-request interpolation of ProxyHTMLURLMap rules.
Off svd B
ProxyHTMLLinks element attribute [attribute2 ...]
Specify HTML elements that have URL attributes to be rewritten.
svd B
ProxyHTMLMeta On|Off
Turns on or off extra pre-parsing of metadata in HTML <head> sections.
Off svd B
ProxyHTMLStripComments On|Off
Determines whether to strip HTML comments.
Off svd B
ProxyHTMLURLMap from-pattern to-pattern [flags] [cond]
Defines a rule to rewrite HTML links
svd B
ProxyIOBufferSize bytes
Determine size of internal data throughput buffer
8192 sv E
<ProxyMatch regex> ...</ProxyMatch>
Container for directives applied to regular-expression-matched proxied resources
sv E
ProxyMaxForwards number
Maximium number of proxies that a request can be forwarded through
-1 sv E
ProxyPass [path] !|url [key=value [key=value ...]] [nocanon] [interpolate] [noquery]
Maps remote servers into the local server URL-space
svd E
ProxyPassInherit On|Off
Inherit ProxyPass directives defined from the main server
On sv E
ProxyPassInterpolateEnv On|Off
Enable Environment Variable interpolation in Reverse Proxy configurations
Off svd E
ProxyPassMatch [regex] !|url [key=value [key=value ...]]
Maps remote servers into the local server URL-space using regular expressions
svd E
ProxyPassReverse [path] url [interpolate]
Adjusts the URL in HTTP response headers sent from a reverse proxied server
svd E
ProxyPassReverseCookieDomain internal-domain public-domain [interpolate]
Adjusts the Domain string in Set-Cookie headers from a reverse- proxied server
svd E
ProxyPassReverseCookiePath internal-path public-path [interpolate]
Adjusts the Path string in Set-Cookie headers from a reverse- proxied server
svd E
ProxyPreserveHost On|Off
Use incoming Host HTTP request header for proxy request
Off svd E
ProxyReceiveBufferSize bytes
Network buffer size for proxied HTTP and FTP connections
0 sv E
ProxyRemote match remote-server
Remote proxy used to handle certain requests
sv E
ProxyRemoteMatch regex remote-server
Remote proxy used to handle requests matched by regular expressions
sv E
ProxyRequests On|Off
Enables forward (standard) proxy requests
Off sv E
ProxySCGIInternalRedirect On|Off|Headername
Enable or disable internal redirect responses from the backend
On svd E
ProxySCGISendfile On|Off|Headername
Enable evaluation of X-Sendfile pseudo response header
Off svd E
ProxySet url key=value [key=value ...]
Set various Proxy balancer or member parameters
d E
ProxySourceAddress address
Set local IP address for outgoing proxy connections
sv E
ProxyStatus Off|On|Full
Show Proxy LoadBalancer status in mod_status
Off sv E
ProxyTimeout seconds
Network timeout for proxied requests
sv E
ProxyVia On|Off|Full|Block
Information provided in the Via HTTP response header for proxied requests
Off sv E
QualifyRedirectURL ON|OFF
Controls whether the REDIRECT_URL environment variable is fully qualified
OFF svd C
ReadmeName filename
Name of the file that will be inserted at the end of the index listing
svdh B
ReceiveBufferSize bytes
TCP receive buffer size
0 s M
Redirect [status] [URL-path] URL
Sends an external redirect asking the client to fetch a different URL
svdh B
RedirectMatch [status] regex URL
Sends an external redirect based on a regular expression match of the current URL
svdh B
RedirectPermanent URL-path URL
Sends an external permanent redirect asking the client to fetch a different URL
svdh B
RedirectTemp URL-path URL
Sends an external temporary redirect asking the client to fetch a different URL
svdh B
ReflectorHeader inputheader [outputheader]
Reflect an input header to the output headers
svdh B
RegisterHttpMethod method [method [...]]
Register non-standard HTTP methods
s C
RemoteIPHeader header-field
Declare the header field which should be parsed for useragent IP addresses
sv B
RemoteIPInternalProxy proxy-ip|proxy-ip/subnet|hostname ...
Declare client intranet IP addresses trusted to present the RemoteIPHeader value
sv B
RemoteIPInternalProxyList filename
Declare client intranet IP addresses trusted to present the RemoteIPHeader value
sv B
RemoteIPProxiesHeader HeaderFieldName
Declare the header field which will record all intermediate IP addresses
sv B
RemoteIPTrustedProxy proxy-ip|proxy-ip/subnet|hostname ...
Declare client intranet IP addresses trusted to present the RemoteIPHeader value
sv B
RemoteIPTrustedProxyList filename
Declare client intranet IP addresses trusted to present the RemoteIPHeader value
sv B
RemoveCharset extension [extension] ...
Removes any character set associations for a set of file extensions
vdh B
RemoveEncoding extension [extension] ...
Removes any content encoding associations for a set of file extensions
vdh B
RemoveHandler extension [extension] ...
Removes any handler associations for a set of file extensions
vdh B
RemoveInputFilter extension [extension] ...
Removes any input filter associations for a set of file extensions
vdh B
RemoveLanguage extension [extension] ...
Removes any language associations for a set of file extensions
vdh B
RemoveOutputFilter extension [extension] ...
Removes any output filter associations for a set of file extensions
vdh B
RemoveType extension [extension] ...
Removes any content type associations for a set of file extensions
vdh B
RequestHeader add|append|edit|edit*|merge|set|setifempty|unset header [[expr=]value [replacement] [early|env=[!]varname|expr=expression]]
Configure HTTP request headers
svdh E
RequestReadTimeout [header=timeout[-maxtimeout][,MinRate=rate] [body=timeout[-maxtimeout][,MinRate=rate]
Set timeout values for receiving request headers and body from client.
sv E
Require [not] entity-name [entity-name] ...
Tests whether an authenticated user is authorized by an authorization provider.
dh B
<RequireAll> ... </RequireAll>
Enclose a group of authorization directives of which none must fail and at least one must succeed for the enclosing directive to succeed.
dh B
<RequireAny> ... </RequireAny>
Enclose a group of authorization directives of which one must succeed for the enclosing directive to succeed.
dh B
<RequireNone> ... </RequireNone>
Enclose a group of authorization directives of which none must succeed for the enclosing directive to not fail.
dh B
RewriteBase URL-path
Sets the base URL for per-directory rewrites
dh E
RewriteCond TestString CondPattern [flags]
Defines a condition under which rewriting will take place
svdh E
RewriteEngine on|off
Enables or disables runtime rewriting engine
off svdh E
RewriteMap MapName MapType:MapSource
Defines a mapping function for key-lookup
sv E
RewriteOptions Options
Sets some special options for the rewrite engine
svdh E
RewriteRule Pattern Substitution [flags]
Defines rules for the rewriting engine
svdh E
RLimitCPU seconds|max [seconds|max]
Limits the CPU consumption of processes launched by Apache httpd children
svdh C
RLimitMEM bytes|max [bytes|max]
Limits the memory consumption of processes launched by Apache httpd children
svdh C
RLimitNPROC number|max [number|max]
Limits the number of processes that can be launched by processes launched by Apache httpd children
svdh C
Satisfy Any|All
Interaction between host-level access control and user authentication
All dh E
ScoreBoardFile file-path
Location of the file used to store coordination data for the child processes
logs/apache_runtime + s M
Script method cgi-script
Activates a CGI script for a particular request method.
svd B
ScriptAlias [URL-path] file-path|directory-path
Maps a URL to a filesystem location and designates the target as a CGI script
svd B
ScriptAliasMatch regex file-path|directory-path
Maps a URL to a filesystem location using a regular expression and designates the target as a CGI script
sv B
ScriptInterpreterSource Registry|Registry-Strict|Script
Technique for locating the interpreter for CGI scripts
Script svdh C
ScriptLog file-path
Location of the CGI script error logfile
sv B
ScriptLogBuffer bytes
Maximum amount of PUT or POST requests that will be recorded in the scriptlog
1024 sv B
ScriptLogLength bytes
Size limit of the CGI script logfile
10385760 sv B
ScriptSock file-path
The filename prefix of the socket to use for communication with the cgi daemon
cgisock s B
SecureListen [IP-address:]portnumber Certificate-Name [MUTUAL]
Enables SSL encryption for the specified port
s B
SeeRequestTail On|Off
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.
Off s C
SendBufferSize bytes
TCP buffer size
0 s M
ServerAdmin email-address|URL
Email address that the server includes in error messages sent to the client
sv C
ServerAlias hostname [hostname] ...
Alternate names for a host used when matching requests to name-virtual hosts
v C
ServerLimit number
Upper limit on configurable number of processes
s M
ServerName [scheme://]domain-name|ip-address[:port]
Hostname and port that the server uses to identify itself
sv C
ServerPath URL-path
Legacy URL pathname for a name-based virtual host that is accessed by an incompatible browser
v C
ServerRoot directory-path
Base directory for the server installation
/usr/local/apache s C
ServerSignature On|Off|EMail
Configures the footer on server-generated documents
Off svdh C
ServerTokens Major|Minor|Min[imal]|Prod[uctOnly]|OS|Full
Configures the Server HTTP response header
Full s C
Session On|Off
Enables a session for the current directory or location
Off svdh E
SessionCookieName name attributes
Name and attributes for the RFC2109 cookie storing the session
svdh E
SessionCookieName2 name attributes
Name and attributes for the RFC2965 cookie storing the session
svdh E
SessionCookieRemove On|Off
Control for whether session cookies should be removed from incoming HTTP headers
Off svdh E
SessionCryptoCipher name
The crypto cipher to be used to encrypt the session
svdh X
SessionCryptoDriver name [param[=value]]
The crypto driver to be used to encrypt the session
s X
SessionCryptoPassphrase secret [ secret ... ]
The key used to encrypt the session
svdh X
SessionCryptoPassphraseFile filename
File containing keys used to encrypt the session
svd X
SessionDBDCookieName name attributes
Name and attributes for the RFC2109 cookie storing the session ID
svdh E
SessionDBDCookieName2 name attributes
Name and attributes for the RFC2965 cookie storing the session ID
svdh E
SessionDBDCookieRemove On|Off
Control for whether session ID cookies should be removed from incoming HTTP headers
On svdh E
SessionDBDDeleteLabel label
The SQL query to use to remove sessions from the database
deletesession svdh E
SessionDBDInsertLabel label
The SQL query to use to insert sessions into the database
insertsession svdh E
SessionDBDPerUser On|Off
Enable a per user session
Off svdh E
SessionDBDSelectLabel label
The SQL query to use to select sessions from the database
selectsession svdh E
SessionDBDUpdateLabel label
The SQL query to use to update existing sessions in the database
updatesession svdh E
SessionEnv On|Off
Control whether the contents of the session are written to the HTTP_SESSION environment variable
Off svdh E
SessionExclude path
Define URL prefixes for which a session is ignored
svdh E
SessionHeader header
Import session updates from a given HTTP response header
svdh E
SessionInclude path
Define URL prefixes for which a session is valid
svdh E
SessionMaxAge maxage
Define a maximum age in seconds for a session
0 svdh E
SetEnv env-variable [value]
Sets environment variables
svdh B
SetEnvIf attribute regex [!]env-variable[=value] [[!]env-variable[=value]] ...
Sets environment variables based on attributes of the request
svdh B
SetEnvIfExpr expr [!]env-variable[=value] [[!]env-variable[=value]] ...
Sets environment variables based on an ap_expr expression
svdh B
SetEnvIfNoCase attribute regex [!]env-variable[=value] [[!]env-variable[=value]] ...
Sets environment variables based on attributes of the request without respect to case
svdh B
SetHandler handler-name|none|expression
Forces all matching files to be processed by a handler
svdh C
SetInputFilter filter[;filter...]
Sets the filters that will process client requests and POST input
svdh C
SetOutputFilter filter[;filter...]
Sets the filters that will process responses from the server
svdh C
SSIEndTag tag
String that ends an include element
"-->" sv B
SSIErrorMsg message
Error message displayed when there is an SSI error
"[an error occurred + svdh B
SSIETag on|off
Controls whether ETags are generated by the server.
off dh B
SSILastModified on|off
Controls whether Last-Modified headers are generated by the server.
off dh B
SSILegacyExprParser on|off
Enable compatibility mode for conditional expressions.
off dh B
SSIStartTag tag
String that starts an include element
"<!--#" sv B
SSITimeFormat formatstring
Configures the format in which date strings are displayed
"%A, %d-%b-%Y %H:%M +svdh B
SSIUndefinedEcho string
String displayed when an unset variable is echoed
"(none)" svdh B
SSLCACertificateFile file-path
File of concatenated PEM-encoded CA Certificates for Client Auth
sv E
SSLCACertificatePath directory-path
Directory of PEM-encoded CA Certificates for Client Auth
sv E
SSLCADNRequestFile file-path
File of concatenated PEM-encoded CA Certificates for defining acceptable CA names
sv E
SSLCADNRequestPath directory-path
Directory of PEM-encoded CA Certificates for defining acceptable CA names
sv E
SSLCARevocationCheck chain|leaf|none flags
Enable CRL-based revocation checking
none sv E
SSLCARevocationFile file-path
File of concatenated PEM-encoded CA CRLs for Client Auth
sv E
SSLCARevocationPath directory-path
Directory of PEM-encoded CA CRLs for Client Auth
sv E
SSLCertificateChainFile file-path
File of PEM-encoded Server CA Certificates
sv E
SSLCertificateFile file-path
Server PEM-encoded X.509 certificate data file
sv E
SSLCertificateKeyFile file-path
Server PEM-encoded private key file
sv E
SSLCipherSuite cipher-spec
Cipher Suite available for negotiation in SSL handshake
DEFAULT (depends on + svdh E
SSLCompression on|off
Enable compression on the SSL level
off sv E
SSLCryptoDevice engine
Enable use of a cryptographic hardware accelerator
builtin s E
SSLEngine on|off|optional
SSL Engine Operation Switch
off sv E
SSLFIPS on|off
SSL FIPS mode Switch
off s E
SSLHonorCipherOrder on|off
Option to prefer the server's cipher preference order
off sv E
SSLInsecureRenegotiation on|off
Option to enable support for insecure renegotiation
off sv E
SSLOCSDefaultResponder uri
Set the default responder URI for OCSP validation
sv E
SSLOCSPEnable on|off
Enable OCSP validation of the client certificate chain
off sv E
SSLOCSPNoverify On/Off
skip the OCSP responder certificates verification
Off sv E
SSLOCSPOverrideResponder on|off
Force use of the default responder URI for OCSP validation
off sv E
SSLOCSPProxyURL url
Proxy URL to use for OCSP requests
sv E
SSLOCSPResponderCertificateFile file
Set of trusted PEM encoded OCSP responder certificates
sv E
SSLOCSPResponderTimeout seconds
Timeout for OCSP queries
10 sv E
SSLOCSPResponseMaxAge seconds
Maximum allowable age for OCSP responses
-1 sv E
SSLOCSPResponseTimeSkew seconds
Maximum allowable time skew for OCSP response validation
300 sv E
SSLOCSPUseRequestNonce on|off
Configure OpenSSL parameters through its SSL_CONF API
Use a nonce within OCSP queries
on sv E
SSLOpenSSLConfCmd command-name command-value sv E
SSLOptions [+|-]option ...
Configure various SSL engine run-time options
svdh E
SSLPassPhraseDialog type
Type of pass phrase dialog for encrypted private keys
builtin s E
SSLProtocol [+|-]protocol ...
Configure usable SSL/TLS protocol versions
all -SSLv3 (up to 2 + sv E
SSLProxyCACertificateFile file-path
File of concatenated PEM-encoded CA Certificates for Remote Server Auth
sv E
SSLProxyCACertificatePath directory-path
Directory of PEM-encoded CA Certificates for Remote Server Auth
sv E
SSLProxyCARevocationCheck chain|leaf|none
Enable CRL-based revocation checking for Remote Server Auth
none sv E
SSLProxyCARevocationFile file-path
File of concatenated PEM-encoded CA CRLs for Remote Server Auth
sv E
SSLProxyCARevocationPath directory-path
Directory of PEM-encoded CA CRLs for Remote Server Auth
sv E
SSLProxyCheckPeerCN on|off
Whether to check the remote server certificate's CN field
on sv E
SSLProxyCheckPeerExpire on|off
Whether to check if remote server certificate is expired
on sv E
SSLProxyCheckPeerName on|off
Configure host name checking for remote server certificates
on sv E
SSLProxyCipherSuite cipher-spec
Cipher Suite available for negotiation in SSL proxy handshake
ALL:!ADH:RC4+RSA:+H + svdh E
SSLProxyEngine on|off
SSL Proxy Engine Operation Switch
off sv E
SSLProxyMachineCertificateChainFile filename
File of concatenated PEM-encoded CA certificates to be used by the proxy for choosing a certificate
s E
SSLProxyMachineCertificateFile filename
File of concatenated PEM-encoded client certificates and keys to be used by the proxy
s E
SSLProxyMachineCertificatePath directory
Directory of PEM-encoded client certificates and keys to be used by the proxy
s E
SSLProxyProtocol [+|-]protocol ...
Configure usable SSL protocol flavors for proxy usage
all -SSLv3 (up to 2 +) sv E
SSLProxyVerify level
Type of remote server Certificate verification
none sv E
SSLProxyVerifyDepth number
Maximum depth of CA Certificates in Remote Server Certificate verification
1 sv E
SSLRandomSeed context source [bytes]
Pseudo Random Number Generator (PRNG) seeding source
s E
SSLRenegBufferSize bytes
Set the size for the SSL renegotiation buffer
131072 dh E
SSLRequire expression
Allow access only when an arbitrarily complex boolean expression is true
dh E
SSLRequireSSL
a href="http://setgetweb.com/p/Apache24/mod/mod_access_compat.html#deny">Deny access when SSL is not used for the HTTP request
dh E
SSLSessionCache type
Type of the global/inter-process SSL Session Cache
none s E
SSLSessionCacheTimeout seconds
Number of seconds before an SSL session expires in the Session Cache
300 sv E
SSLSessionTicketKeyFile file-path
Persistent encryption/decryption key for TLS session tickets
sv E
SSLSessionTickets on|off
Enable or disable use of TLS session tickets
on sv E
SSLSRPUnknownUserSeed secret-string
SRP unknown user seed
sv E
SSLSRPVerifierFile file-path
Path to SRP verifier file
sv E
SSLStaplingCache type
Configures the OCSP stapling cache
s E
SSLStaplingErrorCacheTimeout seconds
Number of seconds before expiring invalid responses in the OCSP stapling cache
600 sv E
SSLStaplingFakeTryLater on|off
Synthesize "tryLater" responses for failed OCSP stapling queries
on sv E
SSLStaplingForceURL uri
Override the OCSP responder URI specified in the certificate's AIA extension
sv E
SSLStaplingResponderTimeout seconds
Timeout for OCSP stapling queries
10 sv E
SSLStaplingResponseMaxAge seconds
Maximum allowable age for OCSP stapling responses
-1 sv E
SSLStaplingResponseTimeSkew seconds
Maximum allowable time skew for OCSP stapling response validation
300 sv E
SSLStaplingReturnResponderErrors on|off
Pass stapling related OCSP errors on to client
on sv E
SSLStaplingStandardCacheTimeout seconds
Number of seconds before expiring responses in the OCSP stapling cache
3600 sv E
SSLStrictSNIVHostCheck on|off
Whether to allow non-SNI clients to access a name-based virtual host.
off sv E
SSLUserName varname
Variable name to determine user name
sdh E
SSLUseStapling on|off
Enable stapling of OCSP responses in the TLS handshake
off sv E
SSLVerifyClient level
Type of Client Certificate verification
none svdh E
SSLVerifyDepth number
Maximum depth of CA Certificates in Client Certificate verification
1 svdh E
StartServers number
Number of child server processes created at startup
s M
StartThreads number
Number of threads created on startup
s M
Substitute s/pattern/substitution/[infq]
Pattern to filter the response content
dh E
SubstituteInheritBefore on|off
Change the merge order of inherited patterns
off dh E
SubstituteMaxLineLength bytes(b|B|k|K|m|M|g|G)
Set the maximum line size
1m dh E
Suexec On|Off
Enable or disable the suEXEC feature
s B
SuexecUserGroup User Group
User and group for CGI programs to run as
sv E
ThreadLimit number
Sets the upper limit on the configurable number of threads per child process
s M
ThreadsPerChild number
Number of threads created by each child process
s M
ThreadStackSize size
The size in bytes of the stack used by threads handling client connections
s M
TimeOut seconds
Amount of time the server will wait for certain events before failing a request
60 sv C
TraceEnable [on|off|extended]
Determines the behavior on TRACE requests
on sv C
TransferLog file|pipe
Specify location of a log file
sv B
TypesConfig file-path
The location of the mime.types file
conf/mime.types s B
UnDefine parameter-name
Undefine the existence of a variable
s C
UndefMacro name
Undefine a macro
svd B
UnsetEnv env-variable [env-variable] ...
Use name [value1 ... valueN]
Remove variables from the environment
svdh B
UseCanonicalName On|Off|DNS
Configures how the server determines its own name and port
Off svd C
UseCanonicalPhysicalPort On|Off
Configures how the server determines its own port
Off svd C
User unix-userid
The userid under which the server will answer requests
#-1 s B
UserDir directory-filename [directory-filename] ...
Location of the user-specific directories
sv B
VHostCGIMode On|Off|Secure
Determines whether the virtualhost can run subprocesses, and the privileges available to subprocesses.
On v X
VHostPrivs [+-]?privilege-name [[+-]?privilege-name] ...
Assign arbitrary privileges to subprocesses created by a virtual host.
v X
VHostGroup unix-groupid
Sets the Group ID under which a virtual host runs.
v X
VHostPrivs [+-]?privilege-name [[+-]?privilege-name] ...
Assign arbitrary privileges to a virtual host.
v X
VHostSecure On|Off
Determines whether the server runs with enhanced security for the virtualhost.
On v X
VHostUser unix-userid
Sets the User ID under which a virtual host runs.
v X
VirtualDocumentRoot interpolated-directory|none
Dynamically configure the location of the document root for a given virtual host
none sv E
VirtualDocumentRootIP interpolated-directory|none
Dynamically configure the location of the document root for a given virtual host
none sv E
<VirtualHost addr[:port] [addr[:port]] ...> ... </VirtualHost>
Contains directives that apply only to a specific hostname or IP address
s C
VirtualScriptAlias interpolated-directory|none
Dynamically configure the location of the CGI directory for a given virtual host
none sv E
VirtualScriptAliasIP interpolated-directory|none
Dynamically configure the location of the CGI directory for a given virtual host
none sv E
WatchdogInterval number-of-seconds
Watchdog interval in seconds
1 s B
XBitHack on|off|full
Parse SSI directives in files with the execute bit set
off svdh B
xml2EncAlias charset alias [alias ...]
Recognise Aliases for encoding values
s B
xml2EncDefault name
Sets a default encoding to assume when absolutely no information can be automatically detected
svdh B
xml2StartParse element [element ...]
Advise the parser to skip leading junk.
svdh B

en | es | zh-cn