core.xml.es revision dab8f7bd6e7dcf38489845dbce884de6f4436abf
842ae4bd224140319ae7feec1872b93dfd491143fielding<?xml version="1.0"?>
842ae4bd224140319ae7feec1872b93dfd491143fielding<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
842ae4bd224140319ae7feec1872b93dfd491143fielding<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
842ae4bd224140319ae7feec1872b93dfd491143fielding<!-- English Revision: 1040494:1351967 (outdated) -->
842ae4bd224140319ae7feec1872b93dfd491143fielding
842ae4bd224140319ae7feec1872b93dfd491143fielding<!--
2d2eda71267231c2526be701fe655db125852c1ffielding Licensed to the Apache Software Foundation (ASF) under one or more
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd contributor license agreements. See the NOTICE file distributed with
2d2eda71267231c2526be701fe655db125852c1ffielding this work for additional information regarding copyright ownership.
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd The ASF licenses this file to You under the Apache License, Version 2.0
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd (the "License"); you may not use this file except in compliance with
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd the License. You may obtain a copy of the License at
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd http://www.apache.org/licenses/LICENSE-2.0
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding Unless required by applicable law or agreed to in writing, software
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben distributed under the License is distributed on an "AS IS" BASIS,
0432a26b69eedfb9ca5f34fba590236378a24851ben WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0432a26b69eedfb9ca5f34fba590236378a24851ben See the License for the specific language governing permissions and
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh limitations under the License.
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh-->
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<modulesynopsis metafile="core.xml.meta">
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<name>core</name>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<description>Funcionalides b&#225;sicas del Servidor HTTP Apache que siempre est&#225;n presentes.</description>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<status>Core</status>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<directivesynopsis>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<name>AcceptFilter</name>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<description>Configura mejoras para un Protocolo de Escucha de Sockets</description>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<syntax>AcceptFilter <var>protocol</var> <var>accept_filter</var></syntax>
2d2eda71267231c2526be701fe655db125852c1ffielding<contextlist><context>server config</context></contextlist>
2d2eda71267231c2526be701fe655db125852c1ffielding<compatibility>Disponible en Apache httpd 2.1.5 y posteriores.
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianhEn Windows desde Apache httpd 2.3.3 y posteriores.</compatibility>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<usage>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <p>Esta directiva hace posible mejoras espec&#237;ficas a nivel de sistema operativo
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb y a trav&#233;s del tipo de Protocolo para un socket que escucha.
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb La premisa b&#225;sica es que el kernel no env&#237;e un socket al servidor
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb hasta que o bien los datos se hayan recibido o bien se haya almacenado
2d2eda71267231c2526be701fe655db125852c1ffielding en el buffer una Respuesta HTTP completa.
30c289e6bc6d28d210b21edd800ab2cfc78a8381wrowe Actualmente s&#243;lo est&#225;n soportados
cccd31fa4a72fe23cc3249c06db181b274a55a69gstein <a href="http://www.freebsd.org/cgi/man.cgi?query=accept_filter&amp;sektion=9">
cccd31fa4a72fe23cc3249c06db181b274a55a69gstein Accept Filters</a> sobre FreeBSD, <code>TCP_DEFER_ACCEPT</code> sobre Linux,
cd39d2139743ca0ef899953c6496dcf99e9c791atrawick y AcceptEx() sobre Windows.</p>
cccd31fa4a72fe23cc3249c06db181b274a55a69gstein
a261b81a1044c0e2ea3f21cf9b7019297bad16aajorton <p>El uso de <code>none</code> para un argumento desactiva cualquier filtro
b627048681b27fe30f979ba471b523be3a6a22adrbb aceptado para ese protocolo. Esto es &#250;til para protocolos que requieren que un
cccd31fa4a72fe23cc3249c06db181b274a55a69gstein servidor env&#237;e datos primeros, tales como <code>ftp:</code> o <code>nntp</code>:</p>
cccd31fa4a72fe23cc3249c06db181b274a55a69gstein <example>AcceptFilter nntp none</example>
44c46ef733836b32585d135d2d90856e7cfd9929rbb
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <p>Los nombres de protocolo por defecto son <code>https</code> para el puerto 443
e6cc28a5eb3371ba0c38e941855e71ff0054f50erbb y <code>http</code> para todos los dem&#225;s puertos. Para especificar que se est&#225;
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna utilizando otro protocolo con un puerto escuchando, a&#241;ade el argumento <var>protocol</var>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb a la directiva <directive module="mpm_common">Listen</directive>.</p>
9cfc48b742c224c1fbc2c26a4119a3266192c7d2wrowe
9cfc48b742c224c1fbc2c26a4119a3266192c7d2wrowe <p>Sobre FreeBDS los valores por defecto:</p>
ef5650b61a8e35f3cc93ec07e73efc17ea329894jorton <example>
7c7372abe2484e7fcf81937b93496d1246e5b816gstein AcceptFilter http httpready <br/>
a261b81a1044c0e2ea3f21cf9b7019297bad16aajorton AcceptFilter https dataready
a261b81a1044c0e2ea3f21cf9b7019297bad16aajorton </example>
a261b81a1044c0e2ea3f21cf9b7019297bad16aajorton
a261b81a1044c0e2ea3f21cf9b7019297bad16aajorton <p>El filtro <code>httpready</code> almacena en el buffer peticiones HTTP completas
d71fd7cd9c4815d0647425f21ba3a803919a9148jorton a nivel de kernel. Una vez que la petici&#243;n es recibida, el kernel la env&#237;a al servidor.
7c7372abe2484e7fcf81937b93496d1246e5b816gstein Consulta la p&#225;gina man de
7c7372abe2484e7fcf81937b93496d1246e5b816gstein <a href="http://www.freebsd.org/cgi/man.cgi?query=accf_http&amp;sektion=9">
7c7372abe2484e7fcf81937b93496d1246e5b816gstein accf_http(9)</a> para m&#225;s detalles. Puesto que las peticiones HTTPS
7c7372abe2484e7fcf81937b93496d1246e5b816gstein est&#225;n encriptadas, s&#243;lo se utiliza el filtro
7c7372abe2484e7fcf81937b93496d1246e5b816gstein <a href="http://www.freebsd.org/cgi/man.cgi?query=accf_data&amp;sektion=9">accf_data(9)</a>.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>Sobre Linux los valores por defecto son:</p>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <example>
2d2eda71267231c2526be701fe655db125852c1ffielding AcceptFilter http data <br/>
2d2eda71267231c2526be701fe655db125852c1ffielding AcceptFilter https data
2d2eda71267231c2526be701fe655db125852c1ffielding </example>
2d2eda71267231c2526be701fe655db125852c1ffielding
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <p>En Linux, <code>TCP_DEFER_ACCEPT</code> no soporta el buffering en peticiones http.
2d2eda71267231c2526be701fe655db125852c1ffielding Cualquier valor adem&#225;s de <code>none</code> habilitar&#225;
2d2eda71267231c2526be701fe655db125852c1ffielding <code>TCP_DEFER_ACCEPT</code> en ese socket. Para m&#225;s detalles
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh ver la p&#225;gina man de Linux
2d2eda71267231c2526be701fe655db125852c1ffielding <a href="http://homepages.cwi.nl/~aeb/linux/man2html/man7/tcp.7.html">
2e123e8beedc9f921448c113e2d6823a92fd5261fielding tcp(7)</a>.</p>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
2d2eda71267231c2526be701fe655db125852c1ffielding <p>Sobre Windows los valores por defecto son:</p>
dd5cbadf2df719db2f3c769d03ec847da25854e6bnicholes <example>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh AcceptFilter http data <br/>
dd5cbadf2df719db2f3c769d03ec847da25854e6bnicholes AcceptFilter https data
2d2eda71267231c2526be701fe655db125852c1ffielding </example>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
2d2eda71267231c2526be701fe655db125852c1ffielding <p>Sobre Windows mpm_winnt interpreta el argumento AcceptFilter para conmutar la API
2d2eda71267231c2526be701fe655db125852c1ffielding AcceptEx(), y no soporta el buffering sobre el protocolo http. Hay dos valores
2d2eda71267231c2526be701fe655db125852c1ffielding que utilizan la API Windows AcceptEx() y que recuperan sockets de red
2d2eda71267231c2526be701fe655db125852c1ffielding entre conexciones. <code>data</code> espera hasta que los datos han sido
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb transmitidos como se comentaba anteriormente, y el buffer inicial de datos y las
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb direcciones de red son recuperadas a partir de una &#250;nica llamada AcceptEx().
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <code>connect</code> utiliza la API AcceptEx() API, y recupera tambi&#233;n
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb las direccciones de red, pero a diferencia de <code>none</code>
72a4ef8eac1adef882246c5bfb9b8bbd82d613c4coar la opci&#243;n <code>connect</code> no espera a la transmisi&#243;n inicial de los datos.</p>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <p>Sobre Windows, <code>none</code> prefiere accept() antes que AcceptEx()
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb y no recuperar&#225; sockets entre las conexiones. Lo que es &#250;til para los adaptadores de
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh red con un soporte precario de drivers, as&#237; como para algunos proveedores de red
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh tales como drivers vpn, o filtros de spam, de virus o de spyware.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding</usage>
2d2eda71267231c2526be701fe655db125852c1ffielding<seealso><directive>Protocol</directive></seealso>
2d2eda71267231c2526be701fe655db125852c1ffielding</directivesynopsis>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding<directivesynopsis>
2d2eda71267231c2526be701fe655db125852c1ffielding<name>AcceptPathInfo</name>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<description>Los recursos aceptan informaci&#243;n sobre su ruta</description>
2d2eda71267231c2526be701fe655db125852c1ffielding<syntax>AcceptPathInfo On|Off|Default</syntax>
2d2eda71267231c2526be701fe655db125852c1ffielding<default>AcceptPathInfo Default</default>
2d2eda71267231c2526be701fe655db125852c1ffielding<contextlist><context>server config</context>
2d2eda71267231c2526be701fe655db125852c1ffielding<context>virtual host</context><context>directory</context>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<context>.htaccess</context></contextlist>
2d2eda71267231c2526be701fe655db125852c1ffielding<override>FileInfo</override>
a77c6787a1ea7dd88cb6cf8e4ad968b235af2a20jorton<compatibility>Disponible en Apache httpd 2.0.30 y posteriores</compatibility>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding<usage>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
2d2eda71267231c2526be701fe655db125852c1ffielding <p>Esta directiva controla si las peticiones que contienen informaci&#243;n sobre la ruta
2d2eda71267231c2526be701fe655db125852c1ffielding que sigue un fichero que existe (o un fichero que no existe pero en un directorio que
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh s&#237; existe) ser&#225;n aceptadas o denegadas. La informaci&#243;n de ruta puede estar disponible
2d2eda71267231c2526be701fe655db125852c1ffielding para los scripts en la variable de entorno <code>PATH_INFO</code>.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>Por ejemplo, asumamos que la ubicaci&#243;n <code>/test/</code> apunta a
2d2eda71267231c2526be701fe655db125852c1ffielding un directorio que contiene &#250;nicamente el fichero
2d2eda71267231c2526be701fe655db125852c1ffielding <code>here.html</code>. Entonces, las peticiones tanto para
2d2eda71267231c2526be701fe655db125852c1ffielding <code>/test/here.html/more</code> como para
2d2eda71267231c2526be701fe655db125852c1ffielding <code>/test/nothere.html/more</code> recogen
2d2eda71267231c2526be701fe655db125852c1ffielding <code>/more</code> como <code>PATH_INFO</code>.</p>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
2d2eda71267231c2526be701fe655db125852c1ffielding <p>Los tres posibles argumentos para la directiva
2d2eda71267231c2526be701fe655db125852c1ffielding <directive>AcceptPathInfo</directive> son los siguientes:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding <dl>
2d2eda71267231c2526be701fe655db125852c1ffielding <dt><code>Off</code></dt><dd>Una petici&#243;n s&#243;lo ser&#225; aceptada si
2d2eda71267231c2526be701fe655db125852c1ffielding se corresponde con una ruta literal que existe. Por lo tanto, una petici&#243;n
2d2eda71267231c2526be701fe655db125852c1ffielding con una informaci&#243;n de ruta despu&#233;s del nombre de fichero tal como
2d2eda71267231c2526be701fe655db125852c1ffielding <code>/test/here.html/more</code> en el ejemplo anterior devolver&#225;
2d2eda71267231c2526be701fe655db125852c1ffielding un error 404 NOT FOUND.</dd>
2d2eda71267231c2526be701fe655db125852c1ffielding
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <dt><code>On</code></dt><dd>Una petici&#243;n ser&#225; aceptada si una
2d2eda71267231c2526be701fe655db125852c1ffielding ruta principal de acceso se corresponde con un fichero que existe. El ejemplo
2d2eda71267231c2526be701fe655db125852c1ffielding anterior <code>/test/here.html/more</code> ser&#225; aceptado si
2d2eda71267231c2526be701fe655db125852c1ffielding <code>/test/here.html</code> corresponde a un fichero v&#225;lido.</dd>
2d2eda71267231c2526be701fe655db125852c1ffielding
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <dt><code>Default</code></dt><dd>La gesti&#243;n de las peticiones
2d2eda71267231c2526be701fe655db125852c1ffielding con informaci&#243;n de ruta est&#225; determinada por el <a
2d2eda71267231c2526be701fe655db125852c1ffielding href="/handler.html">controlador</a> responsable de la petici&#243;n.
2d2eda71267231c2526be701fe655db125852c1ffielding El controlador principal para para ficheros normales rechaza por defecto
2d2eda71267231c2526be701fe655db125852c1ffielding peticiones <code>PATH_INFO</code>. Los controladores que sirven scripts, tales como <a
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh href="mod_cgi.html">cgi-script</a> e <a
2d2eda71267231c2526be701fe655db125852c1ffielding href="mod_isapi.html">isapi-handler</a>, normalmente aceptan
dbbf1b4183ae16353011a5269b37899f02b97d81gregames <code>PATH_INFO</code> por defecto.</dd>
2d2eda71267231c2526be701fe655db125852c1ffielding </dl>
2d2eda71267231c2526be701fe655db125852c1ffielding
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <p>El objetivo principal de la directiva <code>AcceptPathInfo</code>
2d2eda71267231c2526be701fe655db125852c1ffielding es permitirte sobreescribir la opci&#243;n del controlador
e44e11f9fece12c783f18d033923bfc0d6b4289aake de aceptar or rechazar <code>PATH_INFO</code>. Este tipo de sobreescritura se necesita,
2d2eda71267231c2526be701fe655db125852c1ffielding por ejemplo, cuando utilizas un <a href="/filter.html">filtro</a>, tal como
2d2eda71267231c2526be701fe655db125852c1ffielding <a href="mod_include.html">INCLUDES</a>, para generar contenido
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh basado en <code>PATH_INFO</code>. El controlador principal normalmente rechazar&#237;a
2d2eda71267231c2526be701fe655db125852c1ffielding la petici&#243;n, de modo que puedes utilizar la siguiente configuraci&#243;n para habilitarla
ee1af2aeb57527f33baa4737aa431e4aef997855rbowen como script:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <example>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh &lt;Files "mypaths.shtml"&gt;<br />
2d2eda71267231c2526be701fe655db125852c1ffielding <indent>
2d2eda71267231c2526be701fe655db125852c1ffielding Options +Includes<br />
2d2eda71267231c2526be701fe655db125852c1ffielding SetOutputFilter INCLUDES<br />
2d2eda71267231c2526be701fe655db125852c1ffielding AcceptPathInfo On<br />
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh </indent>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh &lt;/Files&gt;
2d2eda71267231c2526be701fe655db125852c1ffielding </example>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding</usage>
2d2eda71267231c2526be701fe655db125852c1ffielding</directivesynopsis>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding<directivesynopsis>
2d2eda71267231c2526be701fe655db125852c1ffielding<name>AccessFileName</name>
2d2eda71267231c2526be701fe655db125852c1ffielding<description>Nombre del fichero distribuido de configuraci&#243;n</description>
2d2eda71267231c2526be701fe655db125852c1ffielding<syntax>AccessFileName <var>filename</var> [<var>filename</var>] ...</syntax>
2d2eda71267231c2526be701fe655db125852c1ffielding<default>AccessFileName .htaccess</default>
2d2eda71267231c2526be701fe655db125852c1ffielding<contextlist><context>server config</context><context>virtual host</context>
2d2eda71267231c2526be701fe655db125852c1ffielding</contextlist>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding<usage>
2d2eda71267231c2526be701fe655db125852c1ffielding <p>Mientras que procesa una petici&#243;n el servidor busca
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh el primer fichero de configuraci&#243;n existente dentro de un listado de nombres en
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh cada directorio de la ruta del documento, si los ficheros distribuidos
2d2eda71267231c2526be701fe655db125852c1ffielding de configuraci&#243;n est&#225;n <a href="#allowoverride">habilitados para ese
2d2eda71267231c2526be701fe655db125852c1ffielding directorio</a>. Por ejemplo:</p>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <example>
2d2eda71267231c2526be701fe655db125852c1ffielding AccessFileName .acl
2d2eda71267231c2526be701fe655db125852c1ffielding </example>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <p>antes de servir el documento
2d2eda71267231c2526be701fe655db125852c1ffielding <code>/usr/local/web/index.html</code>, el servidor leer&#225;
2d2eda71267231c2526be701fe655db125852c1ffielding <code>/.acl</code>, <code>/usr/.acl</code>,
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <code>/usr/local/.acl</code> and <code>/usr/local/web/.acl</code>
2efb935ae8fe12d5192a3bf2c52c28461b6c68afdgaudet para las directivas, salvo que estén deshabilitadas with</p>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
2efb935ae8fe12d5192a3bf2c52c28461b6c68afdgaudet <example>
2efb935ae8fe12d5192a3bf2c52c28461b6c68afdgaudet &lt;Directory /&gt;<br />
2efb935ae8fe12d5192a3bf2c52c28461b6c68afdgaudet <indent>
2efb935ae8fe12d5192a3bf2c52c28461b6c68afdgaudet AllowOverride None<br />
2efb935ae8fe12d5192a3bf2c52c28461b6c68afdgaudet </indent>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh &lt;/Directory&gt;
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb </example>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb</usage>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<seealso><directive module="core">AllowOverride</directive></seealso>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<seealso><a href="/configuring.html">Configuration Files</a></seealso>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<seealso><a href="/howto/htaccess.html">.htaccess Files</a></seealso>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh</directivesynopsis>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<directivesynopsis>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<name>AddDefaultCharset</name>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<description>Default charset parameter to be added when a response
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbbcontent-type is <code>text/plain</code> or <code>text/html</code></description>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<syntax>AddDefaultCharset On|Off|<var>charset</var></syntax>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<default>AddDefaultCharset Off</default>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<contextlist><context>server config</context>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<context>virtual host</context><context>directory</context>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<context>.htaccess</context></contextlist>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<override>FileInfo</override>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<usage>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <p>This directive specifies a default value for the media type
a403dbf53e544291022bcc166ac8823d60fb1ee5niq charset parameter (the name of a character encoding) to be added
a403dbf53e544291022bcc166ac8823d60fb1ee5niq to a response if and only if the response's content-type is either
a403dbf53e544291022bcc166ac8823d60fb1ee5niq <code>text/plain</code> or <code>text/html</code>. This should override
a403dbf53e544291022bcc166ac8823d60fb1ee5niq any charset specified in the body of the response via a <code>META</code>
a403dbf53e544291022bcc166ac8823d60fb1ee5niq element, though the exact behavior is often dependent on the user's client
a403dbf53e544291022bcc166ac8823d60fb1ee5niq configuration. A setting of <code>AddDefaultCharset Off</code>
a403dbf53e544291022bcc166ac8823d60fb1ee5niq disables this functionality. <code>AddDefaultCharset On</code> enables
a403dbf53e544291022bcc166ac8823d60fb1ee5niq a default charset of <code>iso-8859-1</code>. Any other value is assumed
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh to be the <var>charset</var> to be used, which should be one of the
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <a href="http://www.iana.org/assignments/character-sets">IANA registered
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb charset values</a> for use in Internet media types (MIME types).
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb For example:</p>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <example>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb AddDefaultCharset utf-8
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb </example>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <p><directive>AddDefaultCharset</directive> should only be used when all
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb of the text resources to which it applies are known to be in that
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh character encoding and it is too inconvenient to label their charset
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb individually. One such example is to add the charset parameter
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb to resources containing generated content, such as legacy CGI
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh scripts, that might be vulnerable to cross-site scripting attacks
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb due to user-provided data being included in the output. Note, however,
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb that a better solution is to just fix (or delete) those scripts, since
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb setting a default charset does not protect users that have enabled
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh the "auto-detect character encoding" feature on their browser.</p>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb</usage>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<seealso><directive module="mod_mime">AddCharset</directive></seealso>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb</directivesynopsis>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<directivesynopsis>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<name>AllowEncodedSlashes</name>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<description>Determines whether encoded path separators in URLs are allowed to
99d6d3207e24ba1f8eba77ef903948d738886cf5ndbe passed through</description>
99d6d3207e24ba1f8eba77ef903948d738886cf5nd<syntax>AllowEncodedSlashes On|Off</syntax>
99d6d3207e24ba1f8eba77ef903948d738886cf5nd<default>AllowEncodedSlashes Off</default>
99d6d3207e24ba1f8eba77ef903948d738886cf5nd<contextlist><context>server config</context><context>virtual host</context>
99d6d3207e24ba1f8eba77ef903948d738886cf5nd</contextlist>
99d6d3207e24ba1f8eba77ef903948d738886cf5nd<compatibility>Available in Apache httpd 2.0.46 and later</compatibility>
99d6d3207e24ba1f8eba77ef903948d738886cf5nd
99d6d3207e24ba1f8eba77ef903948d738886cf5nd<usage>
99d6d3207e24ba1f8eba77ef903948d738886cf5nd <p>The <directive>AllowEncodedSlashes</directive> directive allows URLs
99d6d3207e24ba1f8eba77ef903948d738886cf5nd which contain encoded path separators (<code>%2F</code> for <code>/</code>
99d6d3207e24ba1f8eba77ef903948d738886cf5nd and additionally <code>%5C</code> for <code>\</code> on according systems)
99d6d3207e24ba1f8eba77ef903948d738886cf5nd to be used. Normally such URLs are refused with a 404 (Not found) error.</p>
99d6d3207e24ba1f8eba77ef903948d738886cf5nd
99d6d3207e24ba1f8eba77ef903948d738886cf5nd <p>Turning <directive>AllowEncodedSlashes</directive> <code>On</code> is
99d6d3207e24ba1f8eba77ef903948d738886cf5nd mostly useful when used in conjunction with <code>PATH_INFO</code>.</p>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <note><title>Note</title>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <p>Allowing encoded slashes does <em>not</em> imply <em>decoding</em>.
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh Occurrences of <code>%2F</code> or <code>%5C</code> (<em>only</em> on
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb according systems) will be left as such in the otherwise decoded URL
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh string.</p>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb </note>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb</usage>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<seealso><directive module="core">AcceptPathInfo</directive></seealso>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb</directivesynopsis>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<directivesynopsis>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<name>AllowOverride</name>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<description>Types of directives that are allowed in
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<code>.htaccess</code> files</description>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<syntax>AllowOverride All|None|<var>directive-type</var>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben[<var>directive-type</var>] ...</syntax>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<default>AllowOverride None (2.3.9 and later), AllowOverride All (2.3.8 and earlier)</default>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<contextlist><context>directory</context></contextlist>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<usage>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <p>When the server finds an <code>.htaccess</code> file (as
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben specified by <directive module="core">AccessFileName</directive>)
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben it needs to know which directives declared in that file can override
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben earlier configuration directives.</p>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <note><title>Only available in &lt;Directory&gt; sections</title>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <directive>AllowOverride</directive> is valid only in
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <directive type="section" module="core">Directory</directive>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben sections specified without regular expressions, not in <directive
7b6ba9c468f26bdb3492d5e8cb79628a3b04e8c8wrowe type="section" module="core">Location</directive>, <directive
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb module="core" type="section">DirectoryMatch</directive> or
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <directive type="section" module="core">Files</directive> sections.
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb </note>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <p>When this directive is set to <code>None</code>, then
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <a href="#accessfilename">.htaccess</a> files are completely ignored.
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb In this case, the server will not even attempt to read
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <code>.htaccess</code> files in the filesystem.</p>
1374444b4fab1475091e12a81663f379b73005efrbb
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <p>When this directive is set to <code>All</code>, then any
bbe046d7cbb950ab3e372e4119ae001a5fe52ed4striker directive which has the .htaccess <a
bbe046d7cbb950ab3e372e4119ae001a5fe52ed4striker href="directive-dict.html#Context">Context</a> is allowed in
bbe046d7cbb950ab3e372e4119ae001a5fe52ed4striker <code>.htaccess</code> files.</p>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <p>The <var>directive-type</var> can be one of the following
c8aa00ee0cfc17b5fa08fb8a2b08d30dc9e4f1b1wrowe groupings of directives.</p>
c8aa00ee0cfc17b5fa08fb8a2b08d30dc9e4f1b1wrowe
4542d057c4bde23857f31d449fa3108561206139wrowe <dl>
c8aa00ee0cfc17b5fa08fb8a2b08d30dc9e4f1b1wrowe <dt>AuthConfig</dt>
4542d057c4bde23857f31d449fa3108561206139wrowe
c8aa00ee0cfc17b5fa08fb8a2b08d30dc9e4f1b1wrowe <dd>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb Allow use of the authorization directives (<directive
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb module="mod_authn_dbm">AuthDBMGroupFile</directive>,
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <directive module="mod_authn_dbm">AuthDBMUserFile</directive>,
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <directive module="mod_authz_groupfile">AuthGroupFile</directive>,
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <directive module="mod_authn_core">AuthName</directive>,
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <directive module="mod_authn_core">AuthType</directive>, <directive
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh module="mod_authn_file">AuthUserFile</directive>, <directive
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb module="mod_authz_core">Require</directive>, <em>etc.</em>).</dd>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <dt>FileInfo</dt>
6d74c65f131583f6832b04424c1a9e1e7cc72c8egregames
6d74c65f131583f6832b04424c1a9e1e7cc72c8egregames <dd>
6d74c65f131583f6832b04424c1a9e1e7cc72c8egregames Allow use of the directives controlling document types
6d74c65f131583f6832b04424c1a9e1e7cc72c8egregames (<directive module="core">ErrorDocument</directive>,
6d74c65f131583f6832b04424c1a9e1e7cc72c8egregames <directive module="core">ForceType</directive>,
6d74c65f131583f6832b04424c1a9e1e7cc72c8egregames <directive module="mod_negotiation">LanguagePriority</directive>,
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <directive module="core">SetHandler</directive>,
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <directive module="core">SetInputFilter</directive>,
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <directive module="core">SetOutputFilter</directive>, and
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <module>mod_mime</module> Add* and Remove* directives),
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh document meta data (<directive
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb module="mod_headers">Header</directive>, <directive
2e123e8beedc9f921448c113e2d6823a92fd5261fielding module="mod_headers">RequestHeader</directive>, <directive
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben module="mod_setenvif">SetEnvIf</directive>, <directive
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben module="mod_setenvif">SetEnvIfNoCase</directive>, <directive
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben module="mod_setenvif">BrowserMatch</directive>, <directive
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben module="mod_usertrack">CookieExpires</directive>, <directive
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben module="mod_usertrack">CookieDomain</directive>, <directive
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben module="mod_usertrack">CookieStyle</directive>, <directive
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben module="mod_usertrack">CookieTracking</directive>, <directive
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben module="mod_usertrack">CookieName</directive>),
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <module>mod_rewrite</module> directives <directive
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben module="mod_rewrite">RewriteEngine</directive>, <directive
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben module="mod_rewrite">RewriteOptions</directive>, <directive
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben module="mod_rewrite">RewriteBase</directive>, <directive
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben module="mod_rewrite">RewriteCond</directive>, <directive
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben module="mod_rewrite">RewriteRule</directive>) and
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <directive module="mod_actions">Action</directive> from
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <module>mod_actions</module>.
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben </dd>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <dt>Indexes</dt>
64b9fa4bc3e79b0eefb2d93fb56eae40d88e0f06wrowe
64b9fa4bc3e79b0eefb2d93fb56eae40d88e0f06wrowe <dd>
64b9fa4bc3e79b0eefb2d93fb56eae40d88e0f06wrowe Allow use of the directives controlling directory indexing
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben (<directive
64b9fa4bc3e79b0eefb2d93fb56eae40d88e0f06wrowe module="mod_autoindex">AddDescription</directive>,
64b9fa4bc3e79b0eefb2d93fb56eae40d88e0f06wrowe <directive module="mod_autoindex">AddIcon</directive>, <directive
64b9fa4bc3e79b0eefb2d93fb56eae40d88e0f06wrowe module="mod_autoindex">AddIconByEncoding</directive>,
64b9fa4bc3e79b0eefb2d93fb56eae40d88e0f06wrowe <directive module="mod_autoindex">AddIconByType</directive>,
64b9fa4bc3e79b0eefb2d93fb56eae40d88e0f06wrowe <directive module="mod_autoindex">DefaultIcon</directive>, <directive
64b9fa4bc3e79b0eefb2d93fb56eae40d88e0f06wrowe module="mod_dir">DirectoryIndex</directive>, <directive
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben module="mod_autoindex">FancyIndexing</directive>, <directive
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben module="mod_autoindex">HeaderName</directive>, <directive
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben module="mod_autoindex">IndexIgnore</directive>, <directive
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben module="mod_autoindex">IndexOptions</directive>, <directive
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh module="mod_autoindex">ReadmeName</directive>,
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <em>etc.</em>).</dd>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <dt>Limit</dt>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <dd>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben Allow use of the directives controlling host access (<directive
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh module="mod_authz_host">Allow</directive>, <directive
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh module="mod_authz_host">Deny</directive> and <directive
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh module="mod_authz_host">Order</directive>).</dd>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <dt>Options[=<var>Option</var>,...]</dt>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <dd>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben Allow use of the directives controlling specific directory
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben features (<directive module="core">Options</directive> and
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <directive module="mod_include">XBitHack</directive>).
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd An equal sign may be given followed by a comma (but no spaces)
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh separated lists of options that may be set using the <directive
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd module="core">Options</directive> command.</dd>
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd </dl>
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd <p>Example:</p>
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd <example>
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd AllowOverride AuthConfig Indexes
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd </example>
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd <p>In the example above all directives that are neither in the group
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd <code>AuthConfig</code> nor <code>Indexes</code> cause an internal
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd server error.</p>
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd <note><p>For security and performance reasons, do not set
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd <code>AllowOverride</code> to anything other than <code>None</code>
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd in your <code>&lt;Directory /&gt;</code> block. Instead, find (or
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd create) the <code>&lt;Directory&gt;</code> block that refers to the
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb directory where you're actually planning to place a
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick <code>.htaccess</code> file.</p>
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick </note>
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick</usage>
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb<seealso><directive module="core">AccessFileName</directive></seealso>
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick<seealso><a href="/configuring.html">Configuration Files</a></seealso>
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb<seealso><a href="/howto/htaccess.html">.htaccess Files</a></seealso>
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb</directivesynopsis>
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick<directivesynopsis>
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick<name>CGIMapExtension</name>
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick<description>Technique for locating the interpreter for CGI
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawickscripts</description>
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick<syntax>CGIMapExtension <var>cgi-path</var> <var>.extension</var></syntax>
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick<contextlist><context>directory</context><context>.htaccess</context>
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick</contextlist>
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick<override>FileInfo</override>
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick<compatibility>NetWare only</compatibility>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb<usage>
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb <p>This directive is used to control how Apache httpd finds the
3d96ee83babeec32482c9082c9426340cee8c44dwrowe interpreter used to run CGI scripts. For example, setting
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb <code>CGIMapExtension sys:\foo.nlm .foo</code> will
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb cause all CGI script files with a <code>.foo</code> extension to
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb be passed to the FOO interpreter.</p>
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb</usage>
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb</directivesynopsis>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe
2d2eda71267231c2526be701fe655db125852c1ffielding<directivesynopsis>
ceb14f8ba57a8086c9a68ad264efbe2433134382covener<name>ContentDigest</name>
ceb14f8ba57a8086c9a68ad264efbe2433134382covener<description>Enables the generation of <code>Content-MD5</code> HTTP Response
ceb14f8ba57a8086c9a68ad264efbe2433134382covenerheaders</description>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<syntax>ContentDigest On|Off</syntax>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<default>ContentDigest Off</default>
2d2eda71267231c2526be701fe655db125852c1ffielding<contextlist><context>server config</context><context>virtual host</context>
2d2eda71267231c2526be701fe655db125852c1ffielding<context>directory</context><context>.htaccess</context>
b0d8a6d437db6f4c222173f27ef81c98622fbd02pquerna</contextlist>
b0d8a6d437db6f4c222173f27ef81c98622fbd02pquerna<override>Options</override>
2d2eda71267231c2526be701fe655db125852c1ffielding<status>Experimental</status>
ceb14f8ba57a8086c9a68ad264efbe2433134382covener
ceb14f8ba57a8086c9a68ad264efbe2433134382covener<usage>
ceb14f8ba57a8086c9a68ad264efbe2433134382covener <p>This directive enables the generation of
ceb14f8ba57a8086c9a68ad264efbe2433134382covener <code>Content-MD5</code> headers as defined in RFC1864
ceb14f8ba57a8086c9a68ad264efbe2433134382covener respectively RFC2616.</p>
ceb14f8ba57a8086c9a68ad264efbe2433134382covener
ceb14f8ba57a8086c9a68ad264efbe2433134382covener <p>MD5 is an algorithm for computing a "message digest"
ceb14f8ba57a8086c9a68ad264efbe2433134382covener (sometimes called "fingerprint") of arbitrary-length data, with
ceb14f8ba57a8086c9a68ad264efbe2433134382covener a high degree of confidence that any alterations in the data
ceb14f8ba57a8086c9a68ad264efbe2433134382covener will be reflected in alterations in the message digest.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <p>The <code>Content-MD5</code> header provides an end-to-end
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh message integrity check (MIC) of the entity-body. A proxy or
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh client may check this header for detecting accidental
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh modification of the entity-body in transit. Example header:</p>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <example>
2d2eda71267231c2526be701fe655db125852c1ffielding Content-MD5: AuLb7Dp1rqtRtxz2m9kRpA==
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm </example>
2d2eda71267231c2526be701fe655db125852c1ffielding
cf35a54aa4b61245bf315cc594f8809c1cf31729geoff <p>Note that this can cause performance problems on your server
2d2eda71267231c2526be701fe655db125852c1ffielding since the message digest is computed on every request (the
2d2eda71267231c2526be701fe655db125852c1ffielding values are not cached).</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p><code>Content-MD5</code> is only sent for documents served
2d2eda71267231c2526be701fe655db125852c1ffielding by the <module>core</module>, and not by any module. For example,
2d2eda71267231c2526be701fe655db125852c1ffielding SSI documents, output from CGI scripts, and byte range responses
2d2eda71267231c2526be701fe655db125852c1ffielding do not have this header.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding</usage>
2d2eda71267231c2526be701fe655db125852c1ffielding</directivesynopsis>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding<directivesynopsis>
2d2eda71267231c2526be701fe655db125852c1ffielding<name>DefaultType</name>
2d2eda71267231c2526be701fe655db125852c1ffielding<description>This directive has no effect other than to emit warnings
2d2eda71267231c2526be701fe655db125852c1ffieldingif the value is not <code>none</code>. In prior versions, DefaultType
2d2eda71267231c2526be701fe655db125852c1ffieldingwould specify a default media type to assign to response content for
2d2eda71267231c2526be701fe655db125852c1ffieldingwhich no other media type configuration could be found.
2d2eda71267231c2526be701fe655db125852c1ffielding</description>
2d2eda71267231c2526be701fe655db125852c1ffielding<syntax>DefaultType <var>media-type|none</var></syntax>
2d2eda71267231c2526be701fe655db125852c1ffielding<default>DefaultType none</default>
2d2eda71267231c2526be701fe655db125852c1ffielding<contextlist><context>server config</context><context>virtual host</context>
2d2eda71267231c2526be701fe655db125852c1ffielding<context>directory</context><context>.htaccess</context>
2d2eda71267231c2526be701fe655db125852c1ffielding</contextlist>
2d2eda71267231c2526be701fe655db125852c1ffielding<override>FileInfo</override>
2d2eda71267231c2526be701fe655db125852c1ffielding<compatibility>The argument <code>none</code> is available in Apache httpd 2.2.7 and later. All other choices are DISABLED for 2.3.x and later.</compatibility>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding<usage>
2d2eda71267231c2526be701fe655db125852c1ffielding <p>This directive has been disabled. For backwards compatibility
2d2eda71267231c2526be701fe655db125852c1ffielding of configuration files, it may be specified with the value
2d2eda71267231c2526be701fe655db125852c1ffielding <code>none</code>, meaning no default media type. For example:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <example>
2d2eda71267231c2526be701fe655db125852c1ffielding DefaultType None
2d2eda71267231c2526be701fe655db125852c1ffielding </example>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p><code>DefaultType None</code> is only available in
2d2eda71267231c2526be701fe655db125852c1ffielding httpd-2.2.7 and later.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>Use the mime.types configuration file and the
2d2eda71267231c2526be701fe655db125852c1ffielding <directive module="mod_mime">AddType</directive> to configure media
2d2eda71267231c2526be701fe655db125852c1ffielding type assignments via file extensions, or the
4d88cba691cf0cc222161dc403067071eca58751rbb <directive module="core">ForceType</directive> directive to configure
2d2eda71267231c2526be701fe655db125852c1ffielding the media type for specific resources. Otherwise, the server will
2d2eda71267231c2526be701fe655db125852c1ffielding send the response without a Content-Type header field and the
2d2eda71267231c2526be701fe655db125852c1ffielding recipient may attempt to guess the media type.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding</usage>
2d2eda71267231c2526be701fe655db125852c1ffielding</directivesynopsis>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding<directivesynopsis>
2d2eda71267231c2526be701fe655db125852c1ffielding<name>Define</name>
2d2eda71267231c2526be701fe655db125852c1ffielding<description>Define the existence of a variable</description>
2d2eda71267231c2526be701fe655db125852c1ffielding<syntax>Define <var>parameter-name</var></syntax>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<contextlist><context>server config</context></contextlist>
2d2eda71267231c2526be701fe655db125852c1ffielding
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<usage>
2d2eda71267231c2526be701fe655db125852c1ffielding <p>Equivalent to passing the <code>-D</code> argument to <program
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh >httpd</program>.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding <p>This directive can be used to toggle the use of <directive module="core"
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh type="section">IfDefine</directive> sections without needing to alter
2d2eda71267231c2526be701fe655db125852c1ffielding <code>-D</code> arguments in any startup scripts.</p>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh</usage>
2d2eda71267231c2526be701fe655db125852c1ffielding</directivesynopsis>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
2d2eda71267231c2526be701fe655db125852c1ffielding<directivesynopsis type="section">
a59f92f67a2c7735469d0ade559f96218627eef0niq<name>Directory</name>
a59f92f67a2c7735469d0ade559f96218627eef0niq<description>Enclose a group of directives that apply only to the
2d2eda71267231c2526be701fe655db125852c1ffieldingnamed file-system directory, sub-directories, and their contents.</description>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<syntax>&lt;Directory <var>directory-path</var>&gt;
2d2eda71267231c2526be701fe655db125852c1ffielding... &lt;/Directory&gt;</syntax>
2d2eda71267231c2526be701fe655db125852c1ffielding<contextlist><context>server config</context><context>virtual host</context>
2d2eda71267231c2526be701fe655db125852c1ffielding</contextlist>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding<usage>
2d2eda71267231c2526be701fe655db125852c1ffielding <p><directive type="section">Directory</directive> and
2d2eda71267231c2526be701fe655db125852c1ffielding <code>&lt;/Directory&gt;</code> are used to enclose a group of
2d2eda71267231c2526be701fe655db125852c1ffielding directives that will apply only to the named directory,
2d2eda71267231c2526be701fe655db125852c1ffielding sub-directories of that directory, and the files within the respective
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh directories. Any directive that is allowed
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh in a directory context may be used. <var>Directory-path</var> is
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh either the full path to a directory, or a wild-card string using
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh Unix shell-style matching. In a wild-card string, <code>?</code> matches
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh any single character, and <code>*</code> matches any sequences of
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh characters. You may also use <code>[]</code> character ranges. None
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh of the wildcards match a `/' character, so <code>&lt;Directory
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh /*/public_html&gt;</code> will not match
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <code>/home/user/public_html</code>, but <code>&lt;Directory
2d2eda71267231c2526be701fe655db125852c1ffielding /home/*/public_html&gt;</code> will match. Example:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
763f7b125b6d3dd1e4992a3822005efa2616f983coar <example>
763f7b125b6d3dd1e4992a3822005efa2616f983coar &lt;Directory /usr/local/httpd/htdocs&gt;<br />
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <indent>
2d2eda71267231c2526be701fe655db125852c1ffielding Options Indexes FollowSymLinks<br />
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh </indent>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh &lt;/Directory&gt;
5a9667916c79d8c699b069068e5570aa1c331c80gstein </example>
5a9667916c79d8c699b069068e5570aa1c331c80gstein
5a9667916c79d8c699b069068e5570aa1c331c80gstein <note>
5a9667916c79d8c699b069068e5570aa1c331c80gstein <p>Be careful with the <var>directory-path</var> arguments:
5a9667916c79d8c699b069068e5570aa1c331c80gstein They have to literally match the filesystem path which Apache httpd uses
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh to access the files. Directives applied to a particular
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <code>&lt;Directory&gt;</code> will not apply to files accessed from
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh that same directory via a different path, such as via different symbolic
5a9667916c79d8c699b069068e5570aa1c331c80gstein links.</p>
5a9667916c79d8c699b069068e5570aa1c331c80gstein </note>
5a9667916c79d8c699b069068e5570aa1c331c80gstein
5a9667916c79d8c699b069068e5570aa1c331c80gstein <p><glossary ref="regex">Regular
5a9667916c79d8c699b069068e5570aa1c331c80gstein expressions</glossary> can also be used, with the addition of the
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <code>~</code> character. For example:</p>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
5a9667916c79d8c699b069068e5570aa1c331c80gstein <example>
5a9667916c79d8c699b069068e5570aa1c331c80gstein &lt;Directory ~ "^/www/.*/[0-9]{3}"&gt;
5a9667916c79d8c699b069068e5570aa1c331c80gstein </example>
5a9667916c79d8c699b069068e5570aa1c331c80gstein
5a9667916c79d8c699b069068e5570aa1c331c80gstein <p>would match directories in <code>/www/</code> that consisted of
5a9667916c79d8c699b069068e5570aa1c331c80gstein three numbers.</p>
5a9667916c79d8c699b069068e5570aa1c331c80gstein
5a9667916c79d8c699b069068e5570aa1c331c80gstein <p>If multiple (non-regular expression) <directive
5a9667916c79d8c699b069068e5570aa1c331c80gstein type="section">Directory</directive> sections
5a9667916c79d8c699b069068e5570aa1c331c80gstein match the directory (or one of its parents) containing a document,
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh then the directives are applied in the order of shortest match
2d2eda71267231c2526be701fe655db125852c1ffielding first, interspersed with the directives from the <a
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh href="#accessfilename">.htaccess</a> files. For example,
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh with</p>
62db15de4c1f335a64d45821796ae197cff94ef8rbb
62db15de4c1f335a64d45821796ae197cff94ef8rbb <example>
62db15de4c1f335a64d45821796ae197cff94ef8rbb &lt;Directory /&gt;<br />
2d2eda71267231c2526be701fe655db125852c1ffielding <indent>
48d2edbfb84e5559b5da0f8d614ccab805cc67a8rbb AllowOverride None<br />
48d2edbfb84e5559b5da0f8d614ccab805cc67a8rbb </indent>
48d2edbfb84e5559b5da0f8d614ccab805cc67a8rbb &lt;/Directory&gt;<br />
5a9667916c79d8c699b069068e5570aa1c331c80gstein <br />
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh &lt;Directory /home/&gt;<br />
48d2edbfb84e5559b5da0f8d614ccab805cc67a8rbb <indent>
48d2edbfb84e5559b5da0f8d614ccab805cc67a8rbb AllowOverride FileInfo<br />
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh </indent>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh &lt;/Directory&gt;
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh </example>
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <p>for access to the document <code>/home/web/dir/doc.html</code>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh the steps are:</p>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <ul>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <li>Apply directive <code>AllowOverride None</code>
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar (disabling <code>.htaccess</code> files).</li>
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <li>Apply directive <code>AllowOverride FileInfo</code> (for
62db15de4c1f335a64d45821796ae197cff94ef8rbb directory <code>/home</code>).</li>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar <li>Apply any <code>FileInfo</code> directives in
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb <code>/home/.htaccess</code>, <code>/home/web/.htaccess</code> and
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <code>/home/web/dir/.htaccess</code> in that order.</li>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh </ul>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <p>Regular expressions are not considered until after all of the
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh normal sections have been applied. Then all of the regular
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh expressions are tested in the order they appeared in the
2d2eda71267231c2526be701fe655db125852c1ffielding configuration file. For example, with</p>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
2d2eda71267231c2526be701fe655db125852c1ffielding <example>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh &lt;Directory ~ abc$&gt;<br />
2d2eda71267231c2526be701fe655db125852c1ffielding <indent>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh # ... directives here ...<br />
2d2eda71267231c2526be701fe655db125852c1ffielding </indent>
2d2eda71267231c2526be701fe655db125852c1ffielding &lt;/Directory&gt;
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh </example>
54e94821097724bf413d2d4cc70711760f7494e1trawick
db3fa7db7c7910f2f23c3e3ffe0cf9f41a1899b9trawick <p>the regular expression section won't be considered until after
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh all normal <directive type="section">Directory</directive>s and
2d2eda71267231c2526be701fe655db125852c1ffielding <code>.htaccess</code> files have been applied. Then the regular
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh expression will match on <code>/home/abc/public_html/abc</code> and
2d2eda71267231c2526be701fe655db125852c1ffielding the corresponding <directive type="section">Directory</directive> will
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh be applied.</p>
54e94821097724bf413d2d4cc70711760f7494e1trawick
db3fa7db7c7910f2f23c3e3ffe0cf9f41a1899b9trawick <p><strong>Note that the default access for
54e94821097724bf413d2d4cc70711760f7494e1trawick <code>&lt;Directory /&gt;</code> is <code>Allow from All</code>.
54e94821097724bf413d2d4cc70711760f7494e1trawick This means that Apache httpd will serve any file mapped from an URL. It is
54e94821097724bf413d2d4cc70711760f7494e1trawick recommended that you change this with a block such
54e94821097724bf413d2d4cc70711760f7494e1trawick as</strong></p>
54e94821097724bf413d2d4cc70711760f7494e1trawick
54e94821097724bf413d2d4cc70711760f7494e1trawick <example>
54e94821097724bf413d2d4cc70711760f7494e1trawick &lt;Directory /&gt;<br />
54e94821097724bf413d2d4cc70711760f7494e1trawick <indent>
54e94821097724bf413d2d4cc70711760f7494e1trawick Order Deny,Allow<br />
db3fa7db7c7910f2f23c3e3ffe0cf9f41a1899b9trawick Deny from All<br />
c8477d12d1b127ab46dffe4ee526b9d11f71699egregames </indent>
c8477d12d1b127ab46dffe4ee526b9d11f71699egregames &lt;/Directory&gt;
2d2eda71267231c2526be701fe655db125852c1ffielding </example>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
cd9eb79cfbf9bc730ccacc3a3774b1fe1b99ed53wrowe <p><strong>and then override this for directories you
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <em>want</em> accessible. See the <a
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh href="/misc/security_tips.html">Security Tips</a> page for more
2d2eda71267231c2526be701fe655db125852c1ffielding details.</strong></p>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <p>The directory sections occur in the <code>httpd.conf</code> file.
2d2eda71267231c2526be701fe655db125852c1ffielding <directive type="section">Directory</directive> directives
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh cannot nest, and cannot appear in a <directive module="core"
2d2eda71267231c2526be701fe655db125852c1ffielding type="section">Limit</directive> or <directive module="core"
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh type="section">LimitExcept</directive> section.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding</usage>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<seealso><a href="/sections.html">How &lt;Directory&gt;,
2d2eda71267231c2526be701fe655db125852c1ffielding &lt;Location&gt; and &lt;Files&gt; sections work</a> for an
cd9eb79cfbf9bc730ccacc3a3774b1fe1b99ed53wrowe explanation of how these different sections are combined when a
cd9eb79cfbf9bc730ccacc3a3774b1fe1b99ed53wrowe request is received</seealso>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh</directivesynopsis>
cd9eb79cfbf9bc730ccacc3a3774b1fe1b99ed53wrowe
cd9eb79cfbf9bc730ccacc3a3774b1fe1b99ed53wrowe<directivesynopsis type="section">
cd9eb79cfbf9bc730ccacc3a3774b1fe1b99ed53wrowe<name>DirectoryMatch</name>
cd9eb79cfbf9bc730ccacc3a3774b1fe1b99ed53wrowe<description>Enclose directives that apply to
e57fd661645dcfdf166e77484b509b248e62a19eaaronthe contents of file-system directories matching a regular expression.</description>
e57fd661645dcfdf166e77484b509b248e62a19eaaron<syntax>&lt;DirectoryMatch <var>regex</var>&gt;
e57fd661645dcfdf166e77484b509b248e62a19eaaron... &lt;/DirectoryMatch&gt;</syntax>
cd9eb79cfbf9bc730ccacc3a3774b1fe1b99ed53wrowe<contextlist><context>server config</context><context>virtual host</context>
e57fd661645dcfdf166e77484b509b248e62a19eaaron</contextlist>
cd9eb79cfbf9bc730ccacc3a3774b1fe1b99ed53wrowe
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<usage>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <p><directive type="section">DirectoryMatch</directive> and
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <code>&lt;/DirectoryMatch&gt;</code> are used to enclose a group
cd9eb79cfbf9bc730ccacc3a3774b1fe1b99ed53wrowe of directives which will apply only to the named directory (and the files within),
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh the same as <directive module="core" type="section">Directory</directive>.
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh However, it takes as an argument a
2d2eda71267231c2526be701fe655db125852c1ffielding <glossary ref="regex">regular expression</glossary>. For example:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <example>
2d2eda71267231c2526be701fe655db125852c1ffielding &lt;DirectoryMatch "^/www/(.+/)?[0-9]{3}"&gt;
2d2eda71267231c2526be701fe655db125852c1ffielding </example>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>would match directories in <code>/www/</code> that consisted of three
2d2eda71267231c2526be701fe655db125852c1ffielding numbers.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <note><title>Compatability</title>
2d2eda71267231c2526be701fe655db125852c1ffielding Prior to 2.3.9, this directive implicitly applied to sub-directories
2d2eda71267231c2526be701fe655db125852c1ffielding (like <directive module="core" type="section">Directory</directive>) and
952908500d5f99f35afc5ed510391b9bdc3833farbb could not match the end of line symbol ($). In 2.3.9 and later,
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh only directories that match the expression are affected by the enclosed
2d2eda71267231c2526be701fe655db125852c1ffielding directives.
2d2eda71267231c2526be701fe655db125852c1ffielding </note>
2d2eda71267231c2526be701fe655db125852c1ffielding
952908500d5f99f35afc5ed510391b9bdc3833farbb <note><title>Trailing Slash</title>
952908500d5f99f35afc5ed510391b9bdc3833farbb This directive applies to requests for directories that may or may
952908500d5f99f35afc5ed510391b9bdc3833farbb not end in a trailing slash, so expressions that are anchored to the
952908500d5f99f35afc5ed510391b9bdc3833farbb end of line ($) must be written with care.
103a93c625bcde1a6a7a5155b64dcda36f612180pquerna </note>
103a93c625bcde1a6a7a5155b64dcda36f612180pquerna</usage>
952908500d5f99f35afc5ed510391b9bdc3833farbb<seealso><directive type="section" module="core">Directory</directive> for
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgsteina description of how regular expressions are mixed in with normal
952908500d5f99f35afc5ed510391b9bdc3833farbb<directive type="section">Directory</directive>s</seealso>
2d2eda71267231c2526be701fe655db125852c1ffielding<seealso><a
2d2eda71267231c2526be701fe655db125852c1ffieldinghref="/sections.html">How &lt;Directory&gt;, &lt;Location&gt; and
2d2eda71267231c2526be701fe655db125852c1ffielding&lt;Files&gt; sections work</a> for an explanation of how these different
3887202241db08986e94b252fbd06a55e55d4b2dbhydesections are combined when a request is received</seealso>
3887202241db08986e94b252fbd06a55e55d4b2dbhyde</directivesynopsis>
3887202241db08986e94b252fbd06a55e55d4b2dbhyde
3887202241db08986e94b252fbd06a55e55d4b2dbhyde<directivesynopsis>
3887202241db08986e94b252fbd06a55e55d4b2dbhyde<name>DocumentRoot</name>
3887202241db08986e94b252fbd06a55e55d4b2dbhyde<description>Directory that forms the main document tree visible
3887202241db08986e94b252fbd06a55e55d4b2dbhydefrom the web</description>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<syntax>DocumentRoot <var>directory-path</var></syntax>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<default>DocumentRoot /usr/local/apache/htdocs</default>
3887202241db08986e94b252fbd06a55e55d4b2dbhyde<contextlist><context>server config</context><context>virtual host</context>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh</contextlist>
2d2eda71267231c2526be701fe655db125852c1ffielding
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<usage>
3887202241db08986e94b252fbd06a55e55d4b2dbhyde <p>This directive sets the directory from which <program>httpd</program>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh will serve files. Unless matched by a directive like <directive
2d2eda71267231c2526be701fe655db125852c1ffielding module="mod_alias">Alias</directive>, the server appends the
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna path from the requested URL to the document root to make the
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna path to the document. Example:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
7c7372abe2484e7fcf81937b93496d1246e5b816gstein <example>
7c7372abe2484e7fcf81937b93496d1246e5b816gstein DocumentRoot /usr/web
864c5615d55b8ebbde24e72043f6325741335a74fielding </example>
2d2eda71267231c2526be701fe655db125852c1ffielding
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <p>then an access to
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <code>http://www.my.host.com/index.html</code> refers to
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <code>/usr/web/index.html</code>. If the <var>directory-path</var> is
3887202241db08986e94b252fbd06a55e55d4b2dbhyde not absolute then it is assumed to be relative to the <directive
e57fd661645dcfdf166e77484b509b248e62a19eaaron module="core">ServerRoot</directive>.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
e57fd661645dcfdf166e77484b509b248e62a19eaaron <p>The <directive>DocumentRoot</directive> should be specified without
952908500d5f99f35afc5ed510391b9bdc3833farbb a trailing slash.</p>
e57fd661645dcfdf166e77484b509b248e62a19eaaron</usage>
3887202241db08986e94b252fbd06a55e55d4b2dbhyde<seealso><a href="/urlmapping.html#documentroot">Mapping URLs to Filesystem
952908500d5f99f35afc5ed510391b9bdc3833farbbLocations</a></seealso>
50cf9b8da68bea71ce5a49b4cb4be3be516486bdgstein</directivesynopsis>
952908500d5f99f35afc5ed510391b9bdc3833farbb
3887202241db08986e94b252fbd06a55e55d4b2dbhyde<directivesynopsis>
3887202241db08986e94b252fbd06a55e55d4b2dbhyde<name>EnableMMAP</name>
3887202241db08986e94b252fbd06a55e55d4b2dbhyde<description>Use memory-mapping to read files during delivery</description>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<syntax>EnableMMAP On|Off</syntax>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<default>EnableMMAP On</default>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<contextlist><context>server config</context><context>virtual host</context>
2d2eda71267231c2526be701fe655db125852c1ffielding<context>directory</context><context>.htaccess</context>
952908500d5f99f35afc5ed510391b9bdc3833farbb</contextlist>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm<override>FileInfo</override>
e57fd661645dcfdf166e77484b509b248e62a19eaaron
2d2eda71267231c2526be701fe655db125852c1ffielding<usage>
e57fd661645dcfdf166e77484b509b248e62a19eaaron <p>This directive controls whether the <program>httpd</program> may use
2d2eda71267231c2526be701fe655db125852c1ffielding memory-mapping if it needs to read the contents of a file during
2d2eda71267231c2526be701fe655db125852c1ffielding delivery. By default, when the handling of a request requires
e57fd661645dcfdf166e77484b509b248e62a19eaaron access to the data within a file -- for example, when delivering a
952908500d5f99f35afc5ed510391b9bdc3833farbb server-parsed file using <module>mod_include</module> -- Apache httpd
e57fd661645dcfdf166e77484b509b248e62a19eaaron memory-maps the file if the OS supports it.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
2d2eda71267231c2526be701fe655db125852c1ffielding <p>This memory-mapping sometimes yields a performance improvement.
6658f209f08181bd218341770db9f428032dd23ajwoolley But in some environments, it is better to disable the memory-mapping
6658f209f08181bd218341770db9f428032dd23ajwoolley to prevent operational problems:</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
2d2eda71267231c2526be701fe655db125852c1ffielding <ul>
2d2eda71267231c2526be701fe655db125852c1ffielding <li>On some multiprocessor systems, memory-mapping can reduce the
2d2eda71267231c2526be701fe655db125852c1ffielding performance of the <program>httpd</program>.</li>
2d2eda71267231c2526be701fe655db125852c1ffielding <li>Deleting or truncating a file while <program>httpd</program>
e57fd661645dcfdf166e77484b509b248e62a19eaaron has it memory-mapped can cause <program>httpd</program> to
952908500d5f99f35afc5ed510391b9bdc3833farbb crash with a segmentation fault.
97ff7bf3f33a3527953d975df5cbf82a5a7dc9a6wrowe </li>
952908500d5f99f35afc5ed510391b9bdc3833farbb </ul>
853a0c44563b056e40e9cffe911190f554e63ec3chuck
79c0ed7d839527abd86794a6b1d2df4fd189a2a8jerenkrantz <p>For server configurations that are vulnerable to these problems,
79c0ed7d839527abd86794a6b1d2df4fd189a2a8jerenkrantz you should disable memory-mapping of delivered files by specifying:</p>
853a0c44563b056e40e9cffe911190f554e63ec3chuck
952908500d5f99f35afc5ed510391b9bdc3833farbb <example>
952908500d5f99f35afc5ed510391b9bdc3833farbb EnableMMAP Off
952908500d5f99f35afc5ed510391b9bdc3833farbb </example>
e57fd661645dcfdf166e77484b509b248e62a19eaaron
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>For NFS mounted files, this feature may be disabled explicitly for
e57fd661645dcfdf166e77484b509b248e62a19eaaron the offending files by specifying:</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <example>
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;Directory "/path-to-nfs-files"&gt;
952908500d5f99f35afc5ed510391b9bdc3833farbb <indent>
e57fd661645dcfdf166e77484b509b248e62a19eaaron EnableMMAP Off
952908500d5f99f35afc5ed510391b9bdc3833farbb </indent>
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;/Directory&gt;
952908500d5f99f35afc5ed510391b9bdc3833farbb </example>
952908500d5f99f35afc5ed510391b9bdc3833farbb</usage>
e57fd661645dcfdf166e77484b509b248e62a19eaaron</directivesynopsis>
952908500d5f99f35afc5ed510391b9bdc3833farbb
2d2eda71267231c2526be701fe655db125852c1ffielding<directivesynopsis>
2d2eda71267231c2526be701fe655db125852c1ffielding<name>EnableSendfile</name>
2d2eda71267231c2526be701fe655db125852c1ffielding<description>Use the kernel sendfile support to deliver files to the client</description>
2d2eda71267231c2526be701fe655db125852c1ffielding<syntax>EnableSendfile On|Off</syntax>
2d2eda71267231c2526be701fe655db125852c1ffielding<default>EnableSendfile Off</default>
e57fd661645dcfdf166e77484b509b248e62a19eaaron<contextlist><context>server config</context><context>virtual host</context>
952908500d5f99f35afc5ed510391b9bdc3833farbb<context>directory</context><context>.htaccess</context>
952908500d5f99f35afc5ed510391b9bdc3833farbb</contextlist>
952908500d5f99f35afc5ed510391b9bdc3833farbb<override>FileInfo</override>
952908500d5f99f35afc5ed510391b9bdc3833farbb<compatibility>Available in version 2.0.44 and later. Default changed to Off in
9f9307bbe539dbcf96919715315eb64ce3465f5bbenversion 2.3.9.</compatibility>
e57fd661645dcfdf166e77484b509b248e62a19eaaron
952908500d5f99f35afc5ed510391b9bdc3833farbb<usage>
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>This directive controls whether <program>httpd</program> may use the
952908500d5f99f35afc5ed510391b9bdc3833farbb sendfile support from the kernel to transmit file contents to the client.
952908500d5f99f35afc5ed510391b9bdc3833farbb By default, when the handling of a request requires no access
952908500d5f99f35afc5ed510391b9bdc3833farbb to the data within a file -- for example, when delivering a
952908500d5f99f35afc5ed510391b9bdc3833farbb static file -- Apache httpd uses sendfile to deliver the file contents
952908500d5f99f35afc5ed510391b9bdc3833farbb without ever reading the file if the OS supports it.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>This sendfile mechanism avoids separate read and send operations,
952908500d5f99f35afc5ed510391b9bdc3833farbb and buffer allocations. But on some platforms or within some
952908500d5f99f35afc5ed510391b9bdc3833farbb filesystems, it is better to disable this feature to avoid
952908500d5f99f35afc5ed510391b9bdc3833farbb operational problems:</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <ul>
952908500d5f99f35afc5ed510391b9bdc3833farbb <li>Some platforms may have broken sendfile support that the build
952908500d5f99f35afc5ed510391b9bdc3833farbb system did not detect, especially if the binaries were built on
9f9307bbe539dbcf96919715315eb64ce3465f5bben another box and moved to such a machine with broken sendfile
952908500d5f99f35afc5ed510391b9bdc3833farbb support.</li>
62db15de4c1f335a64d45821796ae197cff94ef8rbb <li>On Linux the use of sendfile triggers TCP-checksum
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb offloading bugs on certain networking cards when using IPv6.</li>
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb <li>On Linux on Itanium, sendfile may be unable to handle files
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb over 2GB in size.</li>
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb <li>With a network-mounted <directive
2d2eda71267231c2526be701fe655db125852c1ffielding module="core">DocumentRoot</directive> (e.g., NFS, SMB, CIFS, FUSE),
952908500d5f99f35afc5ed510391b9bdc3833farbb the kernel may be unable to serve the network file through
11a7b0dff22d26770b532c174d1cf2e7b56ec244wrowe its own cache.</li>
952908500d5f99f35afc5ed510391b9bdc3833farbb </ul>
11a7b0dff22d26770b532c174d1cf2e7b56ec244wrowe
e57fd661645dcfdf166e77484b509b248e62a19eaaron <p>For server configurations that are not vulnerable to these problems,
952908500d5f99f35afc5ed510391b9bdc3833farbb you may enable this feature by specifying:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <example>
2d2eda71267231c2526be701fe655db125852c1ffielding EnableSendfile On
952908500d5f99f35afc5ed510391b9bdc3833farbb </example>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>For network mounted files, this feature may be disabled explicitly
952908500d5f99f35afc5ed510391b9bdc3833farbb for the offending files by specifying:</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
7bdef86e15d47d16dcbe7a5611683191774bd5fbgstein <example>
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;Directory "/path-to-nfs-files"&gt;
e57fd661645dcfdf166e77484b509b248e62a19eaaron <indent>
11a7b0dff22d26770b532c174d1cf2e7b56ec244wrowe EnableSendfile Off
e57fd661645dcfdf166e77484b509b248e62a19eaaron </indent>
11a7b0dff22d26770b532c174d1cf2e7b56ec244wrowe &lt;/Directory&gt;
e57fd661645dcfdf166e77484b509b248e62a19eaaron </example>
e57fd661645dcfdf166e77484b509b248e62a19eaaron <p>Please note that the per-directory and .htaccess configuration
e57fd661645dcfdf166e77484b509b248e62a19eaaron of <directive>EnableSendfile</directive> is not supported by
952908500d5f99f35afc5ed510391b9bdc3833farbb <module>mod_cache_disk</module>.
952908500d5f99f35afc5ed510391b9bdc3833farbb Only global definition of <directive>EnableSendfile</directive>
952908500d5f99f35afc5ed510391b9bdc3833farbb is taken into account by the module.
952908500d5f99f35afc5ed510391b9bdc3833farbb </p>
952908500d5f99f35afc5ed510391b9bdc3833farbb</usage>
2d2eda71267231c2526be701fe655db125852c1ffielding</directivesynopsis>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding<directivesynopsis>
2d2eda71267231c2526be701fe655db125852c1ffielding<name>Error</name>
2d2eda71267231c2526be701fe655db125852c1ffielding<description>Abort configuration parsing with a custom error message</description>
2d2eda71267231c2526be701fe655db125852c1ffielding<syntax>Error <var>message</var></syntax>
2d2eda71267231c2526be701fe655db125852c1ffielding<contextlist><context>server config</context><context>virtual host</context>
2d2eda71267231c2526be701fe655db125852c1ffielding<context>directory</context><context>.htaccess</context>
2d2eda71267231c2526be701fe655db125852c1ffielding</contextlist>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm<compatibility>2.3.9 and later</compatibility>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding<usage>
2d2eda71267231c2526be701fe655db125852c1ffielding <p>If an error can be detected within the configuration, this
952908500d5f99f35afc5ed510391b9bdc3833farbb directive can be used to generate a custom error message, and halt
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm configuration parsing. The typical use is for reporting required
952908500d5f99f35afc5ed510391b9bdc3833farbb modules which are missing from the configuration.</p>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm
952908500d5f99f35afc5ed510391b9bdc3833farbb <example><title>Example</title>
952908500d5f99f35afc5ed510391b9bdc3833farbb # ensure that mod_include is loaded<br />
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm &lt;IfModule !include_module&gt;<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb Error mod_include is required by mod_foo. Load it with LoadModule.<br />
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm &lt;/IfModule&gt;<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb <br />
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm # ensure that exactly one of SSL,NOSSL is defined<br />
2d2eda71267231c2526be701fe655db125852c1ffielding &lt;IfDefine SSL&gt;<br />
44a4ee1140769173da7bc2b42d1a686e3260ad84wrowe &lt;IfDefine NOSSL&gt;<br />
44a4ee1140769173da7bc2b42d1a686e3260ad84wrowe Error Both SSL and NOSSL are defined. Define only one of them.<br />
44a4ee1140769173da7bc2b42d1a686e3260ad84wrowe &lt;/IfDefine&gt;<br />
2d2eda71267231c2526be701fe655db125852c1ffielding &lt;/IfDefine&gt;<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;IfDefine !SSL&gt;<br />
2d2eda71267231c2526be701fe655db125852c1ffielding &lt;IfDefine !NOSSL&gt;<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb Error Either SSL or NOSSL must be defined.<br />
e57fd661645dcfdf166e77484b509b248e62a19eaaron &lt;/IfDefine&gt;<br />
2d2eda71267231c2526be701fe655db125852c1ffielding &lt;/IfDefine&gt;<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb </example>
2d2eda71267231c2526be701fe655db125852c1ffielding
e57fd661645dcfdf166e77484b509b248e62a19eaaron</usage>
952908500d5f99f35afc5ed510391b9bdc3833farbb</directivesynopsis>
2d2eda71267231c2526be701fe655db125852c1ffielding
952908500d5f99f35afc5ed510391b9bdc3833farbb<directivesynopsis>
952908500d5f99f35afc5ed510391b9bdc3833farbb<name>ErrorDocument</name>
2e123e8beedc9f921448c113e2d6823a92fd5261fielding<description>What the server will return to the client
952908500d5f99f35afc5ed510391b9bdc3833farbbin case of an error</description>
952908500d5f99f35afc5ed510391b9bdc3833farbb<syntax>ErrorDocument <var>error-code</var> <var>document</var></syntax>
952908500d5f99f35afc5ed510391b9bdc3833farbb<contextlist><context>server config</context><context>virtual host</context>
952908500d5f99f35afc5ed510391b9bdc3833farbb<context>directory</context><context>.htaccess</context>
2d2eda71267231c2526be701fe655db125852c1ffielding</contextlist>
e57fd661645dcfdf166e77484b509b248e62a19eaaron<override>FileInfo</override>
2d2eda71267231c2526be701fe655db125852c1ffielding
952908500d5f99f35afc5ed510391b9bdc3833farbb<usage>
2d2eda71267231c2526be701fe655db125852c1ffielding <p>In the event of a problem or error, Apache httpd can be configured
2d2eda71267231c2526be701fe655db125852c1ffielding to do one of four things,</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <ol>
2d2eda71267231c2526be701fe655db125852c1ffielding <li>output a simple hardcoded error message</li>
2d2eda71267231c2526be701fe655db125852c1ffielding
e57fd661645dcfdf166e77484b509b248e62a19eaaron <li>output a customized message</li>
952908500d5f99f35afc5ed510391b9bdc3833farbb
e57fd661645dcfdf166e77484b509b248e62a19eaaron <li>redirect to a local <var>URL-path</var> to handle the
952908500d5f99f35afc5ed510391b9bdc3833farbb problem/error</li>
e57fd661645dcfdf166e77484b509b248e62a19eaaron
2d2eda71267231c2526be701fe655db125852c1ffielding <li>redirect to an external <var>URL</var> to handle the
e57fd661645dcfdf166e77484b509b248e62a19eaaron problem/error</li>
fa3785601cc3801525bc3fc98cafcea5d82efe99wrowe </ol>
a18775c154178d6c07aed84bd54ac16f59f89bc9wrowe
e57fd661645dcfdf166e77484b509b248e62a19eaaron <p>The first option is the default, while options 2-4 are
2d2eda71267231c2526be701fe655db125852c1ffielding configured using the <directive>ErrorDocument</directive>
e57fd661645dcfdf166e77484b509b248e62a19eaaron directive, which is followed by the HTTP response code and a URL
952908500d5f99f35afc5ed510391b9bdc3833farbb or a message. Apache httpd will sometimes offer additional information
eb0fa8f996539c1cd5e5edf34f46e7e9c199641estas regarding the problem/error.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
e57fd661645dcfdf166e77484b509b248e62a19eaaron <p>URLs can begin with a slash (/) for local web-paths (relative
8b99f2a316c5e2fa6ab208206fdd7fc2bfc4a921dougm to the <directive module="core">DocumentRoot</directive>), or be a
2d2eda71267231c2526be701fe655db125852c1ffielding full URL which the client can resolve. Alternatively, a message
e57fd661645dcfdf166e77484b509b248e62a19eaaron can be provided to be displayed by the browser. Examples:</p>
e57fd661645dcfdf166e77484b509b248e62a19eaaron
e57fd661645dcfdf166e77484b509b248e62a19eaaron <example>
e57fd661645dcfdf166e77484b509b248e62a19eaaron ErrorDocument 500 http://foo.example.com/cgi-bin/tester<br />
e57fd661645dcfdf166e77484b509b248e62a19eaaron ErrorDocument 404 /cgi-bin/bad_urls.pl<br />
e57fd661645dcfdf166e77484b509b248e62a19eaaron ErrorDocument 401 /subscription_info.html<br />
e57fd661645dcfdf166e77484b509b248e62a19eaaron ErrorDocument 403 "Sorry can't allow you access today"
cd9eb79cfbf9bc730ccacc3a3774b1fe1b99ed53wrowe </example>
97ff7bf3f33a3527953d975df5cbf82a5a7dc9a6wrowe
97ff7bf3f33a3527953d975df5cbf82a5a7dc9a6wrowe <p>Additionally, the special value <code>default</code> can be used
2d2eda71267231c2526be701fe655db125852c1ffielding to specify Apache httpd's simple hardcoded message. While not required
2d2eda71267231c2526be701fe655db125852c1ffielding under normal circumstances, <code>default</code> will restore
2d2eda71267231c2526be701fe655db125852c1ffielding Apache httpd's simple hardcoded message for configurations that would
2d2eda71267231c2526be701fe655db125852c1ffielding otherwise inherit an existing <directive>ErrorDocument</directive>.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
952908500d5f99f35afc5ed510391b9bdc3833farbb <example>
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein ErrorDocument 404 /cgi-bin/bad_urls.pl<br /><br />
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;Directory /web/docs&gt;<br />
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein <indent>
2d2eda71267231c2526be701fe655db125852c1ffielding ErrorDocument 404 default<br />
e57fd661645dcfdf166e77484b509b248e62a19eaaron </indent>
e57fd661645dcfdf166e77484b509b248e62a19eaaron &lt;/Directory&gt;
e57fd661645dcfdf166e77484b509b248e62a19eaaron </example>
e57fd661645dcfdf166e77484b509b248e62a19eaaron
e57fd661645dcfdf166e77484b509b248e62a19eaaron <p>Note that when you specify an <directive>ErrorDocument</directive>
e57fd661645dcfdf166e77484b509b248e62a19eaaron that points to a remote URL (ie. anything with a method such as
2d2eda71267231c2526be701fe655db125852c1ffielding <code>http</code> in front of it), Apache HTTP Server will send a redirect to the
2d2eda71267231c2526be701fe655db125852c1ffielding client to tell it where to find the document, even if the
9f9307bbe539dbcf96919715315eb64ce3465f5bben document ends up being on the same server. This has several
a93bda3b944fb92e3850db5621b5a27fc0e44509wrowe implications, the most important being that the client will not
9f9307bbe539dbcf96919715315eb64ce3465f5bben receive the original error status code, but instead will
a93bda3b944fb92e3850db5621b5a27fc0e44509wrowe receive a redirect status code. This in turn can confuse web
e57e920838f31508f1418aa4c25ce55b345b2cebrbb robots and other clients which try to determine if a URL is
e57e920838f31508f1418aa4c25ce55b345b2cebrbb valid using the status code. In addition, if you use a remote
e57e920838f31508f1418aa4c25ce55b345b2cebrbb URL in an <code>ErrorDocument 401</code>, the client will not
a93bda3b944fb92e3850db5621b5a27fc0e44509wrowe know to prompt the user for a password since it will not
e57e920838f31508f1418aa4c25ce55b345b2cebrbb receive the 401 status code. Therefore, <strong>if you use an
e57e920838f31508f1418aa4c25ce55b345b2cebrbb <code>ErrorDocument 401</code> directive then it must refer to a local
a93bda3b944fb92e3850db5621b5a27fc0e44509wrowe document.</strong></p>
e57e920838f31508f1418aa4c25ce55b345b2cebrbb
9f9307bbe539dbcf96919715315eb64ce3465f5bben <p>Microsoft Internet Explorer (MSIE) will by default ignore
da76b1004afd7a8785684c84e4d4b5c893c65572rbb server-generated error messages when they are "too small" and substitute
777a2b42697cb8cb94ac4e73774862f879259c45rbb its own "friendly" error messages. The size threshold varies depending on
439ccf2a084e1da566548931c585cbcc3a9e7f4cminfrin the type of error, but in general, if you make your error document
439ccf2a084e1da566548931c585cbcc3a9e7f4cminfrin greater than 512 bytes, then MSIE will show the server-generated
439ccf2a084e1da566548931c585cbcc3a9e7f4cminfrin error rather than masking it. More information is available in
b0d8a6d437db6f4c222173f27ef81c98622fbd02pquerna Microsoft Knowledge Base article <a
b0d8a6d437db6f4c222173f27ef81c98622fbd02pquerna href="http://support.microsoft.com/default.aspx?scid=kb;en-us;Q294807"
cb1e20df951447249fd1344ae04a790219a16be5pquerna >Q294807</a>.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>Although most error messages can be overriden, there are certain
2d2eda71267231c2526be701fe655db125852c1ffielding circumstances where the internal messages are used regardless of the
2d2eda71267231c2526be701fe655db125852c1ffielding setting of <directive module="core">ErrorDocument</directive>. In
2d2eda71267231c2526be701fe655db125852c1ffielding particular, if a malformed request is detected, normal request processing
2d2eda71267231c2526be701fe655db125852c1ffielding will be immediately halted and the internal error message returned.
2d2eda71267231c2526be701fe655db125852c1ffielding This is necessary to guard against security problems caused by
9f9307bbe539dbcf96919715315eb64ce3465f5bben bad requests.</p>
9f9307bbe539dbcf96919715315eb64ce3465f5bben
9f9307bbe539dbcf96919715315eb64ce3465f5bben <p>If you are using mod_proxy, you may wish to enable
9f9307bbe539dbcf96919715315eb64ce3465f5bben <directive module="mod_proxy">ProxyErrorOverride</directive> so that you can provide
853a0c44563b056e40e9cffe911190f554e63ec3chuck custom error messages on behalf of your Origin servers. If you don't enable ProxyErrorOverride,
853a0c44563b056e40e9cffe911190f554e63ec3chuck Apache httpd will not generate custom error documents for proxied content.</p>
853a0c44563b056e40e9cffe911190f554e63ec3chuck</usage>
9f9307bbe539dbcf96919715315eb64ce3465f5bben
853a0c44563b056e40e9cffe911190f554e63ec3chuck<seealso><a href="/custom-error.html">documentation of
853a0c44563b056e40e9cffe911190f554e63ec3chuck customizable responses</a></seealso>
9f9307bbe539dbcf96919715315eb64ce3465f5bben</directivesynopsis>
9f9307bbe539dbcf96919715315eb64ce3465f5bben
9f9307bbe539dbcf96919715315eb64ce3465f5bben<directivesynopsis>
79c0ed7d839527abd86794a6b1d2df4fd189a2a8jerenkrantz<name>ErrorLog</name>
9f9307bbe539dbcf96919715315eb64ce3465f5bben<description>Location where the server will log errors</description>
9f9307bbe539dbcf96919715315eb64ce3465f5bben<syntax> ErrorLog <var>file-path</var>|syslog[:<var>facility</var>]</syntax>
853a0c44563b056e40e9cffe911190f554e63ec3chuck<default>ErrorLog logs/error_log (Unix) ErrorLog logs/error.log (Windows and OS/2)</default>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<contextlist><context>server config</context><context>virtual host</context>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh</contextlist>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
f9a773d26994c3b267589e404cdb5b760f83e888jerenkrantz<usage>
f9a773d26994c3b267589e404cdb5b760f83e888jerenkrantz <p>The <directive>ErrorLog</directive> directive sets the name of
f9a773d26994c3b267589e404cdb5b760f83e888jerenkrantz the file to which the server will log any errors it encounters. If
f9a773d26994c3b267589e404cdb5b760f83e888jerenkrantz the <var>file-path</var> is not absolute then it is assumed to be
f9a773d26994c3b267589e404cdb5b760f83e888jerenkrantz relative to the <directive module="core">ServerRoot</directive>.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <example><title>Example</title>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh ErrorLog /var/log/httpd/error_log
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh </example>
2d2eda71267231c2526be701fe655db125852c1ffielding
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>If the <var>file-path</var>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm begins with a pipe character "<code>|</code>" then it is assumed to be a
be8a31a0afdb2363dbcc98bbbaa94b6184061b5fdreid command to spawn to handle the error log.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <example><title>Example</title>
952908500d5f99f35afc5ed510391b9bdc3833farbb ErrorLog "|/usr/local/bin/httpd_errors"
2d2eda71267231c2526be701fe655db125852c1ffielding </example>
2d2eda71267231c2526be701fe655db125852c1ffielding
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>See the notes on <a href="/logs.html#piped">piped logs</a> for
91644a5f4d3e992dc208304b50e80bbb236fca89trawick more information.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
91644a5f4d3e992dc208304b50e80bbb236fca89trawick <p>Using <code>syslog</code> instead of a filename enables logging
e6cc28a5eb3371ba0c38e941855e71ff0054f50erbb via syslogd(8) if the system supports it. The default is to use
952908500d5f99f35afc5ed510391b9bdc3833farbb syslog facility <code>local7</code>, but you can override this by
952908500d5f99f35afc5ed510391b9bdc3833farbb using the <code>syslog:<var>facility</var></code> syntax where
952908500d5f99f35afc5ed510391b9bdc3833farbb <var>facility</var> can be one of the names usually documented in
952908500d5f99f35afc5ed510391b9bdc3833farbb syslog(1). The facility is effectively global, and if it is changed
952908500d5f99f35afc5ed510391b9bdc3833farbb in individual virtual hosts, the final facility specified affects the
952908500d5f99f35afc5ed510391b9bdc3833farbb entire server.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <example><title>Example</title>
952908500d5f99f35afc5ed510391b9bdc3833farbb ErrorLog syslog:user
952908500d5f99f35afc5ed510391b9bdc3833farbb </example>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>SECURITY: See the <a
8019a211b7453e80e6e22db6d41fe68dd7f8c4b8fielding href="/misc/security_tips.html#serverroot">security tips</a>
8019a211b7453e80e6e22db6d41fe68dd7f8c4b8fielding document for details on why your security could be compromised
f9a773d26994c3b267589e404cdb5b760f83e888jerenkrantz if the directory where log files are stored is writable by
f9a773d26994c3b267589e404cdb5b760f83e888jerenkrantz anyone other than the user that starts the server.</p>
8019a211b7453e80e6e22db6d41fe68dd7f8c4b8fielding <note type="warning"><title>Note</title>
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>When entering a file path on non-Unix platforms, care should be taken
952908500d5f99f35afc5ed510391b9bdc3833farbb to make sure that only forward slashed are used even though the platform
952908500d5f99f35afc5ed510391b9bdc3833farbb may allow the use of back slashes. In general it is a good idea to always
952908500d5f99f35afc5ed510391b9bdc3833farbb use forward slashes throughout the configuration files.</p>
ae2f0a4a94a833fd44cb6b5c1f520cbc76ff72fefielding </note>
ae2f0a4a94a833fd44cb6b5c1f520cbc76ff72fefielding</usage>
952908500d5f99f35afc5ed510391b9bdc3833farbb<seealso><directive module="core">LogLevel</directive></seealso>
952908500d5f99f35afc5ed510391b9bdc3833farbb<seealso><a href="/logs.html">Apache HTTP Server Log Files</a></seealso>
952908500d5f99f35afc5ed510391b9bdc3833farbb</directivesynopsis>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb<directivesynopsis>
952908500d5f99f35afc5ed510391b9bdc3833farbb<name>ErrorLogFormat</name>
952908500d5f99f35afc5ed510391b9bdc3833farbb<description>Format specification for error log entries</description>
952908500d5f99f35afc5ed510391b9bdc3833farbb<syntax> ErrorLog [connection|request] <var>format</var></syntax>
eb0fa8f996539c1cd5e5edf34f46e7e9c199641estas<contextlist><context>server config</context><context>virtual host</context>
eb0fa8f996539c1cd5e5edf34f46e7e9c199641estas</contextlist>
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein<compatibility>Available in Apache httpd 2.3.9 and later</compatibility>
eb0fa8f996539c1cd5e5edf34f46e7e9c199641estas
eb0fa8f996539c1cd5e5edf34f46e7e9c199641estas<usage>
952908500d5f99f35afc5ed510391b9bdc3833farbb <p><directive>ErrorLogFormat</directive> allows to specify what
9f9307bbe539dbcf96919715315eb64ce3465f5bben supplementary information is logged in the error log in addition to the
a93bda3b944fb92e3850db5621b5a27fc0e44509wrowe actual log message.</p>
9f9307bbe539dbcf96919715315eb64ce3465f5bben
a93bda3b944fb92e3850db5621b5a27fc0e44509wrowe <example><title>Simple example</title>
ca47a2b6bcea23e8af185c68f256dcbbfd2a0f9dtrawick ErrorLogFormat "[%t] [%l] [pid %P] %F: %E: [client %a] %M"
ca47a2b6bcea23e8af185c68f256dcbbfd2a0f9dtrawick </example>
2fc50921b88defeb7127985dfe4b4130175e069ejwoolley
2fc50921b88defeb7127985dfe4b4130175e069ejwoolley <p>Specifying <code>connection</code> or <code>request</code> as first
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna paramter allows to specify additional formats, causing additional
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna information to be logged when the first message is logged for a specific
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna connection or request, respectivly. This additional information is only
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna logged once per connection/request. If a connection or request is processed
2f1bb5376c5c4022383bb729679ca751dd75a2eabrianp without causing any log message, the additional information is not logged
2f1bb5376c5c4022383bb729679ca751dd75a2eabrianp either.</p>
ddc593aa9ac8b227d1fd9677a3a2b24539b5d608pquerna
135402675e89e6df0e17735e48f428a1e1d8eb16pquerna <p>It can happen that some format string items do not produce output. For
135402675e89e6df0e17735e48f428a1e1d8eb16pquerna example, the Referer header is only present if the log message is
135402675e89e6df0e17735e48f428a1e1d8eb16pquerna associated to a request and the log message happens at a time when the
135402675e89e6df0e17735e48f428a1e1d8eb16pquerna Referer header has already been read from the client. If no output is
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna produced, the default behaviour is to delete everything from the preceeding
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna space character to the next space character. This means the log line is
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh implicitly divided into fields on non-whitespace to whitespace transitions.
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh If a format string item does not produce output, the whole field is
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh ommitted. For example, if the remote address <code>%a</code> in the log
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna format <code>[%t] [%l] [%a] %M&nbsp;</code> is not available, the surrounding
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna brackets are not logged either. Space characters can be escaped with a
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna backslash to prevent them from delimiting a field. The combination '%&nbsp;'
ad862ab5716726a2d72a292ba1dfb29566c86153brianp (percent space) is a zero-witdh field delimiter that does not produce any
ad862ab5716726a2d72a292ba1dfb29566c86153brianp output.</p>
b0d8a6d437db6f4c222173f27ef81c98622fbd02pquerna
6d866a6eb84421d08d630030c2a7a2f53f248ad9jorton <p>The above behaviour can be changed by adding modifiers to the format
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna string item. A <code>-</code> (minus) modifier causes a minus to be logged if the
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna respective item does not produce any output. In once-per-connection/request
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh formats, it is also possible to use the <code>+</code> (plus) modifier. If an
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh item with the plus modifier does not produce any output, the whole line is
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh ommitted.</p>
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <p>A number as modifier can be used to assign a log severity level to a
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh format item. The item will only be logged if the severity of the log
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh message is not higher than the specified log severity level. The number can
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh range from 1 (alert) over 4 (warn) and 7 (debug) to 15 (trace8).</p>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna <p>Some format string items accept additional parameters in braces.</p>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna <table border="1" style="zebra">
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <columnspec><column width=".2"/><column width=".8"/></columnspec>
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <tr><th>Format&nbsp;String</th> <th>Description</th></tr>
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <tr><td><code>%%</code></td>
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna <td>The percent sign</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <tr><td><code>%...a</code></td>
2d2eda71267231c2526be701fe655db125852c1ffielding <td>Remote IP-address and port</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <tr><td><code>%...A</code></td>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <td>Local IP-address and port</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <tr><td><code>%...{name}e</code></td>
2d2eda71267231c2526be701fe655db125852c1ffielding <td>Request environment variable <code>name</code></td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding
952908500d5f99f35afc5ed510391b9bdc3833farbb <tr><td><code>%...E</code></td>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <td>APR/OS error status code and string</td></tr>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <tr><td><code>%...F</code></td>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <td>Source file name and line number of the log call</td></tr>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
2d2eda71267231c2526be701fe655db125852c1ffielding <tr><td><code>%...{name}i</code></td>
169f62b04de69074b561b4e6dcf6f82572a5e367trawick <td>Request header <code>name</code></td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding
952908500d5f99f35afc5ed510391b9bdc3833farbb <tr><td><code>%...k</code></td>
8a261a9f7d18d1e862d63f68e93f288d3e1f0d94trawick <td>Number of keep-alive requests on this connection</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb
dad234382d8424e1c5a30af2838e172aec9d6d1bdreid <tr><td><code>%...l</code></td>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <td>Loglevel of the message</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb
2d2eda71267231c2526be701fe655db125852c1ffielding <tr><td><code>%...L</code></td>
2d2eda71267231c2526be701fe655db125852c1ffielding <td>Log ID of the request</td></tr>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <tr><td><code>%...{c}L</code></td>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <td>Log ID of the connection</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding
952908500d5f99f35afc5ed510391b9bdc3833farbb <tr><td><code>%...{C}L</code></td>
3887202241db08986e94b252fbd06a55e55d4b2dbhyde <td>Log ID of the connection if used in connection scope, empty otherwise</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb
2d2eda71267231c2526be701fe655db125852c1ffielding <tr><td><code>%...m</code></td>
2d2eda71267231c2526be701fe655db125852c1ffielding <td>Name of the module logging the message</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb
2d2eda71267231c2526be701fe655db125852c1ffielding <tr><td><code>%M</code></td>
952908500d5f99f35afc5ed510391b9bdc3833farbb <td>The actual log message</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <tr><td><code>%...{name}n</code></td>
2d2eda71267231c2526be701fe655db125852c1ffielding <td>Request note <code>name</code></td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding
952908500d5f99f35afc5ed510391b9bdc3833farbb <tr><td><code>%...P</code></td>
2d2eda71267231c2526be701fe655db125852c1ffielding <td>Process ID of current process</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb
2d2eda71267231c2526be701fe655db125852c1ffielding <tr><td><code>%...T</code></td>
952908500d5f99f35afc5ed510391b9bdc3833farbb <td>Thread ID of current thread</td></tr>
dad234382d8424e1c5a30af2838e172aec9d6d1bdreid
2d2eda71267231c2526be701fe655db125852c1ffielding <tr><td><code>%...t</code></td>
2d2eda71267231c2526be701fe655db125852c1ffielding <td>The current time</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding
952908500d5f99f35afc5ed510391b9bdc3833farbb <tr><td><code>%...{u}t</code></td>
2d2eda71267231c2526be701fe655db125852c1ffielding <td>The current time including micro-seconds</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm <tr><td><code>%...{cu}t</code></td>
952908500d5f99f35afc5ed510391b9bdc3833farbb <td>The current time in compact ISO 8601 format, including
2d2eda71267231c2526be701fe655db125852c1ffielding micro-seconds</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <tr><td><code>%...v</code></td>
2d2eda71267231c2526be701fe655db125852c1ffielding <td>The canonical <directive module="core">ServerName</directive>
952908500d5f99f35afc5ed510391b9bdc3833farbb of the current server.</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <tr><td><code>%...V</code></td>
952908500d5f99f35afc5ed510391b9bdc3833farbb <td>The server name of the server serving the request according to the
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein <directive module="core" >UseCanonicalName</directive>
169f62b04de69074b561b4e6dcf6f82572a5e367trawick setting.</td></tr>
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein
952908500d5f99f35afc5ed510391b9bdc3833farbb <tr><td><code>\&nbsp;</code> (backslash space)</td>
2d2eda71267231c2526be701fe655db125852c1ffielding <td>Non-field delimiting space</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding
952908500d5f99f35afc5ed510391b9bdc3833farbb <tr><td><code>%&nbsp;</code> (percent space)</td>
2d2eda71267231c2526be701fe655db125852c1ffielding <td>Field delimiter (no output)</td></tr>
fa861fc5a880d2c3a5ecc0ec71fa7da556adf5c1wrowe </table>
fa861fc5a880d2c3a5ecc0ec71fa7da556adf5c1wrowe
fa861fc5a880d2c3a5ecc0ec71fa7da556adf5c1wrowe <p>The log ID format <code>%L</code> produces a unique id for a connection
fa861fc5a880d2c3a5ecc0ec71fa7da556adf5c1wrowe or request. This can be used to correlate which log lines belong to the
952908500d5f99f35afc5ed510391b9bdc3833farbb same connection or request, which request happens on which connection.
952908500d5f99f35afc5ed510391b9bdc3833farbb A <code>%L</code> format string is also available in
952908500d5f99f35afc5ed510391b9bdc3833farbb <module>mod_log_config</module>, to allow to correlate access log entries
952908500d5f99f35afc5ed510391b9bdc3833farbb with error log lines. If <module>mod_unique_id</module> is loaded, its
952908500d5f99f35afc5ed510391b9bdc3833farbb unique id will be used as log ID for requests.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <example><title>Example (somewhat similar to default format)</title>
952908500d5f99f35afc5ed510391b9bdc3833farbb ErrorLogFormat "[%{u}t] [%-m:%l] [pid %P] %7F: %E: [client\ %a]
aecb17a45c6d3ee4729ed5f68dc4270f211ee7a8fielding %M%&nbsp;,\&nbsp;referer\&nbsp;%{Referer}i"
952908500d5f99f35afc5ed510391b9bdc3833farbb </example>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <example><title>Example (similar to the 2.2.x format)</title>
952908500d5f99f35afc5ed510391b9bdc3833farbb ErrorLogFormat "[%t] [%l] %7F: %E: [client\ %a]
952908500d5f99f35afc5ed510391b9bdc3833farbb %M%&nbsp;,\&nbsp;referer\&nbsp;%{Referer}i"
952908500d5f99f35afc5ed510391b9bdc3833farbb </example>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <example><title>Advanced example with request/connection log IDs</title>
952908500d5f99f35afc5ed510391b9bdc3833farbb ErrorLogFormat "[%{uc}t] [%-m:%-l] [R:%L] [C:%{C}L] %7F: %E: %M"<br/>
952908500d5f99f35afc5ed510391b9bdc3833farbb ErrorLogFormat request "[%{uc}t] [R:%L] Request %k on C:%{c}L pid:%P tid:%T"<br/>
952908500d5f99f35afc5ed510391b9bdc3833farbb ErrorLogFormat request "[%{uc}t] [R:%L] UA:'%+{User-Agent}i'"<br/>
952908500d5f99f35afc5ed510391b9bdc3833farbb ErrorLogFormat request "[%{uc}t] [R:%L] Referer:'%+{Referer}i'"<br/>
60262a02cfeba50d60d990b56d0e0c1d1fafb672sctemme ErrorLogFormat connection "[%{uc}t] [C:%{c}L] local\ %a remote\ %A"<br/>
60262a02cfeba50d60d990b56d0e0c1d1fafb672sctemme </example>
60262a02cfeba50d60d990b56d0e0c1d1fafb672sctemme
2d2eda71267231c2526be701fe655db125852c1ffielding</usage>
2d2eda71267231c2526be701fe655db125852c1ffielding<seealso><directive module="core">ErrorLog</directive></seealso>
e6cc28a5eb3371ba0c38e941855e71ff0054f50erbb<seealso><directive module="core">LogLevel</directive></seealso>
2f1bb5376c5c4022383bb729679ca751dd75a2eabrianp<seealso><a href="/logs.html">Apache HTTP Server Log Files</a></seealso>
2f1bb5376c5c4022383bb729679ca751dd75a2eabrianp</directivesynopsis>
2f1bb5376c5c4022383bb729679ca751dd75a2eabrianp
e6cc28a5eb3371ba0c38e941855e71ff0054f50erbb<directivesynopsis>
e6cc28a5eb3371ba0c38e941855e71ff0054f50erbb<name>ExtendedStatus</name>
e6cc28a5eb3371ba0c38e941855e71ff0054f50erbb<description>Keep track of extended status information for each
e6cc28a5eb3371ba0c38e941855e71ff0054f50erbbrequest</description>
470147d3f2750bfd47b5d8f1d90abab283eaad0dpquerna<syntax>ExtendedStatus On|Off</syntax>
e6cc28a5eb3371ba0c38e941855e71ff0054f50erbb<default>ExtendedStatus Off[*]</default>
4fbb89a070c82e489830233bde6bc78ddf179978stoddard<contextlist><context>server config</context></contextlist>
4fbb89a070c82e489830233bde6bc78ddf179978stoddard
4fbb89a070c82e489830233bde6bc78ddf179978stoddard<usage>
4fbb89a070c82e489830233bde6bc78ddf179978stoddard <p>This option tracks additional data per worker about the
4fbb89a070c82e489830233bde6bc78ddf179978stoddard currently executing request, and a utilization summary; you
4fbb89a070c82e489830233bde6bc78ddf179978stoddard can see these variables during runtime by configuring
4fbb89a070c82e489830233bde6bc78ddf179978stoddard <module>mod_status</module>. Note that other modules may
4fbb89a070c82e489830233bde6bc78ddf179978stoddard rely on this scoreboard.</p>
4fbb89a070c82e489830233bde6bc78ddf179978stoddard
4fbb89a070c82e489830233bde6bc78ddf179978stoddard <p>This setting applies to the entire server, and cannot be
4fbb89a070c82e489830233bde6bc78ddf179978stoddard enabled or disabled on a virtualhost-by-virtualhost basis.
e6cc28a5eb3371ba0c38e941855e71ff0054f50erbb The collection of extended status information can slow down
952908500d5f99f35afc5ed510391b9bdc3833farbb the server. Also note that this setting cannot be changed
952908500d5f99f35afc5ed510391b9bdc3833farbb during a graceful restart.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <note>
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>Note that loading <module>mod_status</module> will change
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben the default behavior to ExtendedStatus On, while other
952908500d5f99f35afc5ed510391b9bdc3833farbb third party modules may do the same. Such modules rely on
3d96ee83babeec32482c9082c9426340cee8c44dwrowe collecting detailed information about the state of all workers.
952908500d5f99f35afc5ed510391b9bdc3833farbb The default is changed by <module>mod_status</module> beginning
952908500d5f99f35afc5ed510391b9bdc3833farbb with version 2.3.6; the previous default was always Off.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb </note>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben
952908500d5f99f35afc5ed510391b9bdc3833farbb</usage>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb</directivesynopsis>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb<directivesynopsis>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe<name>FileETag</name>
2d2eda71267231c2526be701fe655db125852c1ffielding<description>File attributes used to create the ETag
2d2eda71267231c2526be701fe655db125852c1ffieldingHTTP response header for static files</description>
2d2eda71267231c2526be701fe655db125852c1ffielding<syntax>FileETag <var>component</var> ...</syntax>
2d2eda71267231c2526be701fe655db125852c1ffielding<default>FileETag INode MTime Size</default>
2d2eda71267231c2526be701fe655db125852c1ffielding<contextlist><context>server config</context><context>virtual host</context>
952908500d5f99f35afc5ed510391b9bdc3833farbb<context>directory</context><context>.htaccess</context>
952908500d5f99f35afc5ed510391b9bdc3833farbb</contextlist>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<override>FileInfo</override>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb<usage>
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>
952908500d5f99f35afc5ed510391b9bdc3833farbb The <directive>FileETag</directive> directive configures the file
3d96ee83babeec32482c9082c9426340cee8c44dwrowe attributes that are used to create the <code>ETag</code> (entity
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh tag) response header field when the document is based on a static file.
952908500d5f99f35afc5ed510391b9bdc3833farbb (The <code>ETag</code> value is used in cache management to save
952908500d5f99f35afc5ed510391b9bdc3833farbb network bandwidth.) The
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <directive>FileETag</directive> directive allows you to choose
952908500d5f99f35afc5ed510391b9bdc3833farbb which of these -- if any -- should be used. The recognized keywords are:
952908500d5f99f35afc5ed510391b9bdc3833farbb </p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <dl>
952908500d5f99f35afc5ed510391b9bdc3833farbb <dt><strong>INode</strong></dt>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe <dd>The file's i-node number will be included in the calculation</dd>
952908500d5f99f35afc5ed510391b9bdc3833farbb <dt><strong>MTime</strong></dt>
952908500d5f99f35afc5ed510391b9bdc3833farbb <dd>The date and time the file was last modified will be included</dd>
952908500d5f99f35afc5ed510391b9bdc3833farbb <dt><strong>Size</strong></dt>
952908500d5f99f35afc5ed510391b9bdc3833farbb <dd>The number of bytes in the file will be included</dd>
952908500d5f99f35afc5ed510391b9bdc3833farbb <dt><strong>All</strong></dt>
952908500d5f99f35afc5ed510391b9bdc3833farbb <dd>All available fields will be used. This is equivalent to:
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <example>FileETag INode MTime Size</example></dd>
952908500d5f99f35afc5ed510391b9bdc3833farbb <dt><strong>None</strong></dt>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe <dd>If a document is file-based, no <code>ETag</code> field will be
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh included in the response</dd>
952908500d5f99f35afc5ed510391b9bdc3833farbb </dl>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>The <code>INode</code>, <code>MTime</code>, and <code>Size</code>
952908500d5f99f35afc5ed510391b9bdc3833farbb keywords may be prefixed with either <code>+</code> or <code>-</code>,
952908500d5f99f35afc5ed510391b9bdc3833farbb which allow changes to be made to the default setting inherited
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben from a broader scope. Any keyword appearing without such a prefix
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh immediately and completely cancels the inherited setting.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
3d96ee83babeec32482c9082c9426340cee8c44dwrowe <p>If a directory's configuration includes
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>FileETag&nbsp;INode&nbsp;MTime&nbsp;Size</code>, and a
952908500d5f99f35afc5ed510391b9bdc3833farbb subdirectory's includes <code>FileETag&nbsp;-INode</code>,
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh the setting for that subdirectory (which will be inherited by
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben any sub-subdirectories that don't override it) will be equivalent to
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>FileETag&nbsp;MTime&nbsp;Size</code>.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb <note type="warning"><title>Warning</title>
952908500d5f99f35afc5ed510391b9bdc3833farbb Do not change the default for directories or locations that have WebDAV
952908500d5f99f35afc5ed510391b9bdc3833farbb enabled and use <module>mod_dav_fs</module> as a storage provider.
952908500d5f99f35afc5ed510391b9bdc3833farbb <module>mod_dav_fs</module> uses <code>INode&nbsp;MTime&nbsp;Size</code>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben as a fixed format for <code>ETag</code> comparisons on conditional requests.
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben These conditional requests will break if the <code>ETag</code> format is
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh changed via <directive>FileETag</directive>.
952908500d5f99f35afc5ed510391b9bdc3833farbb </note>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <note><title>Server Side Includes</title>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben An ETag is not generated for responses parsed by <module>mod_include</module>,
952908500d5f99f35afc5ed510391b9bdc3833farbb since the response entity can change without a change of the INode, MTime, or Size
952908500d5f99f35afc5ed510391b9bdc3833farbb of the static file with embedded SSI directives.
952908500d5f99f35afc5ed510391b9bdc3833farbb </note>
952908500d5f99f35afc5ed510391b9bdc3833farbb
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben</usage>
952908500d5f99f35afc5ed510391b9bdc3833farbb</directivesynopsis>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe
952908500d5f99f35afc5ed510391b9bdc3833farbb<directivesynopsis type="section">
952908500d5f99f35afc5ed510391b9bdc3833farbb<name>Files</name>
952908500d5f99f35afc5ed510391b9bdc3833farbb<description>Contains directives that apply to matched
759f4a24d09e28c4eaca9f97311b497fc15cb5c7benfilenames</description>
952908500d5f99f35afc5ed510391b9bdc3833farbb<syntax>&lt;Files <var>filename</var>&gt; ... &lt;/Files&gt;</syntax>
952908500d5f99f35afc5ed510391b9bdc3833farbb<contextlist><context>server config</context><context>virtual host</context>
952908500d5f99f35afc5ed510391b9bdc3833farbb<context>directory</context><context>.htaccess</context>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe</contextlist>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<override>All</override>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb<usage>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <p>The <directive type="section">Files</directive> directive
952908500d5f99f35afc5ed510391b9bdc3833farbb limits the scope of the enclosed directives by filename. It is comparable
952908500d5f99f35afc5ed510391b9bdc3833farbb to the <directive module="core" type="section">Directory</directive>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben and <directive module="core" type="section">Location</directive>
952908500d5f99f35afc5ed510391b9bdc3833farbb directives. It should be matched with a <code>&lt;/Files&gt;</code>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe directive. The directives given within this section will be applied to
952908500d5f99f35afc5ed510391b9bdc3833farbb any object with a basename (last component of filename) matching the
952908500d5f99f35afc5ed510391b9bdc3833farbb specified filename. <directive type="section">Files</directive>
952908500d5f99f35afc5ed510391b9bdc3833farbb sections are processed in the order they appear in the
952908500d5f99f35afc5ed510391b9bdc3833farbb configuration file, after the <directive module="core"
952908500d5f99f35afc5ed510391b9bdc3833farbb type="section">Directory</directive> sections and
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>.htaccess</code> files are read, but before <directive
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben type="section" module="core">Location</directive> sections. Note
952908500d5f99f35afc5ed510391b9bdc3833farbb that <directive type="section">Files</directive> can be nested
952908500d5f99f35afc5ed510391b9bdc3833farbb inside <directive type="section"
952908500d5f99f35afc5ed510391b9bdc3833farbb module="core">Directory</directive> sections to restrict the
3d96ee83babeec32482c9082c9426340cee8c44dwrowe portion of the filesystem they apply to.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>The <var>filename</var> argument should include a filename, or
952908500d5f99f35afc5ed510391b9bdc3833farbb a wild-card string, where <code>?</code> matches any single character,
952908500d5f99f35afc5ed510391b9bdc3833farbb and <code>*</code> matches any sequences of characters.
952908500d5f99f35afc5ed510391b9bdc3833farbb <glossary ref="regex">Regular expressions</glossary>
952908500d5f99f35afc5ed510391b9bdc3833farbb can also be used, with the addition of the
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>~</code> character. For example:</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <example>
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;Files ~ "\.(gif|jpe?g|png)$"&gt;
aecb17a45c6d3ee4729ed5f68dc4270f211ee7a8fielding </example>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>would match most common Internet graphics formats. <directive
952908500d5f99f35afc5ed510391b9bdc3833farbb module="core" type="section">FilesMatch</directive> is preferred,
952908500d5f99f35afc5ed510391b9bdc3833farbb however.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <p>Note that unlike <directive type="section"
952908500d5f99f35afc5ed510391b9bdc3833farbb module="core">Directory</directive> and <directive type="section"
952908500d5f99f35afc5ed510391b9bdc3833farbb module="core">Location</directive> sections, <directive
952908500d5f99f35afc5ed510391b9bdc3833farbb type="section">Files</directive> sections can be used inside
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>.htaccess</code> files. This allows users to control access to
952908500d5f99f35afc5ed510391b9bdc3833farbb their own files, at a file-by-file level.</p>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe
952908500d5f99f35afc5ed510391b9bdc3833farbb</usage>
952908500d5f99f35afc5ed510391b9bdc3833farbb<seealso><a href="/sections.html">How &lt;Directory&gt;, &lt;Location&gt;
952908500d5f99f35afc5ed510391b9bdc3833farbb and &lt;Files&gt; sections work</a> for an explanation of how these
952908500d5f99f35afc5ed510391b9bdc3833farbb different sections are combined when a request is received</seealso>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben</directivesynopsis>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb<directivesynopsis type="section">
952908500d5f99f35afc5ed510391b9bdc3833farbb<name>FilesMatch</name>
952908500d5f99f35afc5ed510391b9bdc3833farbb<description>Contains directives that apply to regular-expression matched
3d96ee83babeec32482c9082c9426340cee8c44dwrowefilenames</description>
2d2eda71267231c2526be701fe655db125852c1ffielding<syntax>&lt;FilesMatch <var>regex</var>&gt; ... &lt;/FilesMatch&gt;</syntax>
952908500d5f99f35afc5ed510391b9bdc3833farbb<contextlist><context>server config</context><context>virtual host</context>
971ced4989415d939afba8d70c82a9ce0113bceend<context>directory</context><context>.htaccess</context>
952908500d5f99f35afc5ed510391b9bdc3833farbb</contextlist>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<override>All</override>
952908500d5f99f35afc5ed510391b9bdc3833farbb
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<usage>
971ced4989415d939afba8d70c82a9ce0113bceend <p>The <directive type="section">FilesMatch</directive> directive
952908500d5f99f35afc5ed510391b9bdc3833farbb limits the scope of the enclosed directives by filename, just as the
971ced4989415d939afba8d70c82a9ce0113bceend <directive module="core" type="section">Files</directive> directive
952908500d5f99f35afc5ed510391b9bdc3833farbb does. However, it accepts a <glossary ref="regex">regular
3d96ee83babeec32482c9082c9426340cee8c44dwrowe expression</glossary>. For example:</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <example>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben &lt;FilesMatch "\.(gif|jpe?g|png)$"&gt;
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben </example>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>would match most common Internet graphics formats.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb</usage>
952908500d5f99f35afc5ed510391b9bdc3833farbb
3d96ee83babeec32482c9082c9426340cee8c44dwrowe<seealso><a href="/sections.html">How &lt;Directory&gt;, &lt;Location&gt;
952908500d5f99f35afc5ed510391b9bdc3833farbb and &lt;Files&gt; sections work</a> for an explanation of how these
952908500d5f99f35afc5ed510391b9bdc3833farbb different sections are combined when a request is received</seealso>
952908500d5f99f35afc5ed510391b9bdc3833farbb</directivesynopsis>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben
952908500d5f99f35afc5ed510391b9bdc3833farbb<directivesynopsis>
952908500d5f99f35afc5ed510391b9bdc3833farbb<name>ForceType</name>
952908500d5f99f35afc5ed510391b9bdc3833farbb<description>Forces all matching files to be served with the specified
952908500d5f99f35afc5ed510391b9bdc3833farbbmedia type in the HTTP Content-Type header field</description>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe<syntax>ForceType <var>media-type</var>|None</syntax>
2d2eda71267231c2526be701fe655db125852c1ffielding<contextlist><context>directory</context><context>.htaccess</context>
952908500d5f99f35afc5ed510391b9bdc3833farbb</contextlist>
952908500d5f99f35afc5ed510391b9bdc3833farbb<override>FileInfo</override>
952908500d5f99f35afc5ed510391b9bdc3833farbb<compatibility>Moved to the core in Apache httpd 2.0</compatibility>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb<usage>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe <p>When placed into an <code>.htaccess</code> file or a
952908500d5f99f35afc5ed510391b9bdc3833farbb <directive type="section" module="core">Directory</directive>, or
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin <directive type="section" module="core">Location</directive> or
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin <directive type="section" module="core">Files</directive>
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin section, this directive forces all matching files to be served
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin with the content type identification given by
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin <var>media-type</var>. For example, if you had a directory full of
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin GIF files, but did not want to label them all with <code>.gif</code>,
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin you might want to use:</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <example>
8419e6f8bff1a3617933f3ba760d2bdec7442f44coar ForceType image/gif
952908500d5f99f35afc5ed510391b9bdc3833farbb </example>
952908500d5f99f35afc5ed510391b9bdc3833farbb
3d96ee83babeec32482c9082c9426340cee8c44dwrowe <p>Note that this directive overrides other indirect media type
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh associations defined in mime.types or via the
8419e6f8bff1a3617933f3ba760d2bdec7442f44coar <directive module="mod_mime">AddType</directive>.</p>
8419e6f8bff1a3617933f3ba760d2bdec7442f44coar
8419e6f8bff1a3617933f3ba760d2bdec7442f44coar <p>You can also override more general
8419e6f8bff1a3617933f3ba760d2bdec7442f44coar <directive>ForceType</directive> settings
8419e6f8bff1a3617933f3ba760d2bdec7442f44coar by using the value of <code>None</code>:</p>
8419e6f8bff1a3617933f3ba760d2bdec7442f44coar
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <example>
952908500d5f99f35afc5ed510391b9bdc3833farbb # force all files to be image/gif:<br />
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben &lt;Location /images&gt;<br />
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <indent>
952908500d5f99f35afc5ed510391b9bdc3833farbb ForceType image/gif<br />
3d96ee83babeec32482c9082c9426340cee8c44dwrowe </indent>
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;/Location&gt;<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb <br />
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben # but normal mime-type associations here:<br />
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben &lt;Location /images/mixed&gt;<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb <indent>
952908500d5f99f35afc5ed510391b9bdc3833farbb ForceType None<br />
3d96ee83babeec32482c9082c9426340cee8c44dwrowe </indent>
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;/Location&gt;
952908500d5f99f35afc5ed510391b9bdc3833farbb </example>
952908500d5f99f35afc5ed510391b9bdc3833farbb
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <p>This directive primarily overrides the content types generated for
952908500d5f99f35afc5ed510391b9bdc3833farbb static files served out of the filesystem. For resources other than
952908500d5f99f35afc5ed510391b9bdc3833farbb static files, where the generator of the response typically specifies
952908500d5f99f35afc5ed510391b9bdc3833farbb a Content-Type, this directive has no effect.</p>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh</usage>
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin</directivesynopsis>
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin<directivesynopsis>
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin<name>GprofDir</name>
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin<description>Directory to write gmon.out profiling data to. </description>
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin<syntax>GprofDir <var>/tmp/gprof/</var>|<var>/tmp/gprof/</var>%</syntax>
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin<contextlist><context>server config</context><context>virtual host</context>
a5f529db7a87e3ac2e3c67b4ae009c1c094235d9minfrin</contextlist>
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin
952908500d5f99f35afc5ed510391b9bdc3833farbb<usage>
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>When the server has been compiled with gprof profiling suppport,
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <directive>GprofDir</directive> causes <code>gmon.out</code> files to
952908500d5f99f35afc5ed510391b9bdc3833farbb be written to the specified directory when the process exits. If the
952908500d5f99f35afc5ed510391b9bdc3833farbb argument ends with a percent symbol ('%'), subdirectories are created
952908500d5f99f35afc5ed510391b9bdc3833farbb for each process id.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>This directive currently only works with the <module>prefork</module>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe MPM.</p>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh</usage>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh</directivesynopsis>
2d2eda71267231c2526be701fe655db125852c1ffielding
952908500d5f99f35afc5ed510391b9bdc3833farbb<directivesynopsis>
952908500d5f99f35afc5ed510391b9bdc3833farbb<name>HostnameLookups</name>
952908500d5f99f35afc5ed510391b9bdc3833farbb<description>Enables DNS lookups on client IP addresses</description>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<syntax>HostnameLookups On|Off|Double</syntax>
952908500d5f99f35afc5ed510391b9bdc3833farbb<default>HostnameLookups Off</default>
952908500d5f99f35afc5ed510391b9bdc3833farbb<contextlist><context>server config</context><context>virtual host</context>
952908500d5f99f35afc5ed510391b9bdc3833farbb<context>directory</context></contextlist>
8c3667cd1d0db08647793137c0d1aa7f6526bebfniq
8c3667cd1d0db08647793137c0d1aa7f6526bebfniq<usage>
8c3667cd1d0db08647793137c0d1aa7f6526bebfniq <p>This directive enables DNS lookups so that host names can be
8c3667cd1d0db08647793137c0d1aa7f6526bebfniq logged (and passed to CGIs/SSIs in <code>REMOTE_HOST</code>).
8c3667cd1d0db08647793137c0d1aa7f6526bebfniq The value <code>Double</code> refers to doing double-reverse
8c3667cd1d0db08647793137c0d1aa7f6526bebfniq DNS lookup. That is, after a reverse lookup is performed, a forward
8c3667cd1d0db08647793137c0d1aa7f6526bebfniq lookup is then performed on that result. At least one of the IP
8c3667cd1d0db08647793137c0d1aa7f6526bebfniq addresses in the forward lookup must match the original
8c3667cd1d0db08647793137c0d1aa7f6526bebfniq address. (In "tcpwrappers" terminology this is called
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>PARANOID</code>.)</p>
3de8d8649277a02f53aa4f06121420985e8eee08nd
3de8d8649277a02f53aa4f06121420985e8eee08nd <p>Regardless of the setting, when <module>mod_authz_host</module> is
3de8d8649277a02f53aa4f06121420985e8eee08nd used for controlling access by hostname, a double reverse lookup
82acfa3f57607ae78326104c420a317260554a47nd will be performed. This is necessary for security. Note that the
3de8d8649277a02f53aa4f06121420985e8eee08nd result of this double-reverse isn't generally available unless you
3de8d8649277a02f53aa4f06121420985e8eee08nd set <code>HostnameLookups Double</code>. For example, if only
3de8d8649277a02f53aa4f06121420985e8eee08nd <code>HostnameLookups On</code> and a request is made to an object
3de8d8649277a02f53aa4f06121420985e8eee08nd that is protected by hostname restrictions, regardless of whether
82acfa3f57607ae78326104c420a317260554a47nd the double-reverse fails or not, CGIs will still be passed the
82acfa3f57607ae78326104c420a317260554a47nd single-reverse result in <code>REMOTE_HOST</code>.</p>
82acfa3f57607ae78326104c420a317260554a47nd
82acfa3f57607ae78326104c420a317260554a47nd <p>The default is <code>Off</code> in order to save the network
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh traffic for those sites that don't truly need the reverse
82acfa3f57607ae78326104c420a317260554a47nd lookups done. It is also better for the end users because they
82acfa3f57607ae78326104c420a317260554a47nd don't have to suffer the extra latency that a lookup entails.
82acfa3f57607ae78326104c420a317260554a47nd Heavily loaded sites should leave this directive
82acfa3f57607ae78326104c420a317260554a47nd <code>Off</code>, since DNS lookups can take considerable
82acfa3f57607ae78326104c420a317260554a47nd amounts of time. The utility <program>logresolve</program>, compiled by
952908500d5f99f35afc5ed510391b9bdc3833farbb default to the <code>bin</code> subdirectory of your installation
952908500d5f99f35afc5ed510391b9bdc3833farbb directory, can be used to look up host names from logged IP addresses
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben offline.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb</usage>
952908500d5f99f35afc5ed510391b9bdc3833farbb</directivesynopsis>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb<directivesynopsis type="section">
952908500d5f99f35afc5ed510391b9bdc3833farbb<name>If</name>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe<description>Contains directives that apply only if a condition is
dad234382d8424e1c5a30af2838e172aec9d6d1bdreidsatisfied by a request at runtime</description>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<syntax>&lt;If <var>expression</var>&gt; ... &lt;/If&gt;</syntax>
952908500d5f99f35afc5ed510391b9bdc3833farbb<contextlist><context>server config</context><context>virtual host</context>
952908500d5f99f35afc5ed510391b9bdc3833farbb<context>directory</context><context>.htaccess</context>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben</contextlist>
952908500d5f99f35afc5ed510391b9bdc3833farbb<override>All</override>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben
952908500d5f99f35afc5ed510391b9bdc3833farbb<usage>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe <p>The <directive type="section">If</directive> directive
2d2eda71267231c2526be701fe655db125852c1ffielding evaluates an expression at runtime, and applies the enclosed
952908500d5f99f35afc5ed510391b9bdc3833farbb directives if and only if the expression evaluates to true.
952908500d5f99f35afc5ed510391b9bdc3833farbb For example:</p>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben
952908500d5f99f35afc5ed510391b9bdc3833farbb <example>
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;If "$req{Host} = ''"&gt;
3d96ee83babeec32482c9082c9426340cee8c44dwrowe </example>
7c7372abe2484e7fcf81937b93496d1246e5b816gstein
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>would match HTTP/1.0 requests without a <var>Host:</var> header.</p>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <p>You may compare the value of any variable in the request headers
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben ($req), response headers ($resp) or environment ($env) in your
952908500d5f99f35afc5ed510391b9bdc3833farbb expression.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>Apart from <code>=</code>, <code>If</code> can use the <code>IN</code>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh operator to compare if the expression is in a given range:</p>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben
59ae852bea7d507f61999f982ded8219d2c0ec15wrowe <example>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben &lt;If %{REQUEST_METHOD} IN GET,HEAD,OPTIONS&gt;
3d96ee83babeec32482c9082c9426340cee8c44dwrowe </example>
7c7372abe2484e7fcf81937b93496d1246e5b816gstein
952908500d5f99f35afc5ed510391b9bdc3833farbb</usage>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<seealso><a href="/expr.html">Expressions in Apache HTTP Server</a>,
759f4a24d09e28c4eaca9f97311b497fc15cb5c7benfor a complete reference and more examples.</seealso>
952908500d5f99f35afc5ed510391b9bdc3833farbb<seealso><a href="/sections.html">How &lt;Directory&gt;, &lt;Location&gt;,
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;Files&gt; sections work</a> for an explanation of how these
952908500d5f99f35afc5ed510391b9bdc3833farbb different sections are combined when a request is received.
3d96ee83babeec32482c9082c9426340cee8c44dwrowe <directive type="section">If</directive> has the same precedence
58619148951981bcfa5c506ad8ce745aa8831980rbb and usage as <directive type="section">Files</directive></seealso>
58619148951981bcfa5c506ad8ce745aa8831980rbb</directivesynopsis>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben
58619148951981bcfa5c506ad8ce745aa8831980rbb<directivesynopsis type="section">
58619148951981bcfa5c506ad8ce745aa8831980rbb<name>IfDefine</name>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<description>Encloses directives that will be processed only
58619148951981bcfa5c506ad8ce745aa8831980rbbif a test is true at startup</description>
58619148951981bcfa5c506ad8ce745aa8831980rbb<syntax>&lt;IfDefine [!]<var>parameter-name</var>&gt; ...
58619148951981bcfa5c506ad8ce745aa8831980rbb &lt;/IfDefine&gt;</syntax>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<contextlist><context>server config</context><context>virtual host</context>
3d72602d1d9e6f0d49d20f0d0a71831c160ef589wrowe<context>directory</context><context>.htaccess</context>
3d72602d1d9e6f0d49d20f0d0a71831c160ef589wrowe</contextlist>
58619148951981bcfa5c506ad8ce745aa8831980rbb<override>All</override>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe
2d2eda71267231c2526be701fe655db125852c1ffielding<usage>
3d72602d1d9e6f0d49d20f0d0a71831c160ef589wrowe <p>The <code>&lt;IfDefine <var>test</var>&gt;...&lt;/IfDefine&gt;
3d72602d1d9e6f0d49d20f0d0a71831c160ef589wrowe </code> section is used to mark directives that are conditional. The
3d72602d1d9e6f0d49d20f0d0a71831c160ef589wrowe directives within an <directive type="section">IfDefine</directive>
3d72602d1d9e6f0d49d20f0d0a71831c160ef589wrowe section are only processed if the <var>test</var> is true. If <var>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh test</var> is false, everything between the start and end markers is
3d72602d1d9e6f0d49d20f0d0a71831c160ef589wrowe ignored.</p>
3d72602d1d9e6f0d49d20f0d0a71831c160ef589wrowe
3d72602d1d9e6f0d49d20f0d0a71831c160ef589wrowe <p>The <var>test</var> in the <directive type="section"
3d72602d1d9e6f0d49d20f0d0a71831c160ef589wrowe >IfDefine</directive> section directive can be one of two forms:</p>
3d72602d1d9e6f0d49d20f0d0a71831c160ef589wrowe
58619148951981bcfa5c506ad8ce745aa8831980rbb <ul>
58619148951981bcfa5c506ad8ce745aa8831980rbb <li><var>parameter-name</var></li>
58619148951981bcfa5c506ad8ce745aa8831980rbb
58619148951981bcfa5c506ad8ce745aa8831980rbb <li><code>!</code><var>parameter-name</var></li>
58619148951981bcfa5c506ad8ce745aa8831980rbb </ul>
58619148951981bcfa5c506ad8ce745aa8831980rbb
58619148951981bcfa5c506ad8ce745aa8831980rbb <p>In the former case, the directives between the start and end
3d96ee83babeec32482c9082c9426340cee8c44dwrowe markers are only processed if the parameter named
58619148951981bcfa5c506ad8ce745aa8831980rbb <var>parameter-name</var> is defined. The second format reverses
58619148951981bcfa5c506ad8ce745aa8831980rbb the test, and only processes the directives if
58619148951981bcfa5c506ad8ce745aa8831980rbb <var>parameter-name</var> is <strong>not</strong> defined.</p>
58619148951981bcfa5c506ad8ce745aa8831980rbb
92d6e181c597b97647d750c43a7bc3626e056b59gstein <p>The <var>parameter-name</var> argument is a define as given on the
58619148951981bcfa5c506ad8ce745aa8831980rbb <program>httpd</program> command line via <code>-D<var>parameter</var>
58619148951981bcfa5c506ad8ce745aa8831980rbb </code> at the time the server was started or by the <directive
92d6e181c597b97647d750c43a7bc3626e056b59gstein module="core">Define</directive> directive.</p>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
58619148951981bcfa5c506ad8ce745aa8831980rbb <p><directive type="section">IfDefine</directive> sections are
58619148951981bcfa5c506ad8ce745aa8831980rbb nest-able, which can be used to implement simple
58619148951981bcfa5c506ad8ce745aa8831980rbb multiple-parameter tests. Example:</p>
58619148951981bcfa5c506ad8ce745aa8831980rbb
92d6e181c597b97647d750c43a7bc3626e056b59gstein <example>
58619148951981bcfa5c506ad8ce745aa8831980rbb httpd -DReverseProxy -DUseCache -DMemCache ...<br />
58619148951981bcfa5c506ad8ce745aa8831980rbb <br />
92d6e181c597b97647d750c43a7bc3626e056b59gstein # httpd.conf<br />
58619148951981bcfa5c506ad8ce745aa8831980rbb &lt;IfDefine ReverseProxy&gt;<br />
58619148951981bcfa5c506ad8ce745aa8831980rbb <indent>
58619148951981bcfa5c506ad8ce745aa8831980rbb LoadModule proxy_module modules/mod_proxy.so<br />
58619148951981bcfa5c506ad8ce745aa8831980rbb LoadModule proxy_http_module modules/mod_proxy_http.so<br />
58619148951981bcfa5c506ad8ce745aa8831980rbb &lt;IfDefine UseCache&gt;<br />
58619148951981bcfa5c506ad8ce745aa8831980rbb <indent>
3e0494829cf6e8ac61e80fd82b1133111a52614cbrianp LoadModule cache_module modules/mod_cache.so<br />
58619148951981bcfa5c506ad8ce745aa8831980rbb &lt;IfDefine MemCache&gt;<br />
3d96ee83babeec32482c9082c9426340cee8c44dwrowe <indent>
58619148951981bcfa5c506ad8ce745aa8831980rbb LoadModule mem_cache_module modules/mod_mem_cache.so<br />
30c095035b1d5910cc239a1384c816aef228beb5jim </indent>
30c095035b1d5910cc239a1384c816aef228beb5jim &lt;/IfDefine&gt;<br />
30c095035b1d5910cc239a1384c816aef228beb5jim &lt;IfDefine !MemCache&gt;<br />
30c095035b1d5910cc239a1384c816aef228beb5jim <indent>
30c095035b1d5910cc239a1384c816aef228beb5jim LoadModule cache_disk_module modules/mod_cache_disk.so<br />
30c095035b1d5910cc239a1384c816aef228beb5jim </indent>
bdadc326446cae4a51bf75811fbe01a3a362df64gstein &lt;/IfDefine&gt;
bdadc326446cae4a51bf75811fbe01a3a362df64gstein </indent>
30c095035b1d5910cc239a1384c816aef228beb5jim &lt;/IfDefine&gt;
58619148951981bcfa5c506ad8ce745aa8831980rbb </indent>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben &lt;/IfDefine&gt;
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben </example>
58619148951981bcfa5c506ad8ce745aa8831980rbb</usage>
58619148951981bcfa5c506ad8ce745aa8831980rbb</directivesynopsis>
58619148951981bcfa5c506ad8ce745aa8831980rbb
3d96ee83babeec32482c9082c9426340cee8c44dwrowe<directivesynopsis type="section">
58619148951981bcfa5c506ad8ce745aa8831980rbb<name>IfModule</name>
58619148951981bcfa5c506ad8ce745aa8831980rbb<description>Encloses directives that are processed conditional on the
759f4a24d09e28c4eaca9f97311b497fc15cb5c7benpresence or absence of a specific module</description>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<syntax>&lt;IfModule [!]<var>module-file</var>|<var>module-identifier</var>&gt; ...
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh &lt;/IfModule&gt;</syntax>
58619148951981bcfa5c506ad8ce745aa8831980rbb<contextlist><context>server config</context><context>virtual host</context>
58619148951981bcfa5c506ad8ce745aa8831980rbb<context>directory</context><context>.htaccess</context>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe</contextlist>
58619148951981bcfa5c506ad8ce745aa8831980rbb<override>All</override>
58619148951981bcfa5c506ad8ce745aa8831980rbb<compatibility>Module identifiers are available in version 2.1 and
58619148951981bcfa5c506ad8ce745aa8831980rbblater.</compatibility>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben
58619148951981bcfa5c506ad8ce745aa8831980rbb<usage>
58619148951981bcfa5c506ad8ce745aa8831980rbb <p>The <code>&lt;IfModule <var>test</var>&gt;...&lt;/IfModule&gt;</code>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh section is used to mark directives that are conditional on the presence of
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh a specific module. The directives within an <directive type="section"
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh >IfModule</directive> section are only processed if the <var>test</var>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben is true. If <var>test</var> is false, everything between the start and
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh end markers is ignored.</p>
58619148951981bcfa5c506ad8ce745aa8831980rbb
58619148951981bcfa5c506ad8ce745aa8831980rbb <p>The <var>test</var> in the <directive type="section"
ef5650b61a8e35f3cc93ec07e73efc17ea329894jorton >IfModule</directive> section directive can be one of two forms:</p>
ef5650b61a8e35f3cc93ec07e73efc17ea329894jorton
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <ul>
58619148951981bcfa5c506ad8ce745aa8831980rbb <li><var>module</var></li>
58619148951981bcfa5c506ad8ce745aa8831980rbb
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <li>!<var>module</var></li>
58619148951981bcfa5c506ad8ce745aa8831980rbb </ul>
58619148951981bcfa5c506ad8ce745aa8831980rbb
ef5650b61a8e35f3cc93ec07e73efc17ea329894jorton <p>In the former case, the directives between the start and end
58619148951981bcfa5c506ad8ce745aa8831980rbb markers are only processed if the module named <var>module</var>
58619148951981bcfa5c506ad8ce745aa8831980rbb is included in Apache httpd -- either compiled in or
58619148951981bcfa5c506ad8ce745aa8831980rbb dynamically loaded using <directive module="mod_so"
58619148951981bcfa5c506ad8ce745aa8831980rbb >LoadModule</directive>. The second format reverses the test,
58619148951981bcfa5c506ad8ce745aa8831980rbb and only processes the directives if <var>module</var> is
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <strong>not</strong> included.</p>
58619148951981bcfa5c506ad8ce745aa8831980rbb
58619148951981bcfa5c506ad8ce745aa8831980rbb <p>The <var>module</var> argument can be either the module identifier or
58619148951981bcfa5c506ad8ce745aa8831980rbb the file name of the module, at the time it was compiled. For example,
58619148951981bcfa5c506ad8ce745aa8831980rbb <code>rewrite_module</code> is the identifier and
58619148951981bcfa5c506ad8ce745aa8831980rbb <code>mod_rewrite.c</code> is the file name. If a module consists of
58619148951981bcfa5c506ad8ce745aa8831980rbb several source files, use the name of the file containing the string
3d96ee83babeec32482c9082c9426340cee8c44dwrowe <code>STANDARD20_MODULE_STUFF</code>.</p>
ef5650b61a8e35f3cc93ec07e73efc17ea329894jorton
2d2eda71267231c2526be701fe655db125852c1ffielding <p><directive type="section">IfModule</directive> sections are
58619148951981bcfa5c506ad8ce745aa8831980rbb nest-able, which can be used to implement simple multiple-module
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben tests.</p>
58619148951981bcfa5c506ad8ce745aa8831980rbb
58619148951981bcfa5c506ad8ce745aa8831980rbb <note>This section should only be used if you need to have one
58619148951981bcfa5c506ad8ce745aa8831980rbb configuration file that works whether or not a specific module
3d96ee83babeec32482c9082c9426340cee8c44dwrowe is available. In normal operation, directives need not be
7c7372abe2484e7fcf81937b93496d1246e5b816gstein placed in <directive type="section">IfModule</directive>
58619148951981bcfa5c506ad8ce745aa8831980rbb sections.</note>
58619148951981bcfa5c506ad8ce745aa8831980rbb</usage>
58619148951981bcfa5c506ad8ce745aa8831980rbb</directivesynopsis>
58619148951981bcfa5c506ad8ce745aa8831980rbb
3d96ee83babeec32482c9082c9426340cee8c44dwrowe<directivesynopsis>
58619148951981bcfa5c506ad8ce745aa8831980rbb<name>Include</name>
58619148951981bcfa5c506ad8ce745aa8831980rbb<description>Includes other configuration files from within
58619148951981bcfa5c506ad8ce745aa8831980rbbthe server configuration files</description>
58619148951981bcfa5c506ad8ce745aa8831980rbb<syntax>Include [<var>optional</var>|<var>strict</var>] <var>file-path</var>|<var>directory-path</var>|<var>wildcard</var></syntax>
58619148951981bcfa5c506ad8ce745aa8831980rbb<contextlist><context>server config</context><context>virtual host</context>
58619148951981bcfa5c506ad8ce745aa8831980rbb<context>directory</context>
58619148951981bcfa5c506ad8ce745aa8831980rbb</contextlist>
58619148951981bcfa5c506ad8ce745aa8831980rbb<compatibility>Wildcard matching available in 2.0.41 and later, directory
aecb17a45c6d3ee4729ed5f68dc4270f211ee7a8fieldingwildcard matching available in 2.3.6 and later</compatibility>
58619148951981bcfa5c506ad8ce745aa8831980rbb
58619148951981bcfa5c506ad8ce745aa8831980rbb<usage>
58619148951981bcfa5c506ad8ce745aa8831980rbb <p>This directive allows inclusion of other configuration files
58619148951981bcfa5c506ad8ce745aa8831980rbb from within the server configuration files.</p>
58619148951981bcfa5c506ad8ce745aa8831980rbb
58619148951981bcfa5c506ad8ce745aa8831980rbb <p>Shell-style (<code>fnmatch()</code>) wildcard characters can be used
58619148951981bcfa5c506ad8ce745aa8831980rbb in the filename or directory parts of the path to include several files
58619148951981bcfa5c506ad8ce745aa8831980rbb at once, in alphabetical order. In addition, if
aecb17a45c6d3ee4729ed5f68dc4270f211ee7a8fielding <directive>Include</directive> points to a directory, rather than a file,
2d2eda71267231c2526be701fe655db125852c1ffielding Apache httpd will read all files in that directory and any subdirectory.
58619148951981bcfa5c506ad8ce745aa8831980rbb However, including entire directories is not recommended, because it is
58619148951981bcfa5c506ad8ce745aa8831980rbb easy to accidentally leave temporary files in a directory that can cause
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <program>httpd</program> to fail. Instead, we encourage you to use the
58619148951981bcfa5c506ad8ce745aa8831980rbb wildcard syntax shown below, to include files that match a particular
58619148951981bcfa5c506ad8ce745aa8831980rbb pattern, such as *.conf, for example.</p>
58619148951981bcfa5c506ad8ce745aa8831980rbb
3d96ee83babeec32482c9082c9426340cee8c44dwrowe <p>When a wildcard is specified for a <strong>file</strong> component of
2d2eda71267231c2526be701fe655db125852c1ffielding the path, and no file matches the wildcard, the
783334f576bfb7ef44623faf7af44a65cf13b9b4jim <directive module="core">Include</directive>
783334f576bfb7ef44623faf7af44a65cf13b9b4jim directive will be <strong>silently ignored</strong>. When a wildcard is
783334f576bfb7ef44623faf7af44a65cf13b9b4jim specified for a <strong>directory</strong> component of the path, and
783334f576bfb7ef44623faf7af44a65cf13b9b4jim no directory matches the wildcard, the
783334f576bfb7ef44623faf7af44a65cf13b9b4jim <directive module="core">Include</directive> directive will
783334f576bfb7ef44623faf7af44a65cf13b9b4jim <strong>fail with an error</strong> saying the directory cannot be found.
783334f576bfb7ef44623faf7af44a65cf13b9b4jim </p>
783334f576bfb7ef44623faf7af44a65cf13b9b4jim
783334f576bfb7ef44623faf7af44a65cf13b9b4jim <p>For further control over the behaviour of the server when no files or
783334f576bfb7ef44623faf7af44a65cf13b9b4jim directories match, prefix the path with the modifiers <var>optional</var>
783334f576bfb7ef44623faf7af44a65cf13b9b4jim or <var>strict</var>. If <var>optional</var> is specified, any wildcard
783334f576bfb7ef44623faf7af44a65cf13b9b4jim file or directory that does not match will be silently ignored. If
783334f576bfb7ef44623faf7af44a65cf13b9b4jim <var>strict</var> is specified, any wildcard file or directory that does
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem not match at least one file will cause server startup to fail.</p>
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem <p>When a directory or file component of the path is
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem specified exactly, and that directory or file does not exist,
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem <directive module="core">Include</directive> directive will fail with an
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem error saying the file or directory cannot be found.</p>
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem <p>The file path specified may be an absolute path, or may be relative
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem to the <directive module="core">ServerRoot</directive> directory.</p>
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem <p>Examples:</p>
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem <example>
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem Include /usr/local/apache2/conf/ssl.conf<br />
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem Include /usr/local/apache2/conf/vhosts/*.conf
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem </example>
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem <p>Or, providing paths relative to your <directive
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem module="core">ServerRoot</directive> directory:</p>
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem <example>
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem Include conf/ssl.conf<br />
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem Include conf/vhosts/*.conf
2d2eda71267231c2526be701fe655db125852c1ffielding </example>
58619148951981bcfa5c506ad8ce745aa8831980rbb
58619148951981bcfa5c506ad8ce745aa8831980rbb <p>Wildcards may be included in the directory or file portion of the
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben path. In the following example, the server will fail to load if no
58619148951981bcfa5c506ad8ce745aa8831980rbb directories match conf/vhosts/*, but will load successfully if no
58619148951981bcfa5c506ad8ce745aa8831980rbb files match *.conf.</p>
30c095035b1d5910cc239a1384c816aef228beb5jim
47ab8dcf8ad581569376f2e04ef16bc785bb122aake <example>
7c7372abe2484e7fcf81937b93496d1246e5b816gstein Include conf/vhosts/*/vhost.conf<br />
30c095035b1d5910cc239a1384c816aef228beb5jim Include conf/vhosts/*/*.conf
30c095035b1d5910cc239a1384c816aef228beb5jim </example>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben
30c095035b1d5910cc239a1384c816aef228beb5jim <p>In this example, the server will fail to load if either
30c095035b1d5910cc239a1384c816aef228beb5jim conf/vhosts/* matches no directories, or if *.conf matches no files:</p>
58619148951981bcfa5c506ad8ce745aa8831980rbb
47ab8dcf8ad581569376f2e04ef16bc785bb122aake <example>
2d2eda71267231c2526be701fe655db125852c1ffielding Include strict conf/vhosts/*/*.conf
2d2eda71267231c2526be701fe655db125852c1ffielding </example>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>In this example, the server load successfully if either conf/vhosts/*
2d2eda71267231c2526be701fe655db125852c1ffielding matches no directories, or if *.conf matches no files:</p>
58619148951981bcfa5c506ad8ce745aa8831980rbb
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <example>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben Include optional conf/vhosts/*/*.conf
58619148951981bcfa5c506ad8ce745aa8831980rbb </example>
c861a36fe9c9a78c4fcb97e29fc1099a5ea81173rbb
58619148951981bcfa5c506ad8ce745aa8831980rbb</usage>
2d2eda71267231c2526be701fe655db125852c1ffielding
58619148951981bcfa5c506ad8ce745aa8831980rbb<seealso><program>apachectl</program></seealso>
58619148951981bcfa5c506ad8ce745aa8831980rbb</directivesynopsis>
58619148951981bcfa5c506ad8ce745aa8831980rbb
58619148951981bcfa5c506ad8ce745aa8831980rbb<directivesynopsis>
58619148951981bcfa5c506ad8ce745aa8831980rbb<name>KeepAlive</name>
58619148951981bcfa5c506ad8ce745aa8831980rbb<description>Enables HTTP persistent connections</description>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe<syntax>KeepAlive On|Off</syntax>
2d2eda71267231c2526be701fe655db125852c1ffielding<default>KeepAlive On</default>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<contextlist><context>server config</context><context>virtual host</context>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh</contextlist>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<usage>
2d2eda71267231c2526be701fe655db125852c1ffielding <p>The Keep-Alive extension to HTTP/1.0 and the persistent
2d2eda71267231c2526be701fe655db125852c1ffielding connection feature of HTTP/1.1 provide long-lived HTTP sessions
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh which allow multiple requests to be sent over the same TCP
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh connection. In some cases this has been shown to result in an
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh almost 50% speedup in latency times for HTML documents with
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh many images. To enable Keep-Alive connections, set
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <code>KeepAlive On</code>.</p>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <p>For HTTP/1.0 clients, Keep-Alive connections will only be
0186cb43574836fc95a0506456210c94cfc3ea6ftrawick used if they are specifically requested by a client. In
6e70165f24ec2e664764a9402e358eb0f6e99a3dtrawick addition, a Keep-Alive connection with an HTTP/1.0 client can
0186cb43574836fc95a0506456210c94cfc3ea6ftrawick only be used when the length of the content is known in
6e70165f24ec2e664764a9402e358eb0f6e99a3dtrawick advance. This implies that dynamic content such as CGI output,
0186cb43574836fc95a0506456210c94cfc3ea6ftrawick SSI pages, and server-generated directory listings will
0186cb43574836fc95a0506456210c94cfc3ea6ftrawick generally not use Keep-Alive connections to HTTP/1.0 clients.
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh For HTTP/1.1 clients, persistent connections are the default
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh unless otherwise specified. If the client requests it, chunked
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh encoding will be used in order to send content of unknown
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh length over persistent connections.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>When a client uses a Keep-Alive connection it will be counted
2d2eda71267231c2526be701fe655db125852c1ffielding as a single "request" for the <directive module="mpm_common"
2d2eda71267231c2526be701fe655db125852c1ffielding >MaxConnectionsPerChild</directive> directive, regardless
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh of how many requests are sent using the connection.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding</usage>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
2d2eda71267231c2526be701fe655db125852c1ffielding<seealso><directive module="core">MaxKeepAliveRequests</directive></seealso>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh</directivesynopsis>
2d2eda71267231c2526be701fe655db125852c1ffielding
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<directivesynopsis>
2d2eda71267231c2526be701fe655db125852c1ffielding<name>KeepAliveTimeout</name>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<description>Amount of time the server will wait for subsequent
2d2eda71267231c2526be701fe655db125852c1ffieldingrequests on a persistent connection</description>
2d2eda71267231c2526be701fe655db125852c1ffielding<syntax>KeepAliveTimeout <var>num</var>[ms]</syntax>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<default>KeepAliveTimeout 5</default>
2d2eda71267231c2526be701fe655db125852c1ffielding<contextlist><context>server config</context><context>virtual host</context>
2d2eda71267231c2526be701fe655db125852c1ffielding</contextlist>
2d2eda71267231c2526be701fe655db125852c1ffielding<compatibility>Specifying a value in milliseconds is available in
2d2eda71267231c2526be701fe655db125852c1ffieldingApache httpd 2.3.2 and later</compatibility>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding<usage>
2d2eda71267231c2526be701fe655db125852c1ffielding <p>The number of seconds Apache httpd will wait for a subsequent
2d2eda71267231c2526be701fe655db125852c1ffielding request before closing the connection. By adding a postfix of ms the
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh timeout can be also set in milliseconds. Once a request has been
9f9307bbe539dbcf96919715315eb64ce3465f5bben received, the timeout value specified by the
9f9307bbe539dbcf96919715315eb64ce3465f5bben <directive module="core">Timeout</directive> directive applies.</p>
9f9307bbe539dbcf96919715315eb64ce3465f5bben
9f9307bbe539dbcf96919715315eb64ce3465f5bben <p>Setting <directive>KeepAliveTimeout</directive> to a high value
9f9307bbe539dbcf96919715315eb64ce3465f5bben may cause performance problems in heavily loaded servers. The
9f9307bbe539dbcf96919715315eb64ce3465f5bben higher the timeout, the more server processes will be kept
6a2bd1d848ec0984e2e675b8bb88cef8768d4a32bjh occupied waiting on connections with idle clients.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <p>In a name-based virtual host context, the value of the first
2d2eda71267231c2526be701fe655db125852c1ffielding defined virtual host (the default host) in a set of <directive
2d2eda71267231c2526be701fe655db125852c1ffielding module="core">NameVirtualHost</directive> will be used.
2d2eda71267231c2526be701fe655db125852c1ffielding The other values will be ignored.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding</usage>
2d2eda71267231c2526be701fe655db125852c1ffielding</directivesynopsis>
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben<directivesynopsis type="section">
9521cafc02c2caafc8f9594006994ed1f62540a4dreid<name>Limit</name>
18173b5033350759b5aa4f6d9a4fd9e12d440135trawick<description>Restrict enclosed access controls to only certain HTTP
18173b5033350759b5aa4f6d9a4fd9e12d440135trawickmethods</description>
18173b5033350759b5aa4f6d9a4fd9e12d440135trawick<syntax>&lt;Limit <var>method</var> [<var>method</var>] ... &gt; ...
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben &lt;/Limit&gt;</syntax>
18173b5033350759b5aa4f6d9a4fd9e12d440135trawick<contextlist><context>directory</context><context>.htaccess</context>
18173b5033350759b5aa4f6d9a4fd9e12d440135trawick</contextlist>
84ba82304285b4bb1aafd5c6cdada5ce74c29973striker<override>AuthConfig, Limit</override>
84ba82304285b4bb1aafd5c6cdada5ce74c29973striker
84ba82304285b4bb1aafd5c6cdada5ce74c29973striker<usage>
84ba82304285b4bb1aafd5c6cdada5ce74c29973striker <p>Access controls are normally effective for
84ba82304285b4bb1aafd5c6cdada5ce74c29973striker <strong>all</strong> access methods, and this is the usual
84ba82304285b4bb1aafd5c6cdada5ce74c29973striker desired behavior. <strong>In the general case, access control
84ba82304285b4bb1aafd5c6cdada5ce74c29973striker directives should not be placed within a
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben <directive type="section">Limit</directive> section.</strong></p>
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben
5f7c351eb2a69d8cef6c3e98e27ce6158a0b1780rbb <p>The purpose of the <directive type="section">Limit</directive>
66d349e02d1a5a599a01c977d2c5b0009181f7deben directive is to restrict the effect of the access controls to the
5f7c351eb2a69d8cef6c3e98e27ce6158a0b1780rbb nominated HTTP methods. For all other methods, the access
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben restrictions that are enclosed in the <directive
dca927eafb338b9de9d0214818136c16d436e3fdrbb type="section">Limit</directive> bracket <strong>will have no
dca927eafb338b9de9d0214818136c16d436e3fdrbb effect</strong>. The following example applies the access control
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben only to the methods <code>POST</code>, <code>PUT</code>, and
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben <code>DELETE</code>, leaving all other methods unprotected:</p>
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <example>
66d349e02d1a5a599a01c977d2c5b0009181f7deben &lt;Limit POST PUT DELETE&gt;<br />
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <indent>
66d349e02d1a5a599a01c977d2c5b0009181f7deben Require valid-user<br />
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh </indent>
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben &lt;/Limit&gt;
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh </example>
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <p>The method names listed can be one or more of: <code>GET</code>,
dca927eafb338b9de9d0214818136c16d436e3fdrbb <code>POST</code>, <code>PUT</code>, <code>DELETE</code>,
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <code>CONNECT</code>, <code>OPTIONS</code>,
dca927eafb338b9de9d0214818136c16d436e3fdrbb <code>PATCH</code>, <code>PROPFIND</code>, <code>PROPPATCH</code>,
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben <code>MKCOL</code>, <code>COPY</code>, <code>MOVE</code>,
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben <code>LOCK</code>, and <code>UNLOCK</code>. <strong>The method name is
0a09a4a642f7c0d367598394411dbdd4a6d8cd09fielding case-sensitive.</strong> If <code>GET</code> is used it will also
55d986c77300fd39420b41f765b08c15b4c6418drbb restrict <code>HEAD</code> requests. The <code>TRACE</code> method
55d986c77300fd39420b41f765b08c15b4c6418drbb cannot be limited (see <directive module="core"
2d2eda71267231c2526be701fe655db125852c1ffielding >TraceEnable</directive>).</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <note type="warning">A <directive type="section"
2d2eda71267231c2526be701fe655db125852c1ffielding module="core">LimitExcept</directive> section should always be
2d2eda71267231c2526be701fe655db125852c1ffielding used in preference to a <directive type="section">Limit</directive>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh section when restricting access, since a <directive type="section"
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh module="core">LimitExcept</directive> section provides protection
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh against arbitrary methods.</note>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <p>The <directive type="section">Limit</directive> and
<directive type="section" module="core">LimitExcept</directive>
directives may be nested. In this case, each successive level of
<directive type="section">Limit</directive> or <directive
type="section" module="core">LimitExcept</directive> directives must
further restrict the set of methods to which access controls apply.</p>
<note type="warning">When using
<directive type="section">Limit</directive> or
<directive type="section">LimitExcept</directive> directives with
the <directive module="mod_authz_core">Require</directive> directive,
note that the first <directive module="mod_authz_core">Require</directive>
to succeed authorizes the request, regardless of the presence of other
<directive module="mod_authz_core">Require</directive> directives.</note>
<p>For example, given the following configuration, all users will
be authorized for <code>POST</code> requests, and the
<code>Require group editors</code> directive will be ignored
in all cases:</p>
<example>
&lt;LimitExcept GET&gt;
<indent>
Require valid-user
</indent>
&lt;/LimitExcept&gt;<br />
&lt;Limit POST&gt;
<indent>
Require group editors
</indent>
&lt;/Limit&gt;
</example>
</usage>
</directivesynopsis>
<directivesynopsis type="section">
<name>LimitExcept</name>
<description>Restrict access controls to all HTTP methods
except the named ones</description>
<syntax>&lt;LimitExcept <var>method</var> [<var>method</var>] ... &gt; ...
&lt;/LimitExcept&gt;</syntax>
<contextlist><context>directory</context><context>.htaccess</context>
</contextlist>
<override>AuthConfig, Limit</override>
<usage>
<p><directive type="section">LimitExcept</directive> and
<code>&lt;/LimitExcept&gt;</code> are used to enclose
a group of access control directives which will then apply to any
HTTP access method <strong>not</strong> listed in the arguments;
i.e., it is the opposite of a <directive type="section"
module="core">Limit</directive> section and can be used to control
both standard and nonstandard/unrecognized methods. See the
documentation for <directive module="core"
type="section">Limit</directive> for more details.</p>
<p>For example:</p>
<example>
&lt;LimitExcept POST GET&gt;<br />
<indent>
Require valid-user<br />
</indent>
&lt;/LimitExcept&gt;
</example>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>LimitInternalRecursion</name>
<description>Determine maximum number of internal redirects and nested
subrequests</description>
<syntax>LimitInternalRecursion <var>number</var> [<var>number</var>]</syntax>
<default>LimitInternalRecursion 10</default>
<contextlist><context>server config</context><context>virtual host</context>
</contextlist>
<compatibility>Available in Apache httpd 2.0.47 and later</compatibility>
<usage>
<p>An internal redirect happens, for example, when using the <directive
module="mod_actions">Action</directive> directive, which internally
redirects the original request to a CGI script. A subrequest is Apache httpd's
mechanism to find out what would happen for some URI if it were requested.
For example, <module>mod_dir</module> uses subrequests to look for the
files listed in the <directive module="mod_dir">DirectoryIndex</directive>
directive.</p>
<p><directive>LimitInternalRecursion</directive> prevents the server
from crashing when entering an infinite loop of internal redirects or
subrequests. Such loops are usually caused by misconfigurations.</p>
<p>The directive stores two different limits, which are evaluated on
per-request basis. The first <var>number</var> is the maximum number of
internal redirects, that may follow each other. The second <var>number</var>
determines, how deep subrequests may be nested. If you specify only one
<var>number</var>, it will be assigned to both limits.</p>
<example><title>Example</title>
LimitInternalRecursion 5
</example>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>LimitRequestBody</name>
<description>Restricts the total size of the HTTP request body sent
from the client</description>
<syntax>LimitRequestBody <var>bytes</var></syntax>
<default>LimitRequestBody 0</default>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
<usage>
<p>This directive specifies the number of <var>bytes</var> from 0
(meaning unlimited) to 2147483647 (2GB) that are allowed in a
request body. See the note below for the limited applicability
to proxy requests.</p>
<p>The <directive>LimitRequestBody</directive> directive allows
the user to set a limit on the allowed size of an HTTP request
message body within the context in which the directive is given
(server, per-directory, per-file or per-location). If the client
request exceeds that limit, the server will return an error
response instead of servicing the request. The size of a normal
request message body will vary greatly depending on the nature of
the resource and the methods allowed on that resource. CGI scripts
typically use the message body for retrieving form information.
Implementations of the <code>PUT</code> method will require
a value at least as large as any representation that the server
wishes to accept for that resource.</p>
<p>This directive gives the server administrator greater
control over abnormal client request behavior, which may be
useful for avoiding some forms of denial-of-service
attacks.</p>
<p>If, for example, you are permitting file upload to a particular
location, and wish to limit the size of the uploaded file to 100K,
you might use the following directive:</p>
<example>
LimitRequestBody 102400
</example>
<note><p>For a full description of how this directive is interpreted by
proxy requests, see the <module>mod_proxy</module> documentation.</p>
</note>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>LimitRequestFields</name>
<description>Limits the number of HTTP request header fields that
will be accepted from the client</description>
<syntax>LimitRequestFields <var>number</var></syntax>
<default>LimitRequestFields 100</default>
<contextlist><context>server config</context><context>virtual host</context></contextlist>
<usage>
<p><var>Number</var> is an integer from 0 (meaning unlimited) to
32767. The default value is defined by the compile-time
constant <code>DEFAULT_LIMIT_REQUEST_FIELDS</code> (100 as
distributed).</p>
<p>The <directive>LimitRequestFields</directive> directive allows
the server administrator to modify the limit on the number of
request header fields allowed in an HTTP request. A server needs
this value to be larger than the number of fields that a normal
client request might include. The number of request header fields
used by a client rarely exceeds 20, but this may vary among
different client implementations, often depending upon the extent
to which a user has configured their browser to support detailed
content negotiation. Optional HTTP extensions are often expressed
using request header fields.</p>
<p>This directive gives the server administrator greater
control over abnormal client request behavior, which may be
useful for avoiding some forms of denial-of-service attacks.
The value should be increased if normal clients see an error
response from the server that indicates too many fields were
sent in the request.</p>
<p>For example:</p>
<example>
LimitRequestFields 50
</example>
<note type="warning"><title>Warning</title>
<p> When name-based virtual hosting is used, the value for this
directive is taken from the default (first-listed) virtual host for the
<directive>NameVirtualHost</directive> the connection was mapped to.</p>
</note>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>LimitRequestFieldSize</name>
<description>Limits the size of the HTTP request header allowed from the
client</description>
<syntax>LimitRequestFieldSize <var>bytes</var></syntax>
<default>LimitRequestFieldSize 8190</default>
<contextlist><context>server config</context><context>virtual host</context></contextlist>
<usage>
<p>This directive specifies the number of <var>bytes</var>
that will be allowed in an HTTP request header.</p>
<p>The <directive>LimitRequestFieldSize</directive> directive
allows the server administrator to reduce or increase the limit
on the allowed size of an HTTP request header field. A server
needs this value to be large enough to hold any one header field
from a normal client request. The size of a normal request header
field will vary greatly among different client implementations,
often depending upon the extent to which a user has configured
their browser to support detailed content negotiation. SPNEGO
authentication headers can be up to 12392 bytes.</p>
<p>This directive gives the server administrator greater
control over abnormal client request behavior, which may be
useful for avoiding some forms of denial-of-service attacks.</p>
<p>For example:</p>
<example>
LimitRequestFieldSize 4094
</example>
<note>Under normal conditions, the value should not be changed from
the default.</note>
<note type="warning"><title>Warning</title>
<p> When name-based virtual hosting is used, the value for this
directive is taken from the default (first-listed) virtual host for the
<directive>NameVirtualHost</directive> the connection was mapped to.</p>
</note>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>LimitRequestLine</name>
<description>Limit the size of the HTTP request line that will be accepted
from the client</description>
<syntax>LimitRequestLine <var>bytes</var></syntax>
<default>LimitRequestLine 8190</default>
<contextlist><context>server config</context><context>virtual host</context></contextlist>
<usage>
<p>This directive sets the number of <var>bytes</var> that will be
allowed on the HTTP request-line.</p>
<p>The <directive>LimitRequestLine</directive> directive allows
the server administrator to reduce or increase the limit on the allowed size
of a client's HTTP request-line. Since the request-line consists of the
HTTP method, URI, and protocol version, the
<directive>LimitRequestLine</directive> directive places a
restriction on the length of a request-URI allowed for a request
on the server. A server needs this value to be large enough to
hold any of its resource names, including any information that
might be passed in the query part of a <code>GET</code> request.</p>
<p>This directive gives the server administrator greater
control over abnormal client request behavior, which may be
useful for avoiding some forms of denial-of-service attacks.</p>
<p>For example:</p>
<example>
LimitRequestLine 4094
</example>
<note>Under normal conditions, the value should not be changed from
the default.</note>
<note type="warning"><title>Warning</title>
<p> When name-based virtual hosting is used, the value for this
directive is taken from the default (first-listed) virtual host for the
<directive>NameVirtualHost</directive> the connection was mapped to.</p>
</note>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>LimitXMLRequestBody</name>
<description>Limits the size of an XML-based request body</description>
<syntax>LimitXMLRequestBody <var>bytes</var></syntax>
<default>LimitXMLRequestBody 1000000</default>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context></contextlist>
<override>All</override>
<usage>
<p>Limit (in bytes) on maximum size of an XML-based request
body. A value of <code>0</code> will disable any checking.</p>
<p>Example:</p>
<example>
LimitXMLRequestBody 0
</example>
</usage>
</directivesynopsis>
<directivesynopsis type="section">
<name>Location</name>
<description>Applies the enclosed directives only to matching
URLs</description>
<syntax>&lt;Location
<var>URL-path</var>|<var>URL</var>&gt; ... &lt;/Location&gt;</syntax>
<contextlist><context>server config</context><context>virtual host</context>
</contextlist>
<usage>
<p>The <directive type="section">Location</directive> directive
limits the scope of the enclosed directives by URL. It is similar to the
<directive type="section" module="core">Directory</directive>
directive, and starts a subsection which is terminated with a
<code>&lt;/Location&gt;</code> directive. <directive
type="section">Location</directive> sections are processed in the
order they appear in the configuration file, after the <directive
type="section" module="core">Directory</directive> sections and
<code>.htaccess</code> files are read, and after the <directive
type="section" module="core">Files</directive> sections.</p>
<p><directive type="section">Location</directive> sections operate
completely outside the filesystem. This has several consequences.
Most importantly, <directive type="section">Location</directive>
directives should not be used to control access to filesystem
locations. Since several different URLs may map to the same
filesystem location, such access controls may by circumvented.</p>
<p>The enclosed directives will be applied to the request if the path component
of the URL meets <em>any</em> of the following criteria:
</p>
<ul>
<li>The specified location matches exactly the path component of the URL.
</li>
<li>The specified location, which ends in a forward slash, is a prefix
of the path component of the URL (treated as a context root).
</li>
<li>The specified location, with the addition of a trailing slash, is a
prefix of the path component of the URL (also treated as a context root).
</li>
</ul>
<p>
In the example below, where no trailing slash is used, requests to
/private1, /private1/ and /private1/file.txt will have the enclosed
directives applied, but /private1other would not.
</p>
<example>
&lt;Location /private1&gt;
...
</example>
<p>
In the example below, where a trailing slash is used, requests to
/private2/ and /private2/file.txt will have the enclosed
directives applied, but /private2 and /private2other would not.
</p>
<example>
&lt;Location /private2<em>/</em>&gt;
...
</example>
<note><title>When to use <directive
type="section">Location</directive></title>
<p>Use <directive type="section">Location</directive> to apply
directives to content that lives outside the filesystem. For
content that lives in the filesystem, use <directive
type="section" module="core">Directory</directive> and <directive
type="section" module="core">Files</directive>. An exception is
<code>&lt;Location /&gt;</code>, which is an easy way to
apply a configuration to the entire server.</p>
</note>
<p>For all origin (non-proxy) requests, the URL to be matched is a
URL-path of the form <code>/path/</code>. <em>No scheme, hostname,
port, or query string may be included.</em> For proxy requests, the
URL to be matched is of the form
<code>scheme://servername/path</code>, and you must include the
prefix.</p>
<p>The URL may use wildcards. In a wild-card string, <code>?</code> matches
any single character, and <code>*</code> matches any sequences of
characters. Neither wildcard character matches a / in the URL-path.</p>
<p><glossary ref="regex">Regular expressions</glossary>
can also be used, with the addition of the <code>~</code>
character. For example:</p>
<example>
&lt;Location ~ "/(extra|special)/data"&gt;
</example>
<p>would match URLs that contained the substring <code>/extra/data</code>
or <code>/special/data</code>. The directive <directive
type="section" module="core">LocationMatch</directive> behaves
identical to the regex version of <directive
type="section">Location</directive>, and is preferred, for the
simple reason that <code>~</code> is hard to distinguish from
<code>-</code> in many fonts.</p>
<p>The <directive type="section">Location</directive>
functionality is especially useful when combined with the
<directive module="core">SetHandler</directive>
directive. For example, to enable status requests, but allow them
only from browsers at <code>example.com</code>, you might use:</p>
<example>
&lt;Location /status&gt;<br />
<indent>
SetHandler server-status<br />
Require host example.com<br />
</indent>
&lt;/Location&gt;
</example>
<note><title>Note about / (slash)</title>
<p>The slash character has special meaning depending on where in a
URL it appears. People may be used to its behavior in the filesystem
where multiple adjacent slashes are frequently collapsed to a single
slash (<em>i.e.</em>, <code>/home///foo</code> is the same as
<code>/home/foo</code>). In URL-space this is not necessarily true.
The <directive type="section" module="core">LocationMatch</directive>
directive and the regex version of <directive type="section"
>Location</directive> require you to explicitly specify multiple
slashes if that is your intention.</p>
<p>For example, <code>&lt;LocationMatch ^/abc&gt;</code> would match
the request URL <code>/abc</code> but not the request URL <code>
//abc</code>. The (non-regex) <directive type="section"
>Location</directive> directive behaves similarly when used for
proxy requests. But when (non-regex) <directive type="section"
>Location</directive> is used for non-proxy requests it will
implicitly match multiple slashes with a single slash. For example,
if you specify <code>&lt;Location /abc/def&gt;</code> and the
request is to <code>/abc//def</code> then it will match.</p>
</note>
</usage>
<seealso><a href="/sections.html">How &lt;Directory&gt;, &lt;Location&gt;
and &lt;Files&gt; sections work</a> for an explanation of how these
different sections are combined when a request is received.</seealso>
<seealso><directive module="core">LocationMatch</directive></seealso>
</directivesynopsis>
<directivesynopsis type="section">
<name>LocationMatch</name>
<description>Applies the enclosed directives only to regular-expression
matching URLs</description>
<syntax>&lt;LocationMatch
<var>regex</var>&gt; ... &lt;/LocationMatch&gt;</syntax>
<contextlist><context>server config</context><context>virtual host</context>
</contextlist>
<usage>
<p>The <directive type="section">LocationMatch</directive> directive
limits the scope of the enclosed directives by URL, in an identical manner
to <directive module="core" type="section">Location</directive>. However,
it takes a <glossary ref="regex">regular expression</glossary>
as an argument instead of a simple string. For example:</p>
<example>
&lt;LocationMatch "/(extra|special)/data"&gt;
</example>
<p>would match URLs that contained the substring <code>/extra/data</code>
or <code>/special/data</code>.</p>
</usage>
<seealso><a href="/sections.html">How &lt;Directory&gt;, &lt;Location&gt;
and &lt;Files&gt; sections work</a> for an explanation of how these
different sections are combined when a request is received</seealso>
</directivesynopsis>
<directivesynopsis>
<name>LogLevel</name>
<description>Controls the verbosity of the ErrorLog</description>
<syntax>LogLevel [<var>module</var>:]<var>level</var>
[<var>module</var>:<var>level</var>] ...
</syntax>
<default>LogLevel warn</default>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context>
</contextlist>
<compatibility>Per-module and per-directory configuration is available in
Apache HTTP Server 2.3.6 and later</compatibility>
<usage>
<p><directive>LogLevel</directive> adjusts the verbosity of the
messages recorded in the error logs (see <directive
module="core">ErrorLog</directive> directive). The following
<var>level</var>s are available, in order of decreasing
significance:</p>
<table border="1">
<columnspec><column width=".2"/><column width=".3"/><column width=".5"/>
</columnspec>
<tr>
<th><strong>Level</strong> </th>
<th><strong>Description</strong> </th>
<th><strong>Example</strong> </th>
</tr>
<tr>
<td><code>emerg</code> </td>
<td>Emergencies - system is unusable.</td>
<td>"Child cannot open lock file. Exiting"</td>
</tr>
<tr>
<td><code>alert</code> </td>
<td>Action must be taken immediately.</td>
<td>"getpwuid: couldn't determine user name from uid"</td>
</tr>
<tr>
<td><code>crit</code> </td>
<td>Critical Conditions.</td>
<td>"socket: Failed to get a socket, exiting child"</td>
</tr>
<tr>
<td><code>error</code> </td>
<td>Error conditions.</td>
<td>"Premature end of script headers"</td>
</tr>
<tr>
<td><code>warn</code> </td>
<td>Warning conditions.</td>
<td>"child process 1234 did not exit, sending another
SIGHUP"</td>
</tr>
<tr>
<td><code>notice</code> </td>
<td>Normal but significant condition.</td>
<td>"httpd: caught SIGBUS, attempting to dump core in
..."</td>
</tr>
<tr>
<td><code>info</code> </td>
<td>Informational.</td>
<td>"Server seems busy, (you may need to increase
StartServers, or Min/MaxSpareServers)..."</td>
</tr>
<tr>
<td><code>debug</code> </td>
<td>Debug-level messages</td>
<td>"Opening config file ..."</td>
</tr>
<tr>
<td><code>trace1</code> </td>
<td>Trace messages</td>
<td>"proxy: FTP: control connection complete"</td>
</tr>
<tr>
<td><code>trace2</code> </td>
<td>Trace messages</td>
<td>"proxy: CONNECT: sending the CONNECT request to the remote proxy"</td>
</tr>
<tr>
<td><code>trace3</code> </td>
<td>Trace messages</td>
<td>"openssl: Handshake: start"</td>
</tr>
<tr>
<td><code>trace4</code> </td>
<td>Trace messages</td>
<td>"read from buffered SSL brigade, mode 0, 17 bytes"</td>
</tr>
<tr>
<td><code>trace5</code> </td>
<td>Trace messages</td>
<td>"map lookup FAILED: map=rewritemap key=keyname"</td>
</tr>
<tr>
<td><code>trace6</code> </td>
<td>Trace messages</td>
<td>"cache lookup FAILED, forcing new map lookup"</td>
</tr>
<tr>
<td><code>trace7</code> </td>
<td>Trace messages, dumping large amounts of data</td>
<td>"| 0000: 02 23 44 30 13 40 ac 34 df 3d bf 9a 19 49 39 15 |"</td>
</tr>
<tr>
<td><code>trace8</code> </td>
<td>Trace messages, dumping large amounts of data</td>
<td>"| 0000: 02 23 44 30 13 40 ac 34 df 3d bf 9a 19 49 39 15 |"</td>
</tr>
</table>
<p>When a particular level is specified, messages from all
other levels of higher significance will be reported as well.
<em>E.g.</em>, when <code>LogLevel info</code> is specified,
then messages with log levels of <code>notice</code> and
<code>warn</code> will also be posted.</p>
<p>Using a level of at least <code>crit</code> is
recommended.</p>
<p>For example:</p>
<example>
LogLevel notice
</example>
<note><title>Note</title>
<p>When logging to a regular file messages of the level
<code>notice</code> cannot be suppressed and thus are always
logged. However, this doesn't apply when logging is done
using <code>syslog</code>.</p>
</note>
<p>Specifying a level without a module name will reset the level
for all modules to that level. Specifying a level with a module
name will set the level for that module only. It is possible to
use the module source file name, the module identifier, or the
module identifier with the trailing <code>_module</code> omitted
as module specification. This means the following three specifications
are equivalent:</p>
<example>
LogLevel info ssl:warn<br />
LogLevel info mod_ssl.c:warn<br />
LogLevel info ssl_module:warn<br />
</example>
<p>It is also possible to change the level per directory:</p>
<example>
LogLevel info<br />
&lt;Directory /usr/local/apache/htdocs/app&gt;<br />
&nbsp; LogLevel debug<br />
&lt;/Files&gt;
</example>
<note>
Per directory loglevel configuration only affects messages that are
logged after the request has been parsed and that are associated with
the request. Log messages which are associated with the connection or
the server are not affected.
</note>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>MaxKeepAliveRequests</name>
<description>Number of requests allowed on a persistent
connection</description>
<syntax>MaxKeepAliveRequests <var>number</var></syntax>
<default>MaxKeepAliveRequests 100</default>
<contextlist><context>server config</context><context>virtual host</context>
</contextlist>
<usage>
<p>The <directive>MaxKeepAliveRequests</directive> directive
limits the number of requests allowed per connection when
<directive module="core" >KeepAlive</directive> is on. If it is
set to <code>0</code>, unlimited requests will be allowed. We
recommend that this setting be kept to a high value for maximum
server performance.</p>
<p>For example:</p>
<example>
MaxKeepAliveRequests 500
</example>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>Mutex</name>
<description>Configures mutex mechanism and lock file directory for all
or specified mutexes</description>
<syntax>Mutex <var>mechanism</var> [default|<var>mutex-name</var>] ... [OmitPID]</syntax>
<default>Mutex default</default>
<contextlist><context>server config</context></contextlist>
<compatibility>Available in Apache HTTP Server 2.3.4 and later</compatibility>
<usage>
<p>The <directive>Mutex</directive> directive sets the mechanism,
and optionally the lock file location, that httpd and modules use
to serialize access to resources. Specify <code>default</code> as
the first argument to change the settings for all mutexes; specify
a mutex name (see table below) as the first argument to override
defaults only for that mutex.</p>
<p>The <directive>Mutex</directive> directive is typically used in
the following exceptional situations:</p>
<ul>
<li>change the mutex mechanism when the default mechanism selected
by <glossary>APR</glossary> has a functional or performance
problem</li>
<li>change the directory used by file-based mutexes when the
default directory does not support locking</li>
</ul>
<note><title>Supported modules</title>
<p>This directive only configures mutexes which have been registered
with the core server using the <code>ap_mutex_register()</code> API.
All modules bundled with httpd support the <directive>Mutex</directive>
directive, but third-party modules may not. Consult the documentation
of the third-party module, which must indicate the mutex name(s) which
can be configured if this directive is supported.</p>
</note>
<p>The following mutex <em>mechanisms</em> are available:</p>
<ul>
<li><code>default | yes</code>
<p>This selects the default locking implementation, as determined by
<glossary>APR</glossary>. The default locking implementation can
be displayed by running <program>httpd</program> with the
<code>-V</code> option.</p></li>
<li><code>none | no</code>
<p>This effectively disables the mutex, and is only allowed for a
mutex if the module indicates that it is a valid choice. Consult the
module documentation for more information.</p></li>
<li><code>posixsem</code>
<p>This is a mutex variant based on a Posix semaphore.</p>
<note type="warning"><title>Warning</title>
<p>The semaphore ownership is not recovered if a thread in the process
holding the mutex segfaults, resulting in a hang of the web server.</p>
</note>
</li>
<li><code>sysvsem</code>
<p>This is a mutex variant based on a SystemV IPC semaphore.</p>
<note type="warning"><title>Warning</title>
<p>It is possible to "leak" SysV semaphores if processes crash
before the semaphore is removed.</p>
</note>
<note type="warning"><title>Security</title>
<p>The semaphore API allows for a denial of service attack by any
CGIs running under the same uid as the webserver (<em>i.e.</em>,
all CGIs, unless you use something like <program>suexec</program>
or <code>cgiwrapper</code>).</p>
</note>
</li>
<li><code>sem</code>
<p>This selects the "best" available semaphore implementation, choosing
between Posix and SystemV IPC semaphores, in that order.</p></li>
<li><code>pthread</code>
<p>This is a mutex variant based on cross-process Posix thread
mutexes.</p>
<note type="warning"><title>Warning</title>
<p>On most systems, if a child process terminates abnormally while
holding a mutex that uses this implementation, the server will deadlock
and stop responding to requests. When this occurs, the server will
require a manual restart to recover.</p>
<p>Solaris is a notable exception as it provides a mechanism which
usually allows the mutex to be recovered after a child process
terminates abnormally while holding a mutex.</p>
<p>If your system implements the
<code>pthread_mutexattr_setrobust_np()</code> function, you may be able
to use the <code>pthread</code> option safely.</p>
</note>
</li>
<li><code>fcntl:/path/to/mutex</code>
<p>This is a mutex variant where a physical (lock-)file and the
<code>fcntl()</code> function are used as the mutex.</p>
<note type="warning"><title>Warning</title>
<p>When multiple mutexes based on this mechanism are used within
multi-threaded, multi-process environments, deadlock errors (EDEADLK)
can be reported for valid mutex operations if <code>fcntl()</code>
is not thread-aware, such as on Solaris.</p>
</note>
</li>
<li><code>flock:/path/to/mutex</code>
<p>This is similar to the <code>fcntl:/path/to/mutex</code> method
with the exception that the <code>flock()</code> function is used to
provide file locking.</p></li>
<li><code>file:/path/to/mutex</code>
<p>This selects the "best" available file locking implementation,
choosing between <code>fcntl</code> and <code>flock</code>, in that
order.</p></li>
</ul>
<p>Most mechanisms are only available on selected platforms, where the
underlying platform and <glossary>APR</glossary> support it. Mechanisms
which aren't available on all platforms are <em>posixsem</em>,
<em>sysvsem</em>, <em>sem</em>, <em>pthread</em>, <em>fcntl</em>,
<em>flock</em>, and <em>file</em>.</p>
<p>With the file-based mechanisms <em>fcntl</em> and <em>flock</em>,
the path, if provided, is a directory where the lock file will be created.
The default directory is httpd's run-time file directory relative to
<directive module="core">ServerRoot</directive>. Always use a local disk
filesystem for <code>/path/to/mutex</code> and never a directory residing
on a NFS- or AFS-filesystem. The basename of the file will be the mutex
type, an optional instance string provided by the module, and unless the
<code>OmitPID</code> keyword is specified, the process id of the httpd
parent process will be appended to to make the file name unique, avoiding
conflicts when multiple httpd instances share a lock file directory. For
example, if the mutex name is <code>mpm-accept</code> and the lock file
directory is <code>/var/httpd/locks</code>, the lock file name for the
httpd instance with parent process id 12345 would be
<code>/var/httpd/locks/mpm-accept.12345</code>.</p>
<note type="warning"><title>Security</title>
<p>It is best to <em>avoid</em> putting mutex files in a world-writable
directory such as <code>/var/tmp</code> because someone could create
a denial of service attack and prevent the server from starting by
creating a lockfile with the same name as the one the server will try
to create.</p>
</note>
<p>The following table documents the names of mutexes used by httpd
and bundled modules.</p>
<table border="1" style="zebra">
<tr>
<th>Mutex name</th>
<th>Module(s)</th>
<th>Protected resource</th>
</tr>
<tr>
<td><code>mpm-accept</code></td>
<td><module>prefork</module> and <module>worker</module> MPMs</td>
<td>incoming connections, to avoid the thundering herd problem;
for more information, refer to the
<a href="/misc/perf-tuning.html">performance tuning</a>
documentation</td>
</tr>
<tr>
<td><code>authdigest-client</code></td>
<td><module>mod_auth_digest</module></td>
<td>client list in shared memory</td>
</tr>
<tr>
<td><code>authdigest-opaque</code></td>
<td><module>mod_auth_digest</module></td>
<td>counter in shared memory</td>
</tr>
<tr>
<td><code>ldap-cache</code></td>
<td><module>mod_ldap</module></td>
<td>LDAP result cache</td>
</tr>
<tr>
<td><code>rewrite-map</code></td>
<td><module>mod_rewrite</module></td>
<td>communication with external mapping programs, to avoid
intermixed I/O from multiple requests</td>
</tr>
<tr>
<td><code>ssl-cache</code></td>
<td><module>mod_ssl</module></td>
<td>SSL session cache</td>
</tr>
<tr>
<td><code>ssl-stapling</code></td>
<td><module>mod_ssl</module></td>
<td>OCSP stapling response cache</td>
</tr>
<tr>
<td><code>watchdog-callback</code></td>
<td><module>mod_watchdog</module></td>
<td>callback function of a particular client module</td>
</tr>
</table>
<p>The <code>OmitPID</code> keyword suppresses the addition of the httpd
parent process id from the lock file name.</p>
<p>In the following example, the mutex mechanism for the MPM accept
mutex will be changed from the compiled-in default to <code>fcntl</code>,
with the associated lock file created in directory
<code>/var/httpd/locks</code>. The mutex mechanism for all other mutexes
will be changed from the compiled-in default to <code>sysvsem</code>.</p>
<example>
Mutex default sysvsem<br />
Mutex mpm-accept fcntl:/var/httpd/locks
</example>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>NameVirtualHost</name>
<description>Designates an IP address for name-virtual
hosting</description>
<syntax>NameVirtualHost <var>addr</var>[:<var>port</var>]</syntax>
<contextlist><context>server config</context></contextlist>
<usage>
<p>A single <directive>NameVirtualHost</directive> directive
identifies a set of identical virtual hosts on which the server will
further select from on the basis of the <em>hostname</em>
requested by the client. The <directive>NameVirtualHost</directive>
directive is a required directive if you want to configure
<a href="/vhosts/">name-based virtual hosts</a>.</p>
<p>This directive, and the corresponding <directive >VirtualHost</directive>,
<em>must</em> be qualified with a port number if the server supports both HTTP
and HTTPS connections.</p>
<p>Although <var>addr</var> can be a hostname, it is recommended
that you always use an IP address or a wildcard. A wildcard
NameVirtualHost matches only virtualhosts that also have a literal wildcard
as their argument.</p>
<p>In cases where a firewall or other proxy receives the requests and
forwards them on a different IP address to the server, you must specify the
IP address of the physical interface on the machine which will be
servicing the requests. </p>
<p> In the example below, requests received on interface 192.0.2.1 and port 80
will only select among the first two virtual hosts. Requests received on
port 80 on any other interface will only select among the third and fourth
virtual hosts. In the common case where the interface isn't important
to the mapping, only the "*:80" NameVirtualHost and VirtualHost directives
are necessary.</p>
<example>
NameVirtualHost 192.0.2.1:80<br />
NameVirtualHost *:80<br /><br />
&lt;VirtualHost 192.0.2.1:80&gt;<br />
&nbsp; ServerName namebased-a.example.com<br />
&lt;/VirtualHost&gt;<br />
<br />
&lt;VirtualHost 192.0.2.1:80&gt;<br />
&nbsp; Servername namebased-b.example.com<br />
&lt;/VirtualHost&gt;<br />
<br />
&lt;VirtualHost *:80&gt;<br />
&nbsp; ServerName namebased-c.example.com <br />
&lt;/VirtualHost&gt;<br />
<br />
&lt;VirtualHost *:80&gt;<br />
&nbsp; ServerName namebased-d.example.com <br />
&lt;/VirtualHost&gt;<br />
<br />
</example>
<p>If no matching virtual host is found, then the first listed
virtual host that matches the IP address and port will be used.</p>
<p>IPv6 addresses must be enclosed in square brackets, as shown
in the following example:</p>
<example>
NameVirtualHost [2001:db8::a00:20ff:fea7:ccea]:8080
</example>
<note><title>Argument to <directive type="section">VirtualHost</directive>
directive</title>
<p>Note that the argument to the <directive
type="section">VirtualHost</directive> directive must
exactly match the argument to the <directive
>NameVirtualHost</directive> directive.</p>
<example>
NameVirtualHost 192.0.2.2:80<br />
&lt;VirtualHost 192.0.2.2:80&gt;<br />
# ...<br />
&lt;/VirtualHost&gt;<br />
</example>
</note>
</usage>
<seealso><a href="/vhosts/">Virtual Hosts
documentation</a></seealso>
</directivesynopsis>
<directivesynopsis>
<name>Options</name>
<description>Configures what features are available in a particular
directory</description>
<syntax>Options
[+|-]<var>option</var> [[+|-]<var>option</var>] ...</syntax>
<default>Options All</default>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>Options</override>
<usage>
<p>The <directive>Options</directive> directive controls which
server features are available in a particular directory.</p>
<p><var>option</var> can be set to <code>None</code>, in which
case none of the extra features are enabled, or one or more of
the following:</p>
<dl>
<dt><code>All</code></dt>
<dd>All options except for <code>MultiViews</code>. This is the default
setting.</dd>
<dt><code>ExecCGI</code></dt>
<dd>
Execution of CGI scripts using <module>mod_cgi</module>
is permitted.</dd>
<dt><code>FollowSymLinks</code></dt>
<dd>
The server will follow symbolic links in this directory.
<note>
<p>Even though the server follows the symlink it does <em>not</em>
change the pathname used to match against <directive type="section"
module="core">Directory</directive> sections.</p>
<p>Note also, that this option <strong>gets ignored</strong> if set
inside a <directive type="section" module="core">Location</directive>
section.</p>
<p>Omitting this option should not be considered a security restriction,
since symlink testing is subject to race conditions that make it
circumventable.</p>
</note></dd>
<dt><code>Includes</code></dt>
<dd>
Server-side includes provided by <module>mod_include</module>
are permitted.</dd>
<dt><code>IncludesNOEXEC</code></dt>
<dd>
Server-side includes are permitted, but the <code>#exec
cmd</code> and <code>#exec cgi</code> are disabled. It is still
possible to <code>#include virtual</code> CGI scripts from
<directive module="mod_alias">ScriptAlias</directive>ed
directories.</dd>
<dt><code>Indexes</code></dt>
<dd>
If a URL which maps to a directory is requested, and there
is no <directive module="mod_dir">DirectoryIndex</directive>
(<em>e.g.</em>, <code>index.html</code>) in that directory, then
<module>mod_autoindex</module> will return a formatted listing
of the directory.</dd>
<dt><code>MultiViews</code></dt>
<dd>
<a href="/content-negotiation.html">Content negotiated</a>
"MultiViews" are allowed using
<module>mod_negotiation</module>.
<note><title>Note</title> <p>This option gets ignored if set
anywhere other than <directive module="core" type="section"
>Directory</directive>, as <module>mod_negotiation</module>
needs real resources to compare against and evaluate from.</p></note>
</dd>
<dt><code>SymLinksIfOwnerMatch</code></dt>
<dd>The server will only follow symbolic links for which the
target file or directory is owned by the same user id as the
link.
<note><title>Note</title> <p>This option gets ignored if
set inside a <directive module="core"
type="section">Location</directive> section.</p>
<p>This option should not be considered a security restriction,
since symlink testing is subject to race conditions that make it
circumventable.</p></note>
</dd>
</dl>
<p>Normally, if multiple <directive>Options</directive> could
apply to a directory, then the most specific one is used and
others are ignored; the options are not merged. (See <a
href="/sections.html#mergin">how sections are merged</a>.)
However if <em>all</em> the options on the
<directive>Options</directive> directive are preceded by a
<code>+</code> or <code>-</code> symbol, the options are
merged. Any options preceded by a <code>+</code> are added to the
options currently in force, and any options preceded by a
<code>-</code> are removed from the options currently in
force. </p>
<note type="warning"><title>Warning</title>
<p>Mixing <directive>Options</directive> with a <code>+</code> or
<code>-</code> with those without is not valid syntax, and is likely
to cause unexpected results.</p>
</note>
<p>For example, without any <code>+</code> and <code>-</code> symbols:</p>
<example>
&lt;Directory /web/docs&gt;<br />
<indent>
Options Indexes FollowSymLinks<br />
</indent>
&lt;/Directory&gt;<br />
<br />
&lt;Directory /web/docs/spec&gt;<br />
<indent>
Options Includes<br />
</indent>
&lt;/Directory&gt;
</example>
<p>then only <code>Includes</code> will be set for the
<code>/web/docs/spec</code> directory. However if the second
<directive>Options</directive> directive uses the <code>+</code> and
<code>-</code> symbols:</p>
<example>
&lt;Directory /web/docs&gt;<br />
<indent>
Options Indexes FollowSymLinks<br />
</indent>
&lt;/Directory&gt;<br />
<br />
&lt;Directory /web/docs/spec&gt;<br />
<indent>
Options +Includes -Indexes<br />
</indent>
&lt;/Directory&gt;
</example>
<p>then the options <code>FollowSymLinks</code> and
<code>Includes</code> are set for the <code>/web/docs/spec</code>
directory.</p>
<note><title>Note</title>
<p>Using <code>-IncludesNOEXEC</code> or
<code>-Includes</code> disables server-side includes completely
regardless of the previous setting.</p>
</note>
<p>The default in the absence of any other settings is
<code>All</code>.</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>Protocol</name>
<description>Protocol for a listening socket</description>
<syntax>Protocol <var>protocol</var></syntax>
<contextlist><context>server config</context><context>virtual host</context></contextlist>
<compatibility>Available in Apache 2.1.5 and later.
On Windows from Apache 2.3.3 and later.</compatibility>
<usage>
<p>This directive specifies the protocol used for a specific listening socket.
The protocol is used to determine which module should handle a request, and
to apply protocol specific optimizations with the <directive>AcceptFilter</directive>
directive.</p>
<p>You only need to set the protocol if you are running on non-standard ports, otherwise <code>http</code> is assumed for port 80 and <code>https</code> for port 443.</p>
<p>For example, if you are running <code>https</code> on a non-standard port, specify the protocol explicitly:</p>
<example>
Protocol https
</example>
<p>You can also specify the protocol using the <directive module="mpm_common">Listen</directive> directive.</p>
</usage>
<seealso><directive>AcceptFilter</directive></seealso>
<seealso><directive module="mpm_common">Listen</directive></seealso>
</directivesynopsis>
<directivesynopsis>
<name>RLimitCPU</name>
<description>Limits the CPU consumption of processes launched
by Apache httpd children</description>
<syntax>RLimitCPU <var>seconds</var>|max [<var>seconds</var>|max]</syntax>
<default>Unset; uses operating system defaults</default>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context></contextlist>
<override>All</override>
<usage>
<p>Takes 1 or 2 parameters. The first parameter sets the soft
resource limit for all processes and the second parameter sets
the maximum resource limit. Either parameter can be a number,
or <code>max</code> to indicate to the server that the limit should
be set to the maximum allowed by the operating system
configuration. Raising the maximum resource limit requires that
the server is running as <code>root</code>, or in the initial startup
phase.</p>
<p>This applies to processes forked off from Apache httpd children
servicing requests, not the Apache httpd children themselves. This
includes CGI scripts and SSI exec commands, but not any
processes forked off from the Apache httpd parent such as piped
logs.</p>
<p>CPU resource limits are expressed in seconds per
process.</p>
</usage>
<seealso><directive module="core">RLimitMEM</directive></seealso>
<seealso><directive module="core">RLimitNPROC</directive></seealso>
</directivesynopsis>
<directivesynopsis>
<name>RLimitMEM</name>
<description>Limits the memory consumption of processes launched
by Apache httpd children</description>
<syntax>RLimitMEM <var>bytes</var>|max [<var>bytes</var>|max]</syntax>
<default>Unset; uses operating system defaults</default>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context></contextlist>
<override>All</override>
<usage>
<p>Takes 1 or 2 parameters. The first parameter sets the soft
resource limit for all processes and the second parameter sets
the maximum resource limit. Either parameter can be a number,
or <code>max</code> to indicate to the server that the limit should
be set to the maximum allowed by the operating system
configuration. Raising the maximum resource limit requires that
the server is running as <code>root</code>, or in the initial startup
phase.</p>
<p>This applies to processes forked off from Apache httpd children
servicing requests, not the Apache httpd children themselves. This
includes CGI scripts and SSI exec commands, but not any
processes forked off from the Apache httpd parent such as piped
logs.</p>
<p>Memory resource limits are expressed in bytes per
process.</p>
</usage>
<seealso><directive module="core">RLimitCPU</directive></seealso>
<seealso><directive module="core">RLimitNPROC</directive></seealso>
</directivesynopsis>
<directivesynopsis>
<name>RLimitNPROC</name>
<description>Limits the number of processes that can be launched by
processes launched by Apache httpd children</description>
<syntax>RLimitNPROC <var>number</var>|max [<var>number</var>|max]</syntax>
<default>Unset; uses operating system defaults</default>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context></contextlist>
<override>All</override>
<usage>
<p>Takes 1 or 2 parameters. The first parameter sets the soft
resource limit for all processes and the second parameter sets
the maximum resource limit. Either parameter can be a number,
or <code>max</code> to indicate to the server that the limit
should be set to the maximum allowed by the operating system
configuration. Raising the maximum resource limit requires that
the server is running as <code>root</code>, or in the initial startup
phase.</p>
<p>This applies to processes forked off from Apache httpd children
servicing requests, not the Apache httpd children themselves. This
includes CGI scripts and SSI exec commands, but not any
processes forked off from the Apache httpd parent such as piped
logs.</p>
<p>Process limits control the number of processes per user.</p>
<note><title>Note</title>
<p>If CGI processes are <strong>not</strong> running
under user ids other than the web server user id, this directive
will limit the number of processes that the server itself can
create. Evidence of this situation will be indicated by
<strong><code>cannot fork</code></strong> messages in the
<code>error_log</code>.</p>
</note>
</usage>
<seealso><directive module="core">RLimitMEM</directive></seealso>
<seealso><directive module="core">RLimitCPU</directive></seealso>
</directivesynopsis>
<directivesynopsis>
<name>ScriptInterpreterSource</name>
<description>Technique for locating the interpreter for CGI
scripts</description>
<syntax>ScriptInterpreterSource Registry|Registry-Strict|Script</syntax>
<default>ScriptInterpreterSource Script</default>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context></contextlist>
<override>FileInfo</override>
<compatibility>Win32 only;
option <code>Registry-Strict</code> is available in Apache HTTP Server 2.0 and
later</compatibility>
<usage>
<p>This directive is used to control how Apache httpd finds the
interpreter used to run CGI scripts. The default setting is
<code>Script</code>. This causes Apache httpd to use the interpreter pointed to
by the shebang line (first line, starting with <code>#!</code>) in the
script. On Win32 systems this line usually looks like:</p>
<example>
#!C:/Perl/bin/perl.exe
</example>
<p>or, if <code>perl</code> is in the <code>PATH</code>, simply:</p>
<example>
#!perl
</example>
<p>Setting <code>ScriptInterpreterSource Registry</code> will
cause the Windows Registry tree <code>HKEY_CLASSES_ROOT</code> to be
searched using the script file extension (e.g., <code>.pl</code>) as a
search key. The command defined by the registry subkey
<code>Shell\ExecCGI\Command</code> or, if it does not exist, by the subkey
<code>Shell\Open\Command</code> is used to open the script file. If the
registry keys cannot be found, Apache httpd falls back to the behavior of the
<code>Script</code> option.</p>
<note type="warning"><title>Security</title>
<p>Be careful when using <code>ScriptInterpreterSource
Registry</code> with <directive
module="mod_alias">ScriptAlias</directive>'ed directories, because
Apache httpd will try to execute <strong>every</strong> file within this
directory. The <code>Registry</code> setting may cause undesired
program calls on files which are typically not executed. For
example, the default open command on <code>.htm</code> files on
most Windows systems will execute Microsoft Internet Explorer, so
any HTTP request for an <code>.htm</code> file existing within the
script directory would start the browser in the background on the
server. This is a good way to crash your system within a minute or
so.</p>
</note>
<p>The option <code>Registry-Strict</code> which is new in Apache HTTP Server
2.0 does the same thing as <code>Registry</code> but uses only the
subkey <code>Shell\ExecCGI\Command</code>. The
<code>ExecCGI</code> key is not a common one. It must be
configured manually in the windows registry and hence prevents
accidental program calls on your system.</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>SeeRequestTail</name>
<description>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.</description>
<syntax>SeeRequestTail On|Off</syntax>
<default>SeeRequestTail Off</default>
<contextlist><context>server config</context></contextlist>
<compatibility>Available in Apache httpd 2.2.7 and later.</compatibility>
<usage>
<p>mod_status with <code>ExtendedStatus On</code>
displays the actual request being handled.
For historical purposes, only 63 characters of the request
are actually stored for display purposes. This directive
controls whether the 1st 63 characters are stored (the previous
behavior and the default) or if the last 63 characters are. This
is only applicable, of course, if the length of the request is
64 characters or greater.</p>
<p>If Apache httpd is handling <code
>GET&nbsp;/disk1/storage/apache/htdocs/images/imagestore1/food/apples.jpg&nbsp;HTTP/1.1</code
> mod_status displays as follows:
</p>
<table border="1">
<tr>
<th>Off (default)</th>
<td>GET&nbsp;/disk1/storage/apache/htdocs/images/imagestore1/food/apples</td>
</tr>
<tr>
<th>On</th>
<td>orage/apache/htdocs/images/imagestore1/food/apples.jpg&nbsp;HTTP/1.1</td>
</tr>
</table>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>ServerAdmin</name>
<description>Email address that the server includes in error
messages sent to the client</description>
<syntax>ServerAdmin <var>email-address</var>|<var>URL</var></syntax>
<contextlist><context>server config</context><context>virtual host</context>
</contextlist>
<usage>
<p>The <directive>ServerAdmin</directive> sets the contact address
that the server includes in any error messages it returns to the
client. If the <code>httpd</code> doesn't recognize the supplied argument
as an URL, it
assumes, that it's an <var>email-address</var> and prepends it with
<code>mailto:</code> in hyperlink targets. However, it's recommended to
actually use an email address, since there are a lot of CGI scripts that
make that assumption. If you want to use an URL, it should point to another
server under your control. Otherwise users may not be able to contact you in
case of errors.</p>
<p>It may be worth setting up a dedicated address for this, e.g.</p>
<example>
ServerAdmin www-admin@foo.example.com
</example>
<p>as users do not always mention that they are talking about the
server!</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>ServerAlias</name>
<description>Alternate names for a host used when matching requests
to name-virtual hosts</description>
<syntax>ServerAlias <var>hostname</var> [<var>hostname</var>] ...</syntax>
<contextlist><context>virtual host</context></contextlist>
<usage>
<p>The <directive>ServerAlias</directive> directive sets the
alternate names for a host, for use with <a
href="/vhosts/name-based.html">name-based virtual hosts</a>. The
<directive>ServerAlias</directive> may include wildcards, if appropriate.</p>
<example>
&lt;VirtualHost *:80&gt;<br />
ServerName server.domain.com<br />
ServerAlias server server2.domain.com server2<br />
ServerAlias *.example.com<br />
UseCanonicalName Off<br />
# ...<br />
&lt;/VirtualHost&gt;
</example>
</usage>
<seealso><directive module="core">UseCanonicalName</directive></seealso>
<seealso><a href="/vhosts/">Apache HTTP Server Virtual Host documentation</a></seealso>
</directivesynopsis>
<directivesynopsis>
<name>ServerName</name>
<description>Hostname and port that the server uses to identify
itself</description>
<syntax>ServerName [<var>scheme</var>://]<var>fully-qualified-domain-name</var>[:<var>port</var>]</syntax>
<contextlist><context>server config</context><context>virtual host</context>
</contextlist>
<usage>
<p>The <directive>ServerName</directive> directive sets the
request scheme, hostname and
port that the server uses to identify itself. This is used when
creating redirection URLs.</p>
<p>Additionally, <directive>ServerName</directive> is used (possibly
in conjunction with <directive>ServerAlias</directive>) to uniquely
identify a virtual host, when using <a
href="/vhosts/name-based.html">name-based virtual hosts</a>.</p>
<p>For example, if the name of the
machine hosting the web server is <code>simple.example.com</code>,
but the machine also has the DNS alias <code>www.example.com</code>
and you wish the web server to be so identified, the following
directive should be used:</p>
<example>
ServerName www.example.com:80
</example>
<p>The <directive>ServerName</directive> directive
may appear anywhere within the definition of a server. However,
each appearance overrides the previous appearance (within that
server).</p>
<p>If no <directive>ServerName</directive> is specified, then the
server attempts to deduce the hostname by performing a reverse
lookup on the IP address. If no port is specified in the
<directive>ServerName</directive>, then the server will use the
port from the incoming request. For optimal reliability and
predictability, you should specify an explicit hostname and port
using the <directive>ServerName</directive> directive.</p>
<p>If you are using <a
href="/vhosts/name-based.html">name-based virtual hosts</a>,
the <directive>ServerName</directive> inside a
<directive type="section" module="core">VirtualHost</directive>
section specifies what hostname must appear in the request's
<code>Host:</code> header to match this virtual host.</p>
<p>Sometimes, the server runs behind a device that processes SSL,
such as a reverse proxy, load balancer or SSL offload
appliance. When this is the case, specify the
<code>https://</code> scheme and the port number to which the
clients connect in the <directive>ServerName</directive> directive
to make sure that the server generates the correct
self-referential URLs.
</p>
<p>See the description of the
<directive module="core">UseCanonicalName</directive> and
<directive module="core">UseCanonicalPhysicalPort</directive> directives for
settings which determine whether self-referential URLs (e.g., by the
<module>mod_dir</module> module) will refer to the
specified port, or to the port number given in the client's request.
</p>
<note type="warning">
<p>Failure to set <directive>ServerName</directive> to a name that
your server can resolve to an IP address will result in a startup
warning. <code>httpd</code> will then use whatever hostname it can
determine, using the system's <code>hostname</code> command. This
will almost never be the hostname you actually want.</p>
<example>
httpd: Could not reliably determine the server's fully qualified domain name, using rocinante.local for ServerName
</example>
</note>
</usage>
<seealso><a href="/dns-caveats.html">Issues Regarding DNS and
Apache HTTP Server</a></seealso>
<seealso><a href="/vhosts/">Apache HTTP Server virtual host
documentation</a></seealso>
<seealso><directive module="core">UseCanonicalName</directive></seealso>
<seealso><directive module="core">UseCanonicalPhysicalPort</directive></seealso>
<seealso><directive module="core">NameVirtualHost</directive></seealso>
<seealso><directive module="core">ServerAlias</directive></seealso>
</directivesynopsis>
<directivesynopsis>
<name>ServerPath</name>
<description>Legacy URL pathname for a name-based virtual host that
is accessed by an incompatible browser</description>
<syntax>ServerPath <var>URL-path</var></syntax>
<contextlist><context>virtual host</context></contextlist>
<usage>
<p>The <directive>ServerPath</directive> directive sets the legacy
URL pathname for a host, for use with <a
href="/vhosts/">name-based virtual hosts</a>.</p>
</usage>
<seealso><a href="/vhosts/">Apache HTTP Server Virtual Host documentation</a></seealso>
</directivesynopsis>
<directivesynopsis>
<name>ServerRoot</name>
<description>Base directory for the server installation</description>
<syntax>ServerRoot <var>directory-path</var></syntax>
<default>ServerRoot /usr/local/apache</default>
<contextlist><context>server config</context></contextlist>
<usage>
<p>The <directive>ServerRoot</directive> directive sets the
directory in which the server lives. Typically it will contain the
subdirectories <code>conf/</code> and <code>logs/</code>. Relative
paths in other configuration directives (such as <directive
module="core">Include</directive> or <directive
module="mod_so">LoadModule</directive>, for example) are taken as
relative to this directory.</p>
<example><title>Example</title>
ServerRoot /home/httpd
</example>
</usage>
<seealso><a href="/invoking.html">the <code>-d</code>
option to <code>httpd</code></a></seealso>
<seealso><a href="/misc/security_tips.html#serverroot">the
security tips</a> for information on how to properly set
permissions on the <directive>ServerRoot</directive></seealso>
</directivesynopsis>
<directivesynopsis>
<name>ServerSignature</name>
<description>Configures the footer on server-generated documents</description>
<syntax>ServerSignature On|Off|EMail</syntax>
<default>ServerSignature Off</default>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
<usage>
<p>The <directive>ServerSignature</directive> directive allows the
configuration of a trailing footer line under server-generated
documents (error messages, <module>mod_proxy</module> ftp directory
listings, <module>mod_info</module> output, ...). The reason why you
would want to enable such a footer line is that in a chain of proxies,
the user often has no possibility to tell which of the chained servers
actually produced a returned error message.</p>
<p>The <code>Off</code>
setting, which is the default, suppresses the footer line (and is
therefore compatible with the behavior of Apache-1.2 and
below). The <code>On</code> setting simply adds a line with the
server version number and <directive
module="core">ServerName</directive> of the serving virtual host,
and the <code>EMail</code> setting additionally creates a
"mailto:" reference to the <directive
module="core">ServerAdmin</directive> of the referenced
document.</p>
<p>After version 2.0.44, the details of the server version number
presented are controlled by the <directive
module="core">ServerTokens</directive> directive.</p>
</usage>
<seealso><directive module="core">ServerTokens</directive></seealso>
</directivesynopsis>
<directivesynopsis>
<name>ServerTokens</name>
<description>Configures the <code>Server</code> HTTP response
header</description>
<syntax>ServerTokens Major|Minor|Min[imal]|Prod[uctOnly]|OS|Full</syntax>
<default>ServerTokens Full</default>
<contextlist><context>server config</context></contextlist>
<usage>
<p>This directive controls whether <code>Server</code> response
header field which is sent back to clients includes a
description of the generic OS-type of the server as well as
information about compiled-in modules.</p>
<dl>
<dt><code>ServerTokens Full</code> (or not specified)</dt>
<dd>Server sends (<em>e.g.</em>): <code>Server: Apache/2.4.1
(Unix) PHP/4.2.2 MyMod/1.2</code></dd>
<dt><code>ServerTokens Prod[uctOnly]</code></dt>
<dd>Server sends (<em>e.g.</em>): <code>Server:
Apache</code></dd>
<dt><code>ServerTokens Major</code></dt>
<dd>Server sends (<em>e.g.</em>): <code>Server:
Apache/2</code></dd>
<dt><code>ServerTokens Minor</code></dt>
<dd>Server sends (<em>e.g.</em>): <code>Server:
Apache/2.4</code></dd>
<dt><code>ServerTokens Min[imal]</code></dt>
<dd>Server sends (<em>e.g.</em>): <code>Server:
Apache/2.4.1</code></dd>
<dt><code>ServerTokens OS</code></dt>
<dd>Server sends (<em>e.g.</em>): <code>Server: Apache/2.4.1
(Unix)</code></dd>
</dl>
<p>This setting applies to the entire server, and cannot be
enabled or disabled on a virtualhost-by-virtualhost basis.</p>
<p>After version 2.0.44, this directive also controls the
information presented by the <directive
module="core">ServerSignature</directive> directive.</p>
<note>Setting <directive>ServerTokens</directive> to less than
<code>minimal</code> is not recommended because it makes it more
difficult to debug interoperational problems. Also note that
disabling the Server: header does nothing at all to make your
server more secure; the idea of "security through obscurity"
is a myth and leads to a false sense of safety.</note>
</usage>
<seealso><directive module="core">ServerSignature</directive></seealso>
</directivesynopsis>
<directivesynopsis>
<name>SetHandler</name>
<description>Forces all matching files to be processed by a
handler</description>
<syntax>SetHandler <var>handler-name</var>|None</syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>FileInfo</override>
<compatibility>Moved into the core in Apache httpd 2.0</compatibility>
<usage>
<p>When placed into an <code>.htaccess</code> file or a
<directive type="section" module="core">Directory</directive> or
<directive type="section" module="core">Location</directive>
section, this directive forces all matching files to be parsed
through the <a href="/handler.html">handler</a> given by
<var>handler-name</var>. For example, if you had a directory you
wanted to be parsed entirely as imagemap rule files, regardless
of extension, you might put the following into an
<code>.htaccess</code> file in that directory:</p>
<example>
SetHandler imap-file
</example>
<p>Another example: if you wanted to have the server display a
status report whenever a URL of
<code>http://servername/status</code> was called, you might put
the following into <code>httpd.conf</code>:</p>
<example>
&lt;Location /status&gt;<br />
<indent>
SetHandler server-status<br />
</indent>
&lt;/Location&gt;
</example>
<p>You can override an earlier defined <directive>SetHandler</directive>
directive by using the value <code>None</code>.</p>
<p><strong>Note:</strong> because SetHandler overrides default handlers,
normal behaviour such as handling of URLs ending in a slash (/) as
directories or index files is suppressed.</p>
</usage>
<seealso><directive module="mod_mime">AddHandler</directive></seealso>
</directivesynopsis>
<directivesynopsis>
<name>SetInputFilter</name>
<description>Sets the filters that will process client requests and POST
input</description>
<syntax>SetInputFilter <var>filter</var>[;<var>filter</var>...]</syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>FileInfo</override>
<usage>
<p>The <directive>SetInputFilter</directive> directive sets the
filter or filters which will process client requests and POST
input when they are received by the server. This is in addition to
any filters defined elsewhere, including the
<directive module="mod_mime">AddInputFilter</directive>
directive.</p>
<p>If more than one filter is specified, they must be separated
by semicolons in the order in which they should process the
content.</p>
</usage>
<seealso><a href="/filter.html">Filters</a> documentation</seealso>
</directivesynopsis>
<directivesynopsis>
<name>SetOutputFilter</name>
<description>Sets the filters that will process responses from the
server</description>
<syntax>SetOutputFilter <var>filter</var>[;<var>filter</var>...]</syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>FileInfo</override>
<usage>
<p>The <directive>SetOutputFilter</directive> directive sets the filters
which will process responses from the server before they are
sent to the client. This is in addition to any filters defined
elsewhere, including the
<directive module="mod_mime">AddOutputFilter</directive>
directive.</p>
<p>For example, the following configuration will process all files
in the <code>/www/data/</code> directory for server-side
includes.</p>
<example>
&lt;Directory /www/data/&gt;<br />
<indent>
SetOutputFilter INCLUDES<br />
</indent>
&lt;/Directory&gt;
</example>
<p>If more than one filter is specified, they must be separated
by semicolons in the order in which they should process the
content.</p>
</usage>
<seealso><a href="/filter.html">Filters</a> documentation</seealso>
</directivesynopsis>
<directivesynopsis>
<name>TimeOut</name>
<description>Amount of time the server will wait for
certain events before failing a request</description>
<syntax>TimeOut <var>seconds</var></syntax>
<default>TimeOut 60</default>
<contextlist><context>server config</context><context>virtual host</context></contextlist>
<usage>
<p>The <directive>TimeOut</directive> directive defines the length
of time Apache httpd will wait for I/O in various circumstances:</p>
<ol>
<li>When reading data from the client, the length of time to
wait for a TCP packet to arrive if the read buffer is
empty.</li>
<li>When writing data to the client, the length of time to wait
for an acknowledgement of a packet if the send buffer is
full.</li>
<li>In <module>mod_cgi</module>, the length of time to wait for
output from a CGI script.</li>
<li>In <module>mod_ext_filter</module>, the length of time to
wait for output from a filtering process.</li>
<li>In <module>mod_proxy</module>, the default timeout value if
<directive module="mod_proxy">ProxyTimeout</directive> is not
configured.</li>
</ol>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>TraceEnable</name>
<description>Determines the behaviour on <code>TRACE</code> requests</description>
<syntax>TraceEnable <var>[on|off|extended]</var></syntax>
<default>TraceEnable on</default>
<contextlist><context>server config</context></contextlist>
<compatibility>Available in Apache HTTP Server 1.3.34, 2.0.55 and later</compatibility>
<usage>
<p>This directive overrides the behavior of <code>TRACE</code> for both
the core server and <module>mod_proxy</module>. The default
<code>TraceEnable on</code> permits <code>TRACE</code> requests per
RFC 2616, which disallows any request body to accompany the request.
<code>TraceEnable off</code> causes the core server and
<module>mod_proxy</module> to return a <code>405</code> (Method not
allowed) error to the client.</p>
<p>Finally, for testing and diagnostic purposes only, request
bodies may be allowed using the non-compliant <code>TraceEnable
extended</code> directive. The core (as an origin server) will
restrict the request body to 64k (plus 8k for chunk headers if
<code>Transfer-Encoding: chunked</code> is used). The core will
reflect the full headers and all chunk headers with the response
body. As a proxy server, the request body is not restricted to 64k.</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>UnDefine</name>
<description>Undefine the existence of a variable</description>
<syntax>UnDefine <var>parameter-name</var></syntax>
<contextlist><context>server config</context></contextlist>
<usage>
<p>Undoes the effect of a <directive module="core">Define</directive> or
of passing a <code>-D</code> argument to <program>httpd</program>.</p>
<p>This directive can be used to toggle the use of <directive module="core"
type="section">IfDefine</directive> sections without needing to alter
<code>-D</code> arguments in any startup scripts.</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>UseCanonicalName</name>
<description>Configures how the server determines its own name and
port</description>
<syntax>UseCanonicalName On|Off|DNS</syntax>
<default>UseCanonicalName Off</default>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context></contextlist>
<usage>
<p>In many situations Apache httpd must construct a <em>self-referential</em>
URL -- that is, a URL that refers back to the same server. With
<code>UseCanonicalName On</code> Apache httpd will use the hostname and port
specified in the <directive module="core">ServerName</directive>
directive to construct the canonical name for the server. This name
is used in all self-referential URLs, and for the values of
<code>SERVER_NAME</code> and <code>SERVER_PORT</code> in CGIs.</p>
<p>With <code>UseCanonicalName Off</code> Apache httpd will form
self-referential URLs using the hostname and port supplied by
the client if any are supplied (otherwise it will use the
canonical name, as defined above). These values are the same
that are used to implement <a
href="/vhosts/name-based.html">name-based virtual hosts</a>,
and are available with the same clients. The CGI variables
<code>SERVER_NAME</code> and <code>SERVER_PORT</code> will be
constructed from the client supplied values as well.</p>
<p>An example where this may be useful is on an intranet server
where you have users connecting to the machine using short
names such as <code>www</code>. You'll notice that if the users
type a shortname, and a URL which is a directory, such as
<code>http://www/splat</code>, <em>without the trailing
slash</em> then Apache httpd will redirect them to
<code>http://www.domain.com/splat/</code>. If you have
authentication enabled, this will cause the user to have to
authenticate twice (once for <code>www</code> and once again
for <code>www.domain.com</code> -- see <a
href="http://httpd.apache.org/docs/misc/FAQ.html#prompted-twice">the
FAQ on this subject for more information</a>). But if
<directive>UseCanonicalName</directive> is set <code>Off</code>, then
Apache httpd will redirect to <code>http://www/splat/</code>.</p>
<p>There is a third option, <code>UseCanonicalName DNS</code>,
which is intended for use with mass IP-based virtual hosting to
support ancient clients that do not provide a
<code>Host:</code> header. With this option Apache httpd does a
reverse DNS lookup on the server IP address that the client
connected to in order to work out self-referential URLs.</p>
<note type="warning"><title>Warning</title>
<p>If CGIs make assumptions about the values of <code>SERVER_NAME</code>
they may be broken by this option. The client is essentially free
to give whatever value they want as a hostname. But if the CGI is
only using <code>SERVER_NAME</code> to construct self-referential URLs
then it should be just fine.</p>
</note>
</usage>
<seealso><directive module="core">UseCanonicalPhysicalPort</directive></seealso>
<seealso><directive module="core">ServerName</directive></seealso>
<seealso><directive module="mpm_common">Listen</directive></seealso>
</directivesynopsis>
<directivesynopsis>
<name>UseCanonicalPhysicalPort</name>
<description>Configures how the server determines its own name and
port</description>
<syntax>UseCanonicalPhysicalPort On|Off</syntax>
<default>UseCanonicalPhysicalPort Off</default>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context></contextlist>
<usage>
<p>In many situations Apache httpd must construct a <em>self-referential</em>
URL -- that is, a URL that refers back to the same server. With
<code>UseCanonicalPhysicalPort On</code> Apache httpd will, when
constructing the canonical port for the server to honor
the <directive module="core">UseCanonicalName</directive> directive,
provide the actual physical port number being used by this request
as a potential port. With <code>UseCanonicalPhysicalPort Off</code>
Apache httpd will not ever use the actual physical port number, instead
relying on all configured information to construct a valid port number.</p>
<note><title>Note</title>
<p>The ordering of when the physical port is used is as follows:<br /><br />
<code>UseCanonicalName On</code></p>
<ul>
<li>Port provided in <code>Servername</code></li>
<li>Physical port</li>
<li>Default port</li>
</ul>
<code>UseCanonicalName Off | DNS</code>
<ul>
<li>Parsed port from <code>Host:</code> header</li>
<li>Physical port</li>
<li>Port provided in <code>Servername</code></li>
<li>Default port</li>
</ul>
<p>With <code>UseCanonicalPhysicalPort Off</code>, the
physical ports are removed from the ordering.</p>
</note>
</usage>
<seealso><directive module="core">UseCanonicalName</directive></seealso>
<seealso><directive module="core">ServerName</directive></seealso>
<seealso><directive module="mpm_common">Listen</directive></seealso>
</directivesynopsis>
<directivesynopsis type="section">
<name>VirtualHost</name>
<description>Contains directives that apply only to a specific
hostname or IP address</description>
<syntax>&lt;VirtualHost
<var>addr</var>[:<var>port</var>] [<var>addr</var>[:<var>port</var>]]
...&gt; ... &lt;/VirtualHost&gt;</syntax>
<contextlist><context>server config</context></contextlist>
<usage>
<p><directive type="section">VirtualHost</directive> and
<code>&lt;/VirtualHost&gt;</code> are used to enclose a group of
directives that will apply only to a particular virtual host. Any
directive that is allowed in a virtual host context may be
used. When the server receives a request for a document on a
particular virtual host, it uses the configuration directives
enclosed in the <directive type="section">VirtualHost</directive>
section. <var>Addr</var> can be:</p>
<ul>
<li>The IP address of the virtual host;</li>
<li>A fully qualified domain name for the IP address of the
virtual host (not recommended);</li>
<li>The character <code>*</code>, which is used only in combination with
<code>NameVirtualHost *</code> to match all IP addresses; or</li>
<li>The string <code>_default_</code>, which is used only
with IP virtual hosting to catch unmatched IP addresses.</li>
</ul>
<example><title>Example</title>
&lt;VirtualHost 10.1.2.3&gt;<br />
<indent>
ServerAdmin webmaster@host.example.com<br />
DocumentRoot /www/docs/host.example.com<br />
ServerName host.example.com<br />
ErrorLog logs/host.example.com-error_log<br />
TransferLog logs/host.example.com-access_log<br />
</indent>
&lt;/VirtualHost&gt;
</example>
<p>IPv6 addresses must be specified in square brackets because
the optional port number could not be determined otherwise. An
IPv6 example is shown below:</p>
<example>
&lt;VirtualHost [2001:db8::a00:20ff:fea7:ccea]&gt;<br />
<indent>
ServerAdmin webmaster@host.example.com<br />
DocumentRoot /www/docs/host.example.com<br />
ServerName host.example.com<br />
ErrorLog logs/host.example.com-error_log<br />
TransferLog logs/host.example.com-access_log<br />
</indent>
&lt;/VirtualHost&gt;
</example>
<p>Each Virtual Host must correspond to a different IP address,
different port number or a different host name for the server,
in the former case the server machine must be configured to
accept IP packets for multiple addresses. (If the machine does
not have multiple network interfaces, then this can be
accomplished with the <code>ifconfig alias</code> command -- if
your OS supports it).</p>
<note><title>Note</title>
<p>The use of <directive type="section">VirtualHost</directive> does
<strong>not</strong> affect what addresses Apache httpd listens on. You
may need to ensure that Apache httpd is listening on the correct addresses
using <directive module="mpm_common">Listen</directive>.</p>
</note>
<p>When using IP-based virtual hosting, the special name
<code>_default_</code> can be specified in
which case this virtual host will match any IP address that is
not explicitly listed in another virtual host. In the absence
of any <code>_default_</code> virtual host the "main" server config,
consisting of all those definitions outside any VirtualHost
section, is used when no IP-match occurs.</p>
<p>You can specify a <code>:port</code> to change the port that is
matched. If unspecified then it defaults to the same port as the
most recent <directive module="mpm_common">Listen</directive>
statement of the main server. You may also specify <code>:*</code>
to match all ports on that address. (This is recommended when used
with <code>_default_</code>.)</p>
<p>A <directive module="core">ServerName</directive> should be
specified inside each <directive
type="section">VirtualHost</directive> block. If it is absent, the
<directive module="core">ServerName</directive> from the "main"
server configuration will be inherited.</p>
<p>If no matching virtual host is found, then the first listed
virtual host that matches the IP address will be used. As a
consequence, the first listed virtual host is the default virtual
host.</p>
<note type="warning"><title>Security</title>
<p>See the <a href="/misc/security_tips.html">security tips</a>
document for details on why your security could be compromised if the
directory where log files are stored is writable by anyone other
than the user that starts the server.</p>
</note>
</usage>
<seealso><a href="/vhosts/">Apache HTTP Server Virtual Host documentation</a></seealso>
<seealso><a href="/dns-caveats.html">Issues Regarding DNS and
Apache HTTP Server</a></seealso>
<seealso><a href="/bind.html">Setting
which addresses and ports Apache HTTP Server uses</a></seealso>
<seealso><a href="/sections.html">How &lt;Directory&gt;, &lt;Location&gt;
and &lt;Files&gt; sections work</a> for an explanation of how these
different sections are combined when a request is received</seealso>
</directivesynopsis>
</modulesynopsis>