Configuration Files

This document describes the files used to configure Apache HTTP Server.

• Main Configuration Files
• Syntax of the Configuration Files
• Modules
• Scope of Directives
• .htaccess Files

Main Configuration Files ¶

Apache HTTP Server is configured by placing directives in plain text configuration files. The main configuration file is usually called httpd.conf. The location of this file is set at compile-time, but may be overridden with the -f command line flag. In addition, other configuration files may be added using the Include directive, and wildcards can be used to include many configuration files. Any directive may be placed in any of these configuration files. Changes to the main configuration files are only recognized by httpd when it is started or restarted.

The server also reads a file containing mime document types; the filename is set by the TypesConfig directive, and is mime.types by default.

Syntax of the Configuration Files ¶

httpd configuration files contain one directive per line. The backslash "\" may be used as the last character on a line to indicate that the directive continues onto the next line. To be interpreted as such a continuation, there must be no other characters or white space between the backslash and the end of the line.

Lines that begin with the hash character "#" are considered comments, and are ignored. Comments may not be included on the same line as a configuration directive, including at the start of a line that has been continued as described in the preceding paragraph. Commented lines may also be continued, meaning the next physical line is also interpreted as a comment because the logical line begins with a hash character.

White space occurring before a directive is ignored, so you may indent directives for clarity. Blank lines are also ignored. Arguments to directives are separated by whitespace. If an argument contains spaces, you must enclose that argument in quotes.

Quoting and Escaping

Either double quotes (") or single quotes (') can be used to enclose an argument that contains spaces. The quotes themselves are not part of the argument.

Inside a quoted string, only two escape sequences are recognized: \\ produces a literal backslash, and \" (or \' if the string is single-quoted) produces a literal quote character without ending the string. All other backslash sequences are passed through unchanged — for example, \n is the literal two characters \n, not a newline.

Outside of quotes, backslashes have no special meaning and are treated as literal characters. The only exception is the line-continuation backslash at the very end of a line, as described above.

Note that adjacent quoted strings with no whitespace between them are not concatenated — they are parsed as separate arguments. For example:

Some directives accept arguments that contain sub-expressions with their own syntax, such as RewriteRule flags or ap_expr expressions. In those cases, the config file parser first removes the enclosing quotes and processes backslash escapes as described above, then the directive's own parser processes the result. When in doubt, using single quotes around an argument that contains backslashes can avoid unexpected double-processing of escape sequences.

Directives in the configuration files are case-insensitive, but arguments to directives are often case sensitive.

The values of variables defined with the Define of or shell environment variables can be used in configuration file lines using the syntax ${VAR}. If "VAR" is the name of a valid variable, the value of that variable is substituted into that spot in the configuration file line, and processing continues as if that text were found directly in the configuration file. Variables defined with Define take precedence over shell environment variables. If the "VAR" variable is not found, the characters ${VAR} are left unchanged, and a warning is logged. Variable names may not contain colon ":" characters, to avoid clashes with RewriteMap's syntax.

Only shell environment variables defined before the server is started can be used in expansions. Environment variables defined in the configuration file itself, for example with SetEnv, take effect too late to be used for expansions in the configuration file.

The maximum length of a line in normal configuration files, after variable substitution and joining any continued lines, is approximately 16 MiB. In .htaccess files, the maximum length is 8190 characters.

You can check your configuration files for syntax errors without starting the server by using apachectl configtest or the -t command line option.

You can use mod_info's -DDUMP_CONFIG to dump the configuration with all included files and environment variables resolved and all comments and non-matching <IfDefine> and <IfModule> sections removed. However, the output does not reflect the merging or overriding that may happen for repeated directives.

Modules ¶

httpd is a modular server. This implies that only the most basic functionality is included in the core server. Extended features are available through modules which can be loaded into httpd. By default, a base set of modules is included in the server at compile-time. If the server is compiled to use dynamically loaded modules, then modules can be compiled separately and added at any time using the LoadModule directive. Otherwise, httpd must be recompiled to add or remove modules. Configuration directives may be included conditional on a presence of a particular module by enclosing them in an <IfModule> block. However, <IfModule> blocks are not required, and in some cases may mask the fact that you're missing an important module.

To see which modules are currently compiled into the server, you can use the -l command line option. You can also see what modules are loaded dynamically using the -M command line option.

Scope of Directives ¶

Directives placed in the main configuration files apply to the entire server. If you wish to change the configuration for only a part of the server, you can scope your directives by placing them in <Directory>, <DirectoryMatch>, <Files>, <FilesMatch>, <Location>, and <LocationMatch> sections. These sections limit the application of the directives which they enclose to particular filesystem locations or URLs. They can also be nested, allowing for very fine grained configuration.

httpd has the capability to serve many different websites simultaneously. This is called Virtual Hosting. Directives can also be scoped by placing them inside <VirtualHost> sections, so that they will only apply to requests for a particular website.

Although most directives can be placed in any of these sections, some directives do not make sense in some contexts. For example, directives controlling process creation can only be placed in the main server context. To find which directives can be placed in which sections, check the Context of the directive. For further information, we provide details on How Directory, Location and Files sections work.

.htaccess Files ¶

httpd allows for decentralized management of configuration via special files placed inside the web tree. The special files are usually called .htaccess, but any name can be specified in the AccessFileName directive. Directives placed in .htaccess files apply to the directory where you place the file, and all sub-directories. The .htaccess files follow the same syntax as the main configuration files. Since .htaccess files are read on every request, changes made in these files take immediate effect.

To find which directives can be placed in .htaccess files, check the Context of the directive. The server administrator further controls what directives may be placed in .htaccess files by configuring the AllowOverride directive in the main configuration files.

For more information on .htaccess files, see the .htaccess tutorial.