mod_info.html.en revision 17ade6df5ec233536985eb1c130a906c725dd614
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw This file is generated from xml source: DO NOT EDIT
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="/style/css/prettify.css" />
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<script src="/style/scripts/prettify.js" type="text/javascript">
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<link href="/images/favicon.ico" rel="shortcut icon" /></head>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.5</a> > <a href="./">Modules</a></div>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<p><span>Available Languages: </span><a href="/en/mod/mod_info.html" title="English"> en </a> |
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<a href="/fr/mod/mod_info.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a> |
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<a href="/ja/mod/mod_info.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<a href="/ko/mod/mod_info.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides a comprehensive overview of the server
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>info_module</td></tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_info.c</td></tr></table>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <p>To configure <code class="module"><a href="/mod/mod_info.html">mod_info</a></code>, add the following to your
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<Location /server-info>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw SetHandler server-info
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw</Location>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <p>You may wish to use <code class="module"><a href="/mod/mod_access.html">mod_access</a></code> inside the
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <code class="directive"><a href="/mod/core.html#location"><Location></a></code>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw directive to limit access to your server configuration
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw information:</p>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<Location /server-info>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw SetHandler server-info
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw Require host example.com
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw</Location>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <p>Once configured, the server information is obtained by
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw accessing <code>http://your.host.example.com/server-info</code></p>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<div id="quickview"><h3 class="directives">Directives</h3>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<li><img alt="" src="/images/down.gif" /> <a href="#addmoduleinfo">AddModuleInfo</a></li>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<li><img alt="" src="/images/down.gif" /> <a href="#security">Security Issues</a></li>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<li><img alt="" src="/images/down.gif" /> <a href="#queries">Selecting the information shown</a></li>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<li><img alt="" src="/images/down.gif" /> <a href="#startup">Dumping the configuration on startup</a></li>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<li><img alt="" src="/images/down.gif" /> <a href="#limitations">Known Limitations</a></li>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<h2><a name="security" id="security">Security Issues</a></h2>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <p>Once <code class="module"><a href="/mod/mod_info.html">mod_info</a></code> is loaded into the server, its
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw handler capability is available in <em>all</em> configuration
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw ramifications for your site.</p>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <p>In particular, this module can leak sensitive information
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw from the configuration directives of other Apache modules such as
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw system paths, usernames/passwords, database names, etc. Therefore,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw used in a controlled environment and always with caution.</p>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <p>You will probably want to use <code class="module"><a href="/mod/mod_authz_host.html">mod_authz_host</a></code>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw to limit access to your server configuration information.</p>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<Location /server-info>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw SetHandler server-info
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw Order allow,deny
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw # Allow access from server itself
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw Allow from 127.0.0.1
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw # Additionally, allow access from local workstation
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw Allow from 192.168.1.17
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw</Location>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<h2><a name="queries" id="queries">Selecting the information shown</a></h2>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <p>By default, the server information includes a list of
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw all enabled modules, and for each module, a description of
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw the directives understood by that module, the hooks implemented
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw by that module, and the relevant directives from the current
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw configuration.</p>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <p>Other views of the configuration information are available by
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw appending a query to the <code>server-info</code> request. For
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw example, <code>http://your.host.example.com/server-info?config</code>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw will show all configuration directives.</p>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <dd>Just the configuration directives, not sorted by module</dd>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <dd>Only the list of Hooks each module is attached to</dd>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<h2><a name="startup" id="startup">Dumping the configuration on startup</a></h2>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <p>If the config define <code>-DDUMP_CONFIG</code> is set,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <code class="module"><a href="/mod/mod_info.html">mod_info</a></code> will dump the pre-parsed configuration to
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <code>stdout</code> during server startup. This is roughly equivalent
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<h2><a name="limitations" id="limitations">Known Limitations</a></h2>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <p><code class="module"><a href="/mod/mod_info.html">mod_info</a></code> provides its information by reading the
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw parsed configuration, rather than reading the original configuration
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw file. There are a few limitations as a result of the way the parsed
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw configuration tree is created:</p>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <li>Directives which are executed immediately rather than being
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw stored in the parsed configuration are not listed. These include
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <code class="directive"><a href="/mod/core.html#serverroot">ServerRoot</a></code>,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <code class="directive"><a href="/mod/mod_so.html#loadmodule">LoadModule</a></code>, and
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <code class="directive"><a href="/mod/mod_so.html#loadfile">LoadFile</a></code>.</li>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <li>Directives which control the configuration file itself, such as
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <code class="directive"><a href="/mod/core.html#include">Include</a></code>,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <code class="directive"><a href="/mod/core.html#<ifmodule>"><IfModule></a></code> and
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <code class="directive"><a href="/mod/core.html#<ifdefine>"><IfDefine></a></code> are not
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw listed, but the included configuration directives are.</li>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <li>Comments are not listed. (This may be considered a feature.)</li>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <li>Configuration directives from <code>.htaccess</code> files are
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw not listed (since they do not form part of the permanent server
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw configuration).</li>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <li>Container directives such as
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <code class="directive"><a href="/mod/core.html#<directory>"><Directory></a></code>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw are listed normally, but <code class="module"><a href="/mod/mod_info.html">mod_info</a></code> cannot figure
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw out the line number for the closing
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <code class="directive"><a href="/mod/core.html#</directory>"></Directory></a></code>.</li>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <li>Directives generated by third party modules such as <a href="http://perl.apache.org">mod_perl</a>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw might not be listed.</li>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<div class="directive-section"><h2><a name="AddModuleInfo" id="AddModuleInfo">AddModuleInfo</a> <a name="addmoduleinfo" id="addmoduleinfo">Directive</a></h2>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Adds additional information to the module
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwinformation displayed by the server-info handler</td></tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AddModuleInfo <var>module-name</var> <var>string</var></code></td></tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_info</td></tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <p>This allows the content of <var>string</var> to be shown as
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw HTML interpreted, <strong>Additional Information</strong> for
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwAddModuleInfo mod_deflate.c 'See <a \
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw href="http://www.apache.org/docs/trunk/mod/mod_deflate.html">\
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw http://www.apache.org/docs/trunk/mod/mod_deflate.html</a>'
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<p><span>Available Languages: </span><a href="/en/mod/mod_info.html" title="English"> en </a> |
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<a href="/fr/mod/mod_info.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a> |
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<a href="/ja/mod/mod_info.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<a href="/ko/mod/mod_info.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<p class="apache">Copyright 2012 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div><script type="text/javascript">
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw if (typeof(prettyPrint) !== undefined) {
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw prettyPrint();