mod_info.html.en revision 4e191199a0aeab09d78df8f5579e745572e8b7bc
<?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">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
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" /><link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link href="/images/favicon.ico" rel="shortcut icon" /></head><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><img alt="" src="/images/feather.gif" /></div><div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="/images/left.gif" /></a></div><div id="path"><a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs-project/">Documentation</a> &gt; <a href="../">Version 2.1</a> &gt; <a href="./">Modules</a></div><div id="page-content"><div id="preamble"><h1>Apache Module mod_info</h1><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#Status">Status:
</a></th><td>Extension</td></tr><tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:
</a></th><td>info_module</td></tr><tr><th><a href="module-dict.html#SourceFile">Source�File:
</a></th><td>mod_info.c</td></tr></table><h3>Summary</h3>
<p>To configure <code class="module"><a href="/mod/mod_info.html">mod_info</a></code>, add the following to your
<code>httpd.conf</code> file.</p>
<div class="example"><p><code>
&lt;Location /server-info&gt;<br />
<span class="indent">
SetHandler server-info<br />
</span>
&lt;/Location&gt;
</code></p></div>
<p>You may wish to add a
<code class="directive"><a href="/mod/core.html#limit">&lt;Limit&gt;</a></code>
clause inside the
<code class="directive"><a href="/mod/core.html#location">&lt;Location&gt;</a></code>
directive to limit access to your server configuration
information.</p>
<p>Once configured, the server information is obtained by
accessing <code>http://your.host.dom/server-info</code></p>
<div class="note">
Note that the configuration files are read by the
module at run-time, and therefore the display may
<em>not</em> reflect the running server's active
configuration if the files have been changed since the server
was last reloaded. Also, the configuration files must be
readable by the user as which the server is running (see the
<code class="directive"><a href="/mod/mpm_common.html#user">User</a></code> directive), or
else the directive settings will not be listed.
<p>It should also be noted that if
<code class="module"><a href="/mod/mod_info.html">mod_info</a></code> is compiled into the server, its
handler capability is available in <em>all</em> configuration
files, including per-directory files (<em>e.g.</em>,
<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
system paths, usernames/passwords, database names, etc. Due to
the way this module works there is no way to block information
from it. Therefore, this module should <strong>only</strong> be
used in a controlled environment and always with caution.</p>
</div>
</div><div id="quickview"><h3 class="directives">Directives</h3><ul id="toc"><li><img alt="" src="/images/down.gif" /> <a href="#addmoduleinfo">AddModuleInfo</a></li>
</ul></div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></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#Status">Status:
</a></th><td>Extension</td></tr><tr><th><a href="directive-dict.html#Module">Module:
</a></th><td>mod_info</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 &lt;a \<br />
<span class="indent">
href="http://www.apache.org/docs-2.1/mod/mod_deflate.html"&gt;\<br />
http://www.apache.org/docs-2.1/mod/mod_deflate.html&lt;/a&gt;'
</span>
</code></p></div>
</div></div><div id="footer"><p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</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>