[deployment-guide/comm-rel: 681/727] Indexed the beast.
Jaromir Hradilek
jhradile at fedoraproject.org
Tue Oct 19 13:23:01 UTC 2010
commit ffd3840e0fa654c999e16394c095a5f95ec500fd
Author: Jaromir Hradilek <jhradile at redhat.com>
Date: Fri Sep 17 16:40:19 2010 +0200
Indexed the beast.
en-US/The_Apache_HTTP_Server.xml | 1000 +++++++++++++++++++++++++++++++++++---
1 files changed, 920 insertions(+), 80 deletions(-)
---
diff --git a/en-US/The_Apache_HTTP_Server.xml b/en-US/The_Apache_HTTP_Server.xml
index 0b9c190..770f260 100644
--- a/en-US/The_Apache_HTTP_Server.xml
+++ b/en-US/The_Apache_HTTP_Server.xml
@@ -14,6 +14,10 @@
<para>
<systemitem class="protocol">HTTP</systemitem> (Hypertext Transfer Protocol) server, or a <firstterm>web server</firstterm>, is a network service that serves content to a client over the web. This typically means web pages, but any other documents can be served as well.
</para>
+ <indexterm>
+ <primary><systemitem class="service">httpd</systemitem></primary>
+ <see><application>Apache HTTP Server</application></see>
+ </indexterm>
<para>
This chapter focuses on the <application>Apache HTTP Server 2.2</application>, a robust, full-featured open source web server developed by the <ulink url="http://www.apache.org/">Apache Software Foundation</ulink>, that is included in &MAJOROSVER;. It describes the basic configuration of the <systemitem class="service">httpd</systemitem> service, and covers advanced topics such as adding server modules, setting up virtual hosts, or configuring the secure HTTP server.
</para>
@@ -24,17 +28,37 @@
</para>
<section id="s2-apache-version2-features">
<title>New Features</title>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>version 2.2</secondary>
+ <tertiary>features</tertiary>
+ </indexterm>
<para>
The Apache HTTP Server version 2.2 introduces the following enhancements:
</para>
<itemizedlist>
<listitem>
<para>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>modules</secondary>
+ <tertiary><systemitem class="resource">mod_cache</systemitem></tertiary>
+ </indexterm>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>modules</secondary>
+ <tertiary><systemitem class="resource">mod_disk_cache</systemitem></tertiary>
+ </indexterm>
Improved caching modules, that is, <systemitem class="resource">mod_cache</systemitem> and <systemitem class="resource">mod_disk_cache</systemitem>.
</para>
</listitem>
<listitem>
<para>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>modules</secondary>
+ <tertiary><systemitem class="resource">mod_proxy_balancer</systemitem></tertiary>
+ </indexterm>
Support for proxy load balancing, that is, the <systemitem class="resource">mod_proxy_balancer</systemitem> module.
</para>
</listitem>
@@ -52,24 +76,49 @@
</section>
<section id="s2-apache-version2-changes">
<title>Notable Changes</title>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>version 2.2</secondary>
+ <tertiary>changes</tertiary>
+ </indexterm>
<para>
Since version 2.0, few changes have been made to the default <systemitem class="service">httpd</systemitem> service configuration:
</para>
<itemizedlist>
<listitem>
<para>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>modules</secondary>
+ <tertiary><systemitem class="resource">mod_cern_meta</systemitem></tertiary>
+ </indexterm>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>modules</secondary>
+ <tertiary><systemitem class="resource">mod_asis</systemitem></tertiary>
+ </indexterm>
The following modules are no longer loaded by default: <systemitem class="resource">mod_cern_meta</systemitem> and <systemitem class="resource">mod_asis</systemitem>.
</para>
</listitem>
<listitem>
<para>
- The following modules are newly loaded by default: <systemitem class="resource">mod_ext_filter</systemitem>.
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>modules</secondary>
+ <tertiary><systemitem class="resource">mod_ext_filter</systemitem></tertiary>
+ </indexterm>
+ The following module is newly loaded by default: <systemitem class="resource">mod_ext_filter</systemitem>.
</para>
</listitem>
</itemizedlist>
</section>
<section id="s1-apache-version2-migrating">
<title>Updating the Configuration</title>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>version 2.2</secondary>
+ <tertiary>updating from version 2.0</tertiary>
+ </indexterm>
<para>
To update the configuration files from the Apache HTTP Server version 2.0, take the following steps:
</para>
@@ -86,6 +135,11 @@
</step>
<step>
<para>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>modules</secondary>
+ <tertiary><systemitem class="resource">mod_userdir</systemitem></tertiary>
+ </indexterm>
If you use the <systemitem class="resource">mod_userdir</systemitem> module, make sure the <option>UserDir</option> directive indicating a directory name (typically <literal>public_html</literal>) is provided.
</para>
</step>
@@ -116,6 +170,10 @@ Syntax OK</screen>
</para>
<section id="s2-apache-running-starting">
<title>Starting the Service</title>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>starting</secondary>
+ </indexterm>
<para>
To run the <systemitem class="service">httpd</systemitem> service, type the following at a shell prompt:
</para>
@@ -137,6 +195,10 @@ Starting httpd: [ OK ]</screen>
</section>
<section id="s2-apache-running-stopping">
<title>Stopping the Service</title>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>stopping</secondary>
+ </indexterm>
<para>
To stop the running <systemitem class="service">httpd</systemitem> service, type the following at a shell prompt:
</para>
@@ -152,6 +214,10 @@ Stopping httpd: [ OK ]</screen>
</section>
<section id="s3-apache-running-restarting">
<title>Restarting the Service</title>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>restarting</secondary>
+ </indexterm>
<para>
There are three different ways to restart the running <systemitem class="service">httpd</systemitem> service:
</para>
@@ -192,6 +258,10 @@ Starting httpd: [ OK ]</screen>
</section>
<section id="s3-apache-running-status">
<title>Checking the Service Status</title>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>checking status</secondary>
+ </indexterm>
<para>
To check whether the service is running, type the following at a shell prompt:
</para>
@@ -225,6 +295,11 @@ httpd (pid 19014) is running...</screen>
<tbody>
<row>
<entry>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>files</secondary>
+ <tertiary><filename>/etc/httpd/conf/httpd.conf</filename></tertiary>
+ </indexterm>
<filename>/etc/httpd/conf/httpd.conf</filename>
</entry>
<entry>
@@ -233,6 +308,11 @@ httpd (pid 19014) is running...</screen>
</row>
<row>
<entry>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directories</secondary>
+ <tertiary><filename class="directory">/etc/httpd/conf.d/</filename></tertiary>
+ </indexterm>
<filename class="directory">/etc/httpd/conf.d/</filename>
</entry>
<entry>
@@ -245,6 +325,10 @@ httpd (pid 19014) is running...</screen>
<para>
Although the default configuration should be suitable for most situations, it is a good idea to become at least familiar with some of the more important configuration options. Note that for any changes to take effect, the web server has to be restarted first. Refer to <xref linkend="s3-apache-running-restarting" /> for more information on how to restart the <systemitem class="service">httpd</systemitem> service.
</para>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>checking configuration</secondary>
+ </indexterm>
<para>
To check the configuration for possible errors, type the following at a shell prompt:
</para>
@@ -255,12 +339,24 @@ Syntax OK</screen>
</para>
<section id="s2-apache-httpdconf-directives">
<title>Common <filename>httpd.conf</filename> Directives</title>
+ <indexterm significance="preferred">
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>files</secondary>
+ <tertiary><filename>/etc/httpd/conf/httpd.conf</filename></tertiary>
+ </indexterm>
<para>
The following directives are commonly used in the <filename>/etc/httpd/conf/httpd.conf</filename> configuration file:
</para>
<variablelist>
<varlistentry>
- <term><option><Directory></option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option><Directory></option></tertiary>
+ </indexterm>
+ <option><Directory></option>
+ </term>
<listitem>
<para>
The <option><Directory></option> directive allows you to apply certain directives to a particular directory only. It takes the following form:
@@ -287,7 +383,14 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option><IfDefine></option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option><IfDefine></option></tertiary>
+ </indexterm>
+ <option><IfDefine></option>
+ </term>
<listitem>
<para>
The <option>IfDefine</option> directive allows you to use certain directives only when a particular parameter is supplied on the command line. It takes the following form:
@@ -308,7 +411,14 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option><IfModule></option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option><IfModule></option></tertiary>
+ </indexterm>
+ <option><IfModule></option>
+ </term>
<listitem>
<para>
The <option><IfModule></option> directive allows you to use certain directive only when a particular module is loaded. It takes the following form:
@@ -330,7 +440,14 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option><Location></option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option><Location></option></tertiary>
+ </indexterm>
+ <option><Location></option>
+ </term>
<listitem>
<para>
The <option><Location></option> directive allows you to apply certain directives to a particular URL only. It takes the following form:
@@ -354,7 +471,14 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option><Proxy></option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option><Proxy></option></tertiary>
+ </indexterm>
+ <option><Proxy></option>
+ </term>
<listitem>
<para>
The <option><Proxy></option> directive allows you to apply certain directives to the proxy server only. It takes the following form:
@@ -377,7 +501,14 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option><VirtualHost></option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option><VirtualHost></option></tertiary>
+ </indexterm>
+ <option><VirtualHost></option>
+ </term>
<listitem>
<para>
The <option><VirtualHost></option> directive allows you apply certain directives to particular virtual hosts only. It takes the following form:
@@ -434,15 +565,40 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>AccessFileName</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>AccessFileName</option></tertiary>
+ </indexterm>
+ <option>AccessFileName</option>
+ </term>
<listitem>
<para>
The <option>AccessFileName</option> directive allows you to specify the file to be used to customize access control information for each directory. It takes the following form:
</para>
<screen>AccessFileName <replaceable>filename</replaceable>…</screen>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>files</secondary>
+ <tertiary><filename>.htaccess</filename></tertiary>
+ </indexterm>
+ <indexterm>
+ <primary><filename>.htaccess</filename></primary>
+ <seealso><application>Apache HTTP Server</application></seealso>
+ </indexterm>
<para>
The <replaceable>filename</replaceable> is a name of the file to look for in the requested directory. By default, the server looks for <filename>.htaccess</filename>.
</para>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>files</secondary>
+ <tertiary><filename>.htpasswd</filename></tertiary>
+ </indexterm>
+ <indexterm>
+ <primary><filename>.htpasswd</filename></primary>
+ <seealso><application>Apache HTTP Server</application></seealso>
+ </indexterm>
<para>
For security reasons, the directive is typically followed by the <literal>Files</literal> tag to prevent the files beginning with <filename>.ht</filename> from being accessed by web clients. This includes the <filename>.htaccess</filename> and <filename>.htpasswd</filename> files.
</para>
@@ -459,7 +615,14 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>Action</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>Action</option></tertiary>
+ </indexterm>
+ <option>Action</option>
+ </term>
<listitem>
<para>
The <option>Action</option> directive allows you to specify a CGI script to be executed when a certain media type is requested. It takes the following form:
@@ -475,7 +638,14 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>AddDescription</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>AddDescription</option></tertiary>
+ </indexterm>
+ <option>AddDescription</option>
+ </term>
<listitem>
<para>
The <option>AddDescription</option> directive allows you to specify a short description to be displayed in server-generated directory listings for a given file. It takes the following form:
@@ -491,7 +661,14 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>AddEncoding</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>AddEncoding</option></tertiary>
+ </indexterm>
+ <option>AddEncoding</option>
+ </term>
<listitem>
<para>
The <option>AddEncoding</option> directive allows you to specify an encoding type for a particular file extension. It takes the following form:
@@ -510,7 +687,14 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>AddHandler</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>AddHandler</option></tertiary>
+ </indexterm>
+ <option>AddHandler</option>
+ </term>
<listitem>
<para>
The <option>AddHandler</option> directive allows you to map certain file extensions to a selected handler. It takes the following form:
@@ -529,7 +713,14 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>AddIcon</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>AddIcon</option></tertiary>
+ </indexterm>
+ <option>AddIcon</option>
+ </term>
<listitem>
<para>
The <option>AddIcon</option> directive allows you to specify an icon to be displayed for a particular file in server-generated directory listings. It takes the following form:
@@ -580,7 +771,14 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>AddIconByEncoding</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>AddIconByEncoding</option></tertiary>
+ </indexterm>
+ <option>AddIconByEncoding</option>
+ </term>
<listitem>
<para>
The <option>AddIconByEncoding</option> directive allows you to specify an icon to be displayed for a particular encoding type in server-generated directory listings. It takes the following form:
@@ -596,7 +794,14 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>AddIconByType</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>AddIconByType</option></tertiary>
+ </indexterm>
+ <option>AddIconByType</option>
+ </term>
<listitem>
<para>
The <option>AddIconByType</option> directive allows you to specify an icon to be displayed for a particular media type in server-generated directory listings. It takes the following form:
@@ -612,7 +817,14 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>AddLanguage</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>AddLanguage</option></tertiary>
+ </indexterm>
+ <option>AddLanguage</option>
+ </term>
<listitem>
<para>
The <option>AddLanguage</option> directive allows you to associate a file extension with a specific language. It takes the following form:
@@ -631,7 +843,14 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>AddType</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>AddType</option></tertiary>
+ </indexterm>
+ <option>AddType</option>
+ </term>
<listitem>
<para>
The <option>AddType</option> directive allows you to define or override the media type for a particular file extension. It takes the following form:
@@ -647,7 +866,14 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>Alias</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>Alias</option></tertiary>
+ </indexterm>
+ <option>Alias</option>
+ </term>
<listitem>
<para>
The <option>Alias</option> directive allows you to refer to files and directories outside the default directory specified by the <option>DocumentRoot</option> directive. It takes the following form:
@@ -656,6 +882,11 @@ Syntax OK</screen>
<para>
The <replaceable>url-path</replaceable> must be relative to the directory specified by the <option>DocumentRoot</option> directive (for example, <literal>/images/</literal>). The <replaceable>real-path</replaceable> is a full path to a file or directory in the local file system.
</para>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directories</secondary>
+ <tertiary><filename class="directory">/var/www/icons/</filename></tertiary>
+ </indexterm>
<para>
This directive is typically followed by the <option>Directory</option> tag with additional permissions to access the target directory. By default, the <literal>/icons/</literal> alias is created so that the icons from <filename class="directory">/var/www/icons/</filename> are displayed in server-generated directory listings.
</para>
@@ -673,7 +904,13 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>Allow</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>Allow</option></tertiary>
+ </indexterm>
+ <option>Allow</option></term>
<listitem>
<para>
The <option>Allow</option> directive allows you to specify which clients have permission to access a given directory. It takes the following form:
@@ -689,8 +926,23 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>AllowOverride</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>AllowOverride</option></tertiary>
+ </indexterm>
+ <option>AllowOverride</option>
+ </term>
<listitem>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>files</secondary>
+ <tertiary><filename>.htaccess</filename></tertiary>
+ </indexterm>
+ <indexterm>
+ <primary><filename>.htaccess</filename></primary>
+ </indexterm>
<para>
The <option>AllowOverride</option> directive allows you to specify which directives in a <filename>.htaccess</filename> file can override the default configuration. It takes the following form:
</para>
@@ -780,7 +1032,14 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>BrowserMatch</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>BrowserMatch</option></tertiary>
+ </indexterm>
+ <option>BrowserMatch</option>
+ </term>
<listitem>
<para>
The <option>BrowserMatch</option> directive allows you to modify the server behavior based on the client's web browser type. It takes the following form:
@@ -799,7 +1058,14 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>CacheDefaultExpire</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>CacheDefaultExpire</option></tertiary>
+ </indexterm>
+ <option>CacheDefaultExpire</option>
+ </term>
<listitem>
<para>
The <option>CacheDefaultExpire</option> option allows you to set how long to cache a document that does not have any expiration date or the date of its last modification specified. It takes the following form:
@@ -815,7 +1081,14 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>CacheDisable</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>CacheDisable</option></tertiary>
+ </indexterm>
+ <option>CacheDisable</option>
+ </term>
<listitem>
<para>
The <option>CacheDisable</option> directive allows you to disable caching of certain URLs. It takes the following form:
@@ -831,7 +1104,14 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>CacheEnable</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>CacheEnable</option></tertiary>
+ </indexterm>
+ <option>CacheEnable</option>
+ </term>
<listitem>
<para>
The <option>CacheEnable</option> directive allows you to specify a cache type to be used for certain URLs. It takes the following form:
@@ -890,7 +1170,14 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>CacheLastModifiedFactor</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>CacheLastModifiedFactor</option></tertiary>
+ </indexterm>
+ <option>CacheLastModifiedFactor</option>
+ </term>
<listitem>
<para>
The <option>CacheLastModifiedFactor</option> directive allows you to customize how long to cache a document that does not have any expiration date specified, but that provides information about the date of its last modification. It takes the following form:
@@ -906,7 +1193,14 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>CacheMaxExpire</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>CacheMaxExpire</option></tertiary>
+ </indexterm>
+ <option>CacheMaxExpire</option>
+ </term>
<listitem>
<para>
The <option>CacheMaxExpire</option> directive allows you to specify the maximum amount of time to cache a document. It takes the following form:
@@ -922,7 +1216,14 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>CacheNegotiatedDocs</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>CacheNegotiatedDocs</option></tertiary>
+ </indexterm>
+ <option>CacheNegotiatedDocs</option>
+ </term>
<listitem>
<para>
The <option>CacheNegotiatedDocs</option> directive allows you to enable caching of the documents that were negotiated on the basis of content. It takes the following form:
@@ -973,12 +1274,24 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>CacheRoot</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>CacheRoot</option></tertiary>
+ </indexterm>
+ <option>CacheRoot</option>
+ </term>
<listitem>
<para>
The <option>CacheRoot</option> directive allows you to specify the directory to store cache files in. It takes the following form:
</para>
<screen>CacheRoot <replaceable>directory</replaceable></screen>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directories</secondary>
+ <tertiary><filename class="directory">/var/cache/mod_proxy/</filename></tertiary>
+ </indexterm>
<para>
The <replaceable>directory</replaceable> must be a full path to an existing directory in the local file system. The default option is <filename class="directory">/var/cache/mod_proxy/</filename>.
</para>
@@ -989,12 +1302,24 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>CustomLog</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>CustomLog</option></tertiary>
+ </indexterm>
+ <option>CustomLog</option>
+ </term>
<listitem>
<para>
The <option>CustomLog</option> directive allows you to specify the log filename and the log file format. It takes the following form:
</para>
<screen>CustomLog <replaceable>path</replaceable> <replaceable>format</replaceable></screen>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>files</secondary>
+ <tertiary><filename>/etc/httpd/logs/access_log</filename></tertiary>
+ </indexterm>
<para>
The <replaceable>path</replaceable> refers to a log file, and must be relative to the directory that is specified by the <option>ServerRoot</option> directive (that is, <filename class="directory">/etc/httpd/</filename> by default). The <replaceable>format</replaceable> has to be either an explicit format string, or a format name that was previously defined using the <option>LogFormat</option> directive.
</para>
@@ -1005,7 +1330,14 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>DefaultIcon</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>DefaultIcon</option></tertiary>
+ </indexterm>
+ <option>DefaultIcon</option>
+ </term>
<listitem>
<para>
The <option>DefaultIcon</option> directive allows you to specify an icon to be displayed for a file in server-generated directory listings when no other icon is associated with it. It takes the following form:
@@ -1021,7 +1353,14 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>DefaultType</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>DefaultType</option></tertiary>
+ </indexterm>
+ <option>DefaultType</option>
+ </term>
<listitem>
<para>
The <option>DefaultType</option> directive allows you to specify a media type to be used in case the proper MIME type cannot be determined by the server. It takes the following form:
@@ -1037,7 +1376,14 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>Deny</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>Deny</option></tertiary>
+ </indexterm>
+ <option>Deny</option>
+ </term>
<listitem>
<para>
The <option>Deny</option> directive allows you to specify which clients are denied access to a given directory. It takes the following form:
@@ -1053,7 +1399,14 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>DirectoryIndex</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>DirectoryIndex</option></tertiary>
+ </indexterm>
+ <option>DirectoryIndex</option>
+ </term>
<listitem>
<para>
The <option>DirectoryIndex</option> directive allows you to specify a document to be served to a client when a directory is requested (that is, when the URL ends with the <literal>/</literal> character). It takes the following form:
@@ -1069,12 +1422,24 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>DocumentRoot</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>DocumentRoot</option></tertiary>
+ </indexterm>
+ <option>DocumentRoot</option>
+ </term>
<listitem>
<para>
The <option>DocumentRoot</option> directive allows you to specify the main directory from which the content is served. It takes the following form:
</para>
<screen>DocumentRoot <replaceable>directory</replaceable></screen>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directories</secondary>
+ <tertiary><filename class="directory">/var/www/html/</filename></tertiary>
+ </indexterm>
<para>
The <replaceable>directory</replaceable> must be a full path to an existing directory in the local file system. The default option is <filename class="directory">/var/www/html/</filename>.
</para>
@@ -1085,7 +1450,14 @@ Syntax OK</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>ErrorDocument</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>ErrorDocument</option></tertiary>
+ </indexterm>
+ <option>ErrorDocument</option>
+ </term>
<listitem>
<para>
The <option>ErrorDocument</option> directive allows you to specify a document or a message to be displayed as a response to a particular error. It takes the following form:
@@ -1102,12 +1474,24 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>ErrorLog</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>ErrorLog</option></tertiary>
+ </indexterm>
+ <option>ErrorLog</option>
+ </term>
<listitem>
<para>
The <option>ErrorLog</option> directive allows you to specify a file to which the server errors are logged. It takes the following form:
</para>
<screen>ErrorLog <replaceable>path</replaceable></screen>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>files</secondary>
+ <tertiary><filename>/etc/httpd/logs/error_log</filename></tertiary>
+ </indexterm>
<para>
The <replaceable>path</replaceable> refers to a log file, and can be either absolute, or relative to the directory that is specified by the <option>ServerRoot</option> directive (that is, <filename class="directory">/etc/httpd/</filename> by default). The default option is <filename>logs/error_log</filename>
</para>
@@ -1118,7 +1502,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>ExtendedStatus</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>ExtendedStatus</option></tertiary>
+ </indexterm>
+ <option>ExtendedStatus</option>
+ </term>
<listitem>
<para>
The <option>ExtendedStatus</option> directive allows you to enable detailed server status information. It takes the following form:
@@ -1169,7 +1560,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>Group</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>Group</option></tertiary>
+ </indexterm>
+ <option>Group</option>
+ </term>
<listitem>
<para>
The <option>Group</option> directive allows you to specify the group under which the <systemitem class="service">httpd</systemitem> service will run. It takes the following form:
@@ -1188,7 +1586,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>HeaderName</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>HeaderName</option></tertiary>
+ </indexterm>
+ <option>HeaderName</option>
+ </term>
<listitem>
<para>
The <option>HeaderName</option> directive allows you to specify a file to be prepended to the beginning of the server-generated directory listing. It takes the following form:
@@ -1204,7 +1609,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>HostnameLookups</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>HostnameLookups</option></tertiary>
+ </indexterm>
+ <option>HostnameLookups</option>
+ </term>
<listitem>
<para>
The <option>HostnameLookups</option> directive allows you to enable automatic resolving of IP addresses. It takes the following form:
@@ -1266,12 +1678,24 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>Include</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>Include</option></tertiary>
+ </indexterm>
+ <option>Include</option>
+ </term>
<listitem>
<para>
The <option>Include</option> directive allows you to include other configuration files. It takes the following form:
</para>
<screen>Include <replaceable>filename</replaceable></screen>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directories</secondary>
+ <tertiary><filename class="directory">/etc/httpd/conf.d/</filename></tertiary>
+ </indexterm>
<para>
The <option>filename</option> can be an absolute path, a path relative to the directory specified by the <option>ServerRoot</option> directive, or a wildcard expression. All configuration files from the <filename class="directory">/etc/httpd/conf.d/</filename> directory are loaded by default.
</para>
@@ -1282,7 +1706,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>IndexIgnore</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>IndexIgnore</option></tertiary>
+ </indexterm>
+ <option>IndexIgnore</option>
+ </term>
<listitem>
<para>
The <option>IndexIgnore</option> directive allows you to specify a list of filenames to be omitted from the server-generated directory listings. It takes the following form:
@@ -1298,7 +1729,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>IndexOptions</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>IndexOptions</option></tertiary>
+ </indexterm>
+ <option>IndexOptions</option>
+ </term>
<listitem>
<para>
The <option>IndexOptions</option> directive allows you to customize the behavior of server-generated directory listings. It takes the following form:
@@ -1525,7 +1963,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>KeepAlive</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>KeepAlive</option></tertiary>
+ </indexterm>
+ <option>KeepAlive</option>
+ </term>
<listitem>
<para>
The <option>KeepAlive</option> directive allows you to enable persistent connections. It takes the following form:
@@ -1579,7 +2024,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>KeepAliveTimeout</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>KeepAliveTimeout</option></tertiary>
+ </indexterm>
+ <option>KeepAliveTimeout</option>
+ </term>
<listitem>
<para>
The <option>KeepAliveTimeout</option> directive allows you to specify the amount of time to wait for another request before closing the connection. It takes the following form:
@@ -1595,7 +2047,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>LanguagePriority</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>LanguagePriority</option></tertiary>
+ </indexterm>
+ <option>LanguagePriority</option>
+ </term>
<listitem>
<para>
The <option>LanguagePriority</option> directive allows you to customize the precedence of languages. It takes the following form:
@@ -1614,7 +2073,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>Listen</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>Listen</option></tertiary>
+ </indexterm>
+ <option>Listen</option>
+ </term>
<listitem>
<para>
The <replaceable>Listen</replaceable> directive allows you to specify IP addresses or ports to listen to. It takes the following form:
@@ -1633,12 +2099,29 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>LoadModule</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>LoadModule</option></tertiary>
+ </indexterm>
+ <option>LoadModule</option>
+ </term>
<listitem>
<para>
The <option>LoadModule</option> directive allows you to load a <firstterm>Dynamic Shared Object</firstterm> (<acronym>DSO</acronym>) module. It takes the following form:
</para>
<screen>LoadModule <replaceable>name</replaceable> <replaceable>path</replaceable></screen>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directories</secondary>
+ <tertiary><filename class="directory">/usr/lib/httpd/modules/</filename></tertiary>
+ </indexterm>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directories</secondary>
+ <tertiary><filename class="directory">/usr/lib64/httpd/modules/</filename></tertiary>
+ </indexterm>
<para>
The <replaceable>name</replaceable> has to be a valid identifier of the required module. The <replaceable>path</replaceable> refers to an existing module file, and must be relative to the directory in which the libraries are placed (that is, <filename class="directory">/usr/lib/httpd/</filename> on 32-bit and <filename class="directory">/usr/lib64/httpd/</filename> on 64-bit systems by default).
</para>
@@ -1652,7 +2135,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>LogFormat</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>LogFormat</option></tertiary>
+ </indexterm>
+ <option>LogFormat</option>
+ </term>
<listitem>
<para>
The <replaceable>LogFormat</replaceable> directive allows you to specify a log file format. It takes the following form:
@@ -1751,7 +2241,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>LogLevel</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>LogLevel</option></tertiary>
+ </indexterm>
+ <option>LogLevel</option>
+ </term>
<listitem>
<para>
The <option>LogLevel</option> directive allows you to customize the verbosity level of the error log. It takes the following form:
@@ -1850,7 +2347,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>MaxKeepAliveRequests</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>MaxKeepAliveRequests</option></tertiary>
+ </indexterm>
+ <option>MaxKeepAliveRequests</option>
+ </term>
<listitem>
<para>
The <option>MaxKeepAliveRequests</option> directive allows you to specify the maximum number of requests for a persistent connection. It takes the following form:
@@ -1866,7 +2370,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>NameVirtualHost</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>NameVirtualHost</option></tertiary>
+ </indexterm>
+ <option>NameVirtualHost</option>
+ </term>
<listitem>
<para>
The <option>NameVirtualHost</option> directive allows you to specify the IP address and port number for a name-based virtual host. It takes the following form:
@@ -1891,7 +2402,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>Options</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>Options</option></tertiary>
+ </indexterm>
+ <option>Options</option>
+ </term>
<listitem>
<para>
The <option>Options</option> directive allows you to specify which server features are available in a particular directory. It takes the following form:
@@ -1998,7 +2516,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>Order</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>Order</option></tertiary>
+ </indexterm>
+ <option>Order</option>
+ </term>
<listitem>
<para>
The <option>Order</option> directive allows you to specify the order in which the <option>Allow</option> and <option>Deny</option> directives are evaluated. It takes the following form:
@@ -2049,12 +2574,24 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>PidFile</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>PidFile</option></tertiary>
+ </indexterm>
+ <option>PidFile</option>
+ </term>
<listitem>
<para>
- The <option>PidFile</option> directive allows you to specify a file to which the process ID (PID) of the server is stored. It takes the following form:
+ The <option>PidFile</option> directive allows you to specify a file to which the <firstterm>process ID</firstterm> (<acronym>PID</acronym>) of the server is stored. It takes the following form:
</para>
<screen>PidFile <replaceable>path</replaceable></screen>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>files</secondary>
+ <tertiary><filename>/etc/httpd/run/httpd.pid</filename></tertiary>
+ </indexterm>
<para>
The <replaceable>path</replaceable> refers to a pid file, and can be either absolute, or relative to the directory that is specified by the <option>ServerRoot</option> directive (that is, <filename class="directory">/etc/httpd/</filename> by default). The default option is <filename>run/httpd.pid</filename>.
</para>
@@ -2065,7 +2602,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>ProxyRequests</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>ProxyRequests</option></tertiary>
+ </indexterm>
+ <option>ProxyRequests</option>
+ </term>
<listitem>
<para>
The <option>ProxyRequests</option> directive allows you to enable forward proxy requests. It takes the following form:
@@ -2116,7 +2660,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>ReadmeName</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>ReadmeName</option></tertiary>
+ </indexterm>
+ <option>ReadmeName</option>
+ </term>
<listitem>
<para>
The <option>ReadmeName</option> directive allows you to specify a file to be appended to the end of the server-generated directory listing. It takes the following form:
@@ -2132,7 +2683,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>Redirect</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>Redirect</option></tertiary>
+ </indexterm>
+ <option>Redirect</option>
+ </term>
<listitem>
<para>
The <option>Redirect</option> directive allows you to redirect a client to another URL. It takes the following form:
@@ -2192,6 +2750,11 @@ ErrorDocument 404 /404-not_found.html</screen>
</tbody>
</tgroup>
</table>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>modules</secondary>
+ <tertiary><systemitem class="resource">mod_rewrite</systemitem></tertiary>
+ </indexterm>
<para>
Note that for more advanced redirection techniques, you can use the <systemitem class="resource">mod_rewrite</systemitem> module that is part of the Apache HTTP Server installation.
</para>
@@ -2202,7 +2765,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>ScriptAlias</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>ScriptAlias</option></tertiary>
+ </indexterm>
+ <option>ScriptAlias</option>
+ </term>
<listitem>
<para>
The <option>ScriptAlias</option> directive allows you to specify the location of CGI scripts. It takes the following form:
@@ -2211,6 +2781,11 @@ ErrorDocument 404 /404-not_found.html</screen>
<para>
The <replaceable>url-path</replaceable> must be relative to the directory specified by the <option>DocumentRoot</option> directive (for example, <literal>/cgi-bin/</literal>). The <replaceable>real-path</replaceable> is a full path to a file or directory in the local file system.
</para>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directories</secondary>
+ <tertiary><filename class="directory">/var/www/cgi-bin/</filename></tertiary>
+ </indexterm>
<para>
This directive is typically followed by the <option>Directory</option> tag with additional permissions to access the target directory. By default, the <literal>/cgi-bin/</literal> alias is created so that the scripts located in the <filename class="directory">/var/www/cgi-bin/</filename> are accessible.
</para>
@@ -2231,7 +2806,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>ServerAdmin</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>ServerAdmin</option></tertiary>
+ </indexterm>
+ <option>ServerAdmin</option>
+ </term>
<listitem>
<para>
The <option>ServerAdmin</option> directive allows you to specify the email address of the server administrator to be displayed in server-generated web pages. It takes the following form:
@@ -2250,7 +2832,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>ServerName</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>ServerName</option></tertiary>
+ </indexterm>
+ <option>ServerName</option>
+ </term>
<listitem>
<para>
The <option>ServerName</option> directive allows you to specify the hostname and the port number of a web server. It takes the following form:
@@ -2269,12 +2858,24 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>ServerRoot</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>ServerRoot</option></tertiary>
+ </indexterm>
+ <option>ServerRoot</option>
+ </term>
<listitem>
<para>
The <option>ServerRoot</option> directive allows you to specify the directory in which the server operates. It takes the following form:
</para>
<screen>ServerRoot <replaceable>directory</replaceable></screen>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directories</secondary>
+ <tertiary><filename class="directory">/etc/httpd/</filename></tertiary>
+ </indexterm>
<para>
The <replaceable>directory</replaceable> must be a full path to an existing directory in the local file system. The default option is <filename class="directory">/etc/httpd/</filename>.
</para>
@@ -2285,7 +2886,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>ServerSignature</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>ServerSignature</option></tertiary>
+ </indexterm>
+ <option>ServerSignature</option>
+ </term>
<listitem>
<para>
The <option>ServerSignature</option> directive allows you to enable displaying information about the server on server-generated documents. It takes the following form:
@@ -2344,7 +2952,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>ServerTokens</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>ServerTokens</option></tertiary>
+ </indexterm>
+ <option>ServerTokens</option>
+ </term>
<listitem>
<para>
The <option>ServerTokens</option> directive allows you to customize what information are included in the Server response header. It takes the following form:
@@ -2430,7 +3045,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>SuexecUserGroup</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>SuexecUserGroup</option></tertiary>
+ </indexterm>
+ <option>SuexecUserGroup</option>
+ </term>
<listitem>
<para>
The <option>SuexecUserGroup</option> directive allows you to specify the user and group under which the CGI scripts will be run. It takes the following form:
@@ -2449,7 +3071,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>Timeout</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>Timeout</option></tertiary>
+ </indexterm>
+ <option>Timeout</option>
+ </term>
<listitem>
<para>
The <option>Timeout</option> directive allows you to specify the amount of time to wait for an event before closing a connection. It takes the following form:
@@ -2465,12 +3094,24 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>TypesConfig</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>TypesConfig</option></tertiary>
+ </indexterm>
+ <option>TypesConfig</option>
+ </term>
<listitem>
<para>
The <option>TypesConfig</option> allows you to specify the location of the MIME types configuration file. It takes the following form:
</para>
<screen>TypesConfig <replaceable>path</replaceable></screen>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>files</secondary>
+ <tertiary><filename>/etc/mime.types</filename></tertiary>
+ </indexterm>
<para>
The <replaceable>path</replaceable> refers to an existing MIME types configuration file, and can be either absolute, or relative to the directory that is specified by the <option>ServerRoot</option> directive (that is, <filename class="directory">/etc/httpd/</filename> by default). The default option is <option>/etc/mime.types</option>.
</para>
@@ -2484,7 +3125,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>UseCanonicalName</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>UseCanonicalName</option></tertiary>
+ </indexterm>
+ <option>UseCanonicalName</option>
+ </term>
<listitem>
<para>
The <option>UseCanonicalName</option> allows you to specify the way the server refers to itself. It takes the following form:
@@ -2543,7 +3191,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>User</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>User</option></tertiary>
+ </indexterm>
+ <option>User</option>
+ </term>
<listitem>
<para>
The <option>User</option> directive allows you to specify the user under which the <systemitem class="service">httpd</systemitem> service will run. It takes the following form:
@@ -2562,12 +3217,24 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>UserDir</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>UserDir</option></tertiary>
+ </indexterm>
+ <option>UserDir</option>
+ </term>
<listitem>
<para>
The <option>UserDir</option> directive allows you to enable serving content from users' home directories. It takes the following form:
</para>
<screen>UserDir <replaceable>option</replaceable></screen>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directories</secondary>
+ <tertiary><filename class="directory">~/public_html/</filename></tertiary>
+ </indexterm>
<para>
The <replaceable>option</replaceable> can be either a name of the directory to look for in user's home directory (typically <option>public_html</option>), or a valid keyword as described in <xref linkend="table-apache-httpdconf-userdir" />. The default option is <option>disabled</option>.
</para>
@@ -2630,12 +3297,24 @@ ErrorDocument 404 /404-not_found.html</screen>
<para>
The <firstterm>Secure Sockets Layer</firstterm> (<acronym>SSL</acronym>) directives allow you to customize the behavior of the Apache HTTP Secure Server, and in most cases, they are configured appropriately during the installation. Be careful when changing these settings, as incorrect configuration can lead to security vulnerabilities.
</para>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>files</secondary>
+ <tertiary><filename>/etc/httpd/conf.d/ssl.conf</filename></tertiary>
+ </indexterm>
<para>
The following directive is commonly used in <filename>/etc/httpd/conf.d/ssl.conf</filename>:
</para>
<variablelist>
<varlistentry>
- <term><option>SetEnvIf</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>SetEnvIf</option></tertiary>
+ </indexterm>
+ <option>SetEnvIf</option>
+ </term>
<listitem>
<para>
The <option>SetEnvIf</option> directive allows you to set environment variables based on the headers of incoming connections. It takes the following form:
@@ -2729,12 +3408,24 @@ ErrorDocument 404 /404-not_found.html</screen>
<para>
The <firstterm>Multi-Processing Module</firstterm> (<acronym>MPM</acronym>) directives allow you to customize the behavior of a particular MPM specific server-pool. Since its characteristics differ depending on which MPM is used, the directives are embeded in <option>IfModule</option>. By default, the server-pool is defined for both the <systemitem class="resource">prefork</systemitem> and <systemitem class="resource">worker</systemitem> MPMs.
</para>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>files</secondary>
+ <tertiary><filename>/etc/httpd/conf/httpd.conf</filename></tertiary>
+ </indexterm>
<para>
The following MPM directives are commonly used in <filename>/etc/httpd/conf/httpd.conf</filename>:
</para>
<variablelist>
<varlistentry>
- <term><option>MaxClients</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>MaxClients</option></tertiary>
+ </indexterm>
+ <option>MaxClients</option>
+ </term>
<listitem>
<para>
The <option>MaxClients</option> directive allows you to specify the maximum number of simultaneously connected clients to process at one time. It takes the following form:
@@ -2750,7 +3441,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>MaxRequestsPerChild</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>MaxClients</option></tertiary>
+ </indexterm>
+ <option>MaxRequestsPerChild</option>
+ </term>
<listitem>
<para>
The <option>MaxRequestsPerChild</option> directive allows you to specify the maximum number of request a child process can serve before it dies. It takes the following form:
@@ -2769,7 +3467,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>MaxSpareServers</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>MaxSpareServers</option></tertiary>
+ </indexterm>
+ <option>MaxSpareServers</option>
+ </term>
<listitem>
<para>
The <option>MaxSpareServers</option> directive allows you to specify the maximum number of spare child processes. It takes the following form:
@@ -2785,7 +3490,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>MaxSpareThreads</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>MaxSpareThreads</option></tertiary>
+ </indexterm>
+ <option>MaxSpareThreads</option>
+ </term>
<listitem>
<para>
The <option>MaxSpareThreads</option> directive allows you to specify the maximum number of spare server threads. It takes the following form:
@@ -2801,7 +3513,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>MinSpareServers</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>MinSpareServers</option></tertiary>
+ </indexterm>
+ <option>MinSpareServers</option>
+ </term>
<listitem>
<para>
The <option>MinSpareServers</option> directive allows you to specify the minimum number of spare child processes. It takes the following form:
@@ -2817,7 +3536,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>MinSpareThreads</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>MinSpareThreads</option></tertiary>
+ </indexterm>
+ <option>MinSpareThreads</option>
+ </term>
<listitem>
<para>
The <option>MinSpareThreads</option> directive allows you to specify the minimum number of spare server threads. It takes the following form:
@@ -2833,7 +3559,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>StartServers</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>StartServers</option></tertiary>
+ </indexterm>
+ <option>StartServers</option>
+ </term>
<listitem>
<para>
The <option>StartServers</option> directive allows you to specify the number of child processes to create when the service is started. It takes the following form:
@@ -2849,7 +3582,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>ThreadsPerChild</option></term>
+ <term>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directives</secondary>
+ <tertiary><option>ThreadsPerChild</option></tertiary>
+ </indexterm>
+ <option>ThreadsPerChild</option>
+ </term>
<listitem>
<para>
The <option>ThreadsPerChild</option> directive allows you to specify the number of threads a child process can create. It takes the following form:
@@ -2869,11 +3609,26 @@ ErrorDocument 404 /404-not_found.html</screen>
</section>
<section id="s1-apache-dso">
<title>Working with Modules</title>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directories</secondary>
+ <tertiary><filename class="directory">/usr/lib/httpd/modules/</filename></tertiary>
+ </indexterm>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>directories</secondary>
+ <tertiary><filename class="directory">/usr/lib64/httpd/modules/</filename></tertiary>
+ </indexterm>
<para>
Being a modular application, the <systemitem class="service">httpd</systemitem> service is distributed along with a number of <firstterm>Dynamic Shared Objects</firstterm> (<acronym>DSO</acronym>s), which can be dynamically loaded or unloaded at runtime as necessary. By default, these modules are located in <filename class="directory">/usr/lib/httpd/modules/</filename> on 32-bit and in <filename class="directory">/usr/lib64/httpd/modules/</filename> on 64-bit systems.
</para>
<section id="s2-apache-dso-loading">
<title>Loading a Module</title>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>modules</secondary>
+ <tertiary>loading</tertiary>
+ </indexterm>
<para>
To load a particular DSO module, use the <option>LoadModule</option> directive as described in <xref linkend="s2-apache-httpdconf-directives" />. Note that modules provided by a separate package often have their own configuration file in the <filename class="directory">/etc/httpd/conf.d/</filename> directory.
</para>
@@ -2887,6 +3642,11 @@ ErrorDocument 404 /404-not_found.html</screen>
</section>
<section id="s2-apache-dso-writing">
<title>Writing a Module</title>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>modules</secondary>
+ <tertiary>developing</tertiary>
+ </indexterm>
<para>
If you intend to create a new DSO module, make sure you have the <package>httpd-devel</package> package installed. To do so, type the following at a shell prompt:
</para>
@@ -2905,6 +3665,14 @@ ErrorDocument 404 /404-not_found.html</screen>
</section>
<section id="s1-apache-virtualhosts">
<title>Setting Up Virtual Hosts</title>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>virtual host</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>virtual host</primary>
+ <see><application>Apache HTTP Server</application></see>
+ </indexterm>
<para>
The Apache HTTP Server's built in virtual hosting allows the server to provide different information based on which IP address, hostname, or port is being requested.
</para>
@@ -2938,6 +3706,33 @@ ErrorDocument 404 /404-not_found.html</screen>
</section>
<section id="s1-apache-mod_ssl">
<title>Setting Up an SSL Server</title>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>modules</secondary>
+ <tertiary><systemitem class="resource">mod_ssl</systemitem></tertiary>
+ </indexterm>
+ <indexterm>
+ <primary>SSL server</primary>
+ <see><application>Apache HTTP Server</application></see>
+ </indexterm>
+ <indexterm>
+ <primary><acronym>SSL</acronym></primary>
+ <seealso><application>Apache HTTP Server</application></seealso>
+ </indexterm>
+ <indexterm>
+ <primary><acronym>TLS</acronym></primary>
+ <seealso><application>Apache HTTP Server</application></seealso>
+ </indexterm>
+ <indexterm>
+ <primary>OpenSSL</primary>
+ <secondary><acronym>SSL</acronym></secondary>
+ <see><acronym>SSL</acronym></see>
+ </indexterm>
+ <indexterm>
+ <primary>OpenSSL</primary>
+ <secondary><acronym>TLS</acronym></secondary>
+ <see><acronym>TLS</acronym></see>
+ </indexterm>
<para>
<firstterm>Secure Sockets Layer</firstterm> (<acronym>SSL</acronym>) is a cryptographic protocol that allows a server and a client to communicate securely. Along with its extended and improved version called <firstterm>Transport Layer Security</firstterm> (<acronym>TLS</acronym>), it ensures both privacy and data integrity. The Apache HTTP Server in combination with <systemitem class="resource">mod_ssl</systemitem>, a module that uses the OpenSSL toolkit to provide the SSL/TLS support, is commonly referred to as the <firstterm>SSL server</firstterm>.
</para>
@@ -2946,9 +3741,29 @@ ErrorDocument 404 /404-not_found.html</screen>
</para>
<section id="s2-apache-mod_ssl-certificates">
<title>An Overview of Certificates and Security</title>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>SSL server</secondary>
+ <tertiary>private key</tertiary>
+ </indexterm>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>SSL server</secondary>
+ <tertiary>public key</tertiary>
+ </indexterm>
<para>
Secure communication is based on the use of keys. In conventional or <firstterm>symmetric cryptography</firstterm>, both ends of the transaction have the same key they can use to decode each other's transmissions. On the other hand, in public or <firstterm>asymmetric cryptography</firstterm>, two keys co-exist: a <firstterm>private key</firstterm> that is kept a secret, and a <firstterm>public key</firstterm> that is usually shared with the public. While the data encoded with the public key can only be decoded with the private key, data encoded with the private key can in turn only be decoded with the public key.
</para>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>SSL server</secondary>
+ <tertiary>certificate</tertiary>
+ </indexterm>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>SSL server</secondary>
+ <tertiary>certificate authority</tertiary>
+ </indexterm>
<para>
To provide secure communications using SSL, an SSL server must use a digital certificate signed by a <firstterm>Certificate Authority</firstterm> (<acronym>CA</acronym>). The certificate lists various attributes of the server (that is, the server hostname, the name of the company, its location, etc.), and the signature produced using the CA's private key. This signature ensures that a particular certificate authority has issued the certificate, and that the certificate has not been modified in any way.
</para>
@@ -3011,12 +3826,27 @@ ErrorDocument 404 /404-not_found.html</screen>
If you intend to set up an SSL server, make sure you have the <package>mod_ssl</package> (the <systemitem class="resource">mod_ssl</systemitem> module) and <package>openssl</package> (the OpenSSL toolkit) packages installed. To do so, type the following at a shell prompt:
</para>
<screen>~]# <command>yum install mod_ssl openssl</command></screen>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>files</secondary>
+ <tertiary><filename>/etc/httpd/conf.d/ssl.conf</filename></tertiary>
+ </indexterm>
<para>
This will create the <systemitem class="resource">mod_ssl</systemitem> configuration file at <filename>/etc/httpd/conf.d/ssl.conf</filename>, which is included in the main Apache HTTP Server configuration file by default. For the module to be loaded, restart the <systemitem class="service">httpd</systemitem> service as described in <xref linkend="s3-apache-running-restarting" />.
</para>
</section>
<section id="s2-apache-mod_ssl-keypair">
<title>Using an Existing Key and Certificate</title>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>SSL server</secondary>
+ <tertiary>private key</tertiary>
+ </indexterm>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>SSL server</secondary>
+ <tertiary>certificate</tertiary>
+ </indexterm>
<para>
If you have a previously created key and certificate, you can configure the SSL server to use these files instead of generating new ones. There are only two situations where this is not possible:
</para>
@@ -3062,6 +3892,16 @@ SSLCertificateKeyFile /etc/pki/tls/private/<replaceable>hostname</replaceable>.k
</section>
<section id="s2-apache-mod_ssl-genkey">
<title>Generating a New Key and Certificate</title>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>SSL server</secondary>
+ <tertiary>private key</tertiary>
+ </indexterm>
+ <indexterm>
+ <primary><application>Apache HTTP Server</application></primary>
+ <secondary>SSL server</secondary>
+ <tertiary>certificate</tertiary>
+ </indexterm>
<para>
In order to generate a new key and certificate pair, you must to have the <package>crypto-utils</package> package installed in your system. You can install it by typing the following at a shell prompt:
</para>
More information about the docs-commits
mailing list