mod_info.html.en revision 9c6bbd67082b5a47fb17cfa5b61b8a7e1fb01875
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-->
<title>mod_info - Apache HTTP Server</title>
<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
<body>
<div id="page-header">
<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>
<p class="apache">Apache HTTP Server Version 2.1</p>
<div id="path">
<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="../">Version 2.1</a> > <a href="./">Modules</a></div>
<div id="page-content">
<div id="preamble"><h1>Apache Module mod_info</h1>
<div class="toplang">
<p><span>Available Languages: </span><a href="/en/mod/mod_info.html" title="English"> en </a> |
<a href="/ja/mod/mod_info.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a></p>
</div>
<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides a comprehensive overview of the server
configuration</td></tr>
<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>info_module</td></tr>
<h3>Summary</h3>
<p>To configure <code class="module"><a href="/mod/mod_info.html">mod_info</a></code>, add the following to your
<div class="example"><p><code>
<Location /server-info><br />
<span class="indent">
SetHandler server-info<br />
</span>
</Location>
</code></p></div>
<p>Once configured, the server information is obtained by
</div>
<div id="quickview"><h3 class="directives">Directives</h3>
<ul id="toc">
</ul>
<h3>Topics</h3>
<ul id="topics">
<li><img alt="" src="/images/down.gif" /> <a href="#queries">Selecting the information shown</a></li>
</ul></div>
<div class="section">
<h2><a name="security" id="security">Security Issues</a></h2>
<p>Once <code class="module"><a href="/mod/mod_info.html">mod_info</a></code> is loaded into the server, its
handler capability is available in <em>all</em> configuration
<code>.htaccess</code>). This may have security-related
ramifications for your site.</p>
<p>In particular, this module can leak sensitive information
from the configuration directives of other Apache modules such as
this module should <strong>only</strong> be
used in a controlled environment and always with caution.</p>
<p>You will probably want to use <code class="module"><a href="/mod/mod_access.html">mod_access</a></code>
to limit access to your server configuration information.</p>
<div class="example"><h3>Access control</h3><p><code>
<Location /server-info><br />
<span class="indent">
SetHandler server-info<br />
Order allow,deny<br />
# Allow access from server itself<br />
Allow from 127.0.0.1<br />
# Additionally, allow access from local workstation<br />
Allow from 192.168.1.17<br />
</span>
</Location>
</code></p></div>
<div class="section">
<h2><a name="queries" id="queries">Selecting the information shown</a></h2>
<p>By default, the server information includes a list of
all enabled modules, and for each module, a description of
the directives understood by that module, the hooks implemented
by that module, and the relevant directives from the current
configuration.</p>
<p>Other views of the configuration information are available by
appending a query to the <code>server-info</code> request. For
will show all configuration directives.</p>
<dl>
<dt><code>?<module-name></code></dt>
<dd>Only information relevant to the named module</dd>
<dt><code>?config</code></dt>
<dd>Just the configuration directives, not sorted by module</dd>
<dt><code>?hooks</code></dt>
<dd>Only the list of Hooks each module is attached to</dd>
<dt><code>?list</code></dt>
<dd>Only a simple list of enabled modules</dd>
<dt><code>?server</code></dt>
<dd>Only the basic server information</dd>
</dl>
<div class="section">
<h2><a name="limitations" id="limitations">Known Limitations</a></h2>
<p><code class="module"><a href="/mod/mod_info.html">mod_info</a></code> provides its information by reading the
parsed configuration, rather than reading the original configuration
file. There are a few limitations as a result of the way the parsed
configuration tree is created:</p>
<ul>
<li>Directives which are executed immediately rather than being
stored in the parsed configuration are not listed. These include
<li>Directives which control the configuration file itself, such as
<code class="directive"><a href="/mod/core.html#<ifdefine>"><IfDefine></a></code> are not
listed, but the included configuration directives are.</li>
<li>Comments are not listed. (This may be considered a feature.)</li>
<li>Configuration directives from <code>.htaccess</code> files are
not listed (since they do not form part of the permanent server
configuration).</li>
<li>Container directives such as
are listed normally, but <code class="module"><a href="/mod/mod_info.html">mod_info</a></code> cannot figure
out the line number for the closing
<code class="directive"><a href="/mod/core.html#</directory>"></Directory></a></code>.</li>
<li>Directives generated by third party modules such as <code class="module"><a href="/mod/mod_perl.html">mod_perl</a></code>
might not be listed.</li>
</ul>
</div>
<div class="directive-section"><h2><a name="AddModuleInfo" id="AddModuleInfo">AddModuleInfo</a> <a name="addmoduleinfo" id="addmoduleinfo">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Adds additional information to the module
information displayed by the server-info handler</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AddModuleInfo <var>module-name</var> <var>string</var></code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Apache 1.3 and above</td></tr>
</table>
<p>This allows the content of <var>string</var> to be shown as
HTML interpreted, <strong>Additional Information</strong> for
the module <var>module-name</var>. Example:</p>
<div class="example"><p><code>
AddModuleInfo mod_deflate.c 'See <a \<br />
<span class="indent">
href="http://www.apache.org/docs-2.1/mod/mod_deflate.html">\<br />
</span>
</code></p></div>
</div>
</div>
<div class="bottomlang">
<p><span>Available Languages: </span><a href="/en/mod/mod_info.html" title="English"> en </a> |
<a href="/ja/mod/mod_info.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a></p>
</div><div id="footer">
<p class="apache">Copyright 1999-2004 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>
<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>
</body></html>