granicus.if.org Git - apache/blob - docs/manual/mod/mod_info.html.en

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
   4         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5               This file is generated from xml source: DO NOT EDIT
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7       -->
   8 <title>mod_info - Apache HTTP Server</title>
   9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11 <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" />
  12 <script src="../style/scripts/prettify.js" type="text/javascript">
  13 </script>
  14
  15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  16 <body>
  17 <div id="page-header">
  18 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  19 <p class="apache">Apache HTTP Server Version 2.5</p>
  20 <img alt="" src="../images/feather.gif" /></div>
  21 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  22 <div id="path">
  23 <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/">Documentation</a> &gt; <a href="../">Version 2.5</a> &gt; <a href="./">Modules</a></div>
  24 <div id="page-content">
  25 <div id="preamble"><h1>Apache Module mod_info</h1>
  26 <div class="toplang">
  27 <p><span>Available Languages: </span><a href="../en/mod/mod_info.html" title="English">&nbsp;en&nbsp;</a> |
  28 <a href="../fr/mod/mod_info.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
  29 <a href="../ja/mod/mod_info.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
  30 <a href="../ko/mod/mod_info.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
  31 </div>
  32 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides a comprehensive overview of the server
  33 configuration</td></tr>
  34 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  35 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>info_module</td></tr>
  36 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_info.c</td></tr></table>
  37 <h3>Summary</h3>
  38
  39     <p>To configure <code class="module"><a href="../mod/mod_info.html">mod_info</a></code>, add the following to your
  40     <code>httpd.conf</code> file.</p>
  41
  42     <pre class="prettyprint lang-config">
  43 &lt;Location /server-info&gt;
  44     SetHandler server-info
  45 &lt;/Location&gt;
  46     </pre>
  47
  48
  49     <p>You may wish to use <code class="module"><a href="../mod/mod_access.html">mod_access</a></code> inside the
  50     <code class="directive"><a href="../mod/core.html#location">&lt;Location&gt;</a></code>
  51     directive to limit access to your server configuration
  52     information:</p>
  53
  54     <pre class="prettyprint lang-config">
  55 &lt;Location /server-info&gt;
  56     SetHandler server-info
  57     Require host example.com
  58 &lt;/Location&gt;
  59     </pre>
  60
  61
  62     <p>Once configured, the server information is obtained by
  63     accessing <code>http://your.host.example.com/server-info</code></p>
  64 </div>
  65 <div id="quickview"><h3 class="directives">Directives</h3>
  66 <ul id="toc">
  67 <li><img alt="" src="../images/down.gif" /> <a href="#addmoduleinfo">AddModuleInfo</a></li>
  68 </ul>
  69 <h3>Topics</h3>
  70 <ul id="topics">
  71 <li><img alt="" src="../images/down.gif" /> <a href="#security">Security Issues</a></li>
  72 <li><img alt="" src="../images/down.gif" /> <a href="#queries">Selecting the information shown</a></li>
  73 <li><img alt="" src="../images/down.gif" /> <a href="#startup">Dumping the configuration on startup</a></li>
  74 <li><img alt="" src="../images/down.gif" /> <a href="#limitations">Known Limitations</a></li>
  75 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  76 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  77 <div class="section">
  78 <h2><a name="security" id="security">Security Issues</a></h2>
  79     <p>Once <code class="module"><a href="../mod/mod_info.html">mod_info</a></code> is loaded into the server, its
  80     handler capability is available in <em>all</em> configuration
  81     files, including per-directory files (<em>e.g.</em>,
  82     <code>.htaccess</code>). This may have security-related
  83     ramifications for your site.</p>
  84
  85     <p>In particular, this module can leak sensitive information
  86     from the configuration directives of other Apache modules such as
  87     system paths, usernames/passwords, database names, etc. Therefore,
  88     this module should <strong>only</strong> be
  89     used in a controlled environment and always with caution.</p>
  90
  91     <p>You will probably want to use <code class="module"><a href="../mod/mod_authz_host.html">mod_authz_host</a></code>
  92     to limit access to your server configuration information.</p>
  93
  94     <div class="example"><h3>Access control</h3><pre class="prettyprint lang-config">
  95 &lt;Location /server-info&gt;
  96     SetHandler server-info
  97     Order allow,deny
  98     # Allow access from server itself
  99     Allow from 127.0.0.1
 100     # Additionally, allow access from local workstation
 101     Allow from 192.168.1.17
 102 &lt;/Location&gt;
 103       </pre>
 104 </div>
 105 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 106 <div class="section">
 107 <h2><a name="queries" id="queries">Selecting the information shown</a></h2>
 108     <p>By default, the server information includes a list of
 109     all enabled modules, and for each module, a description of
 110     the directives understood by that module, the hooks implemented
 111     by that module, and the relevant directives from the current
 112     configuration.</p>
 113
 114     <p>Other views of the configuration information are available by
 115     appending a query to the <code>server-info</code> request. For
 116     example, <code>http://your.host.example.com/server-info?config</code>
 117     will show all configuration directives.</p>
 118
 119     <dl>
 120         <dt><code>?&lt;module-name&gt;</code></dt>
 121             <dd>Only information relevant to the named module</dd>
 122         <dt><code>?config</code></dt>
 123             <dd>Just the configuration directives, not sorted by module</dd>
 124         <dt><code>?hooks</code></dt>
 125             <dd>Only the list of Hooks each module is attached to</dd>
 126         <dt><code>?list</code></dt>
 127             <dd>Only a simple list of enabled modules</dd>
 128         <dt><code>?server</code></dt>
 129             <dd>Only the basic server information</dd>
 130     </dl>
 131 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 132 <div class="section">
 133 <h2><a name="startup" id="startup">Dumping the configuration on startup</a></h2>
 134     <p>If the config define <code>-DDUMP_CONFIG</code> is set,
 135     <code class="module"><a href="../mod/mod_info.html">mod_info</a></code> will dump the pre-parsed configuration to
 136     <code>stdout</code> during server startup. Pre-parsed means that
 137     directives like
 138     <code class="directive"><a href="../mod/core.html#ifdefine">&lt;IfDefine&gt;</a></code> and
 139     <code class="directive"><a href="../mod/core.html#ifmodule">&lt;IfModule&gt;</a></code> are
 140     evaluated and environment varialbles are replaced. However it does
 141     not represent the final state of the configuration. In particular,
 142     it does not represent the merging or overriding that may happen
 143     for repeated directives.</p>
 144
 145     <p>This is roughly equivalent to the <code>?config</code> query.</p>
 146 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 147 <div class="section">
 148 <h2><a name="limitations" id="limitations">Known Limitations</a></h2>
 149     <p><code class="module"><a href="../mod/mod_info.html">mod_info</a></code> provides its information by reading the
 150     parsed configuration, rather than reading the original configuration
 151     file. There are a few limitations as a result of the way the parsed
 152     configuration tree is created:</p>
 153     <ul>
 154       <li>Directives which are executed immediately rather than being
 155           stored in the parsed configuration are not listed. These include
 156           <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>,
 157           <code class="directive"><a href="../mod/mod_so.html#loadmodule">LoadModule</a></code>, and
 158           <code class="directive"><a href="../mod/mod_so.html#loadfile">LoadFile</a></code>.</li>
 159       <li>Directives which control the configuration file itself, such as
 160           <code class="directive"><a href="../mod/core.html#include">Include</a></code>,
 161           <code class="directive"><a href="../mod/core.html#&lt;ifmodule&gt;">&lt;IfModule&gt;</a></code> and
 162           <code class="directive"><a href="../mod/core.html#&lt;ifdefine&gt;">&lt;IfDefine&gt;</a></code> are not
 163           listed, but the included configuration directives are.</li>
 164       <li>Comments are not listed. (This may be considered a feature.)</li>
 165       <li>Configuration directives from <code>.htaccess</code> files are
 166           not listed (since they do not form part of the permanent server
 167           configuration).</li>
 168       <li>Container directives such as
 169           <code class="directive"><a href="../mod/core.html#&lt;directory&gt;">&lt;Directory&gt;</a></code>
 170           are listed normally, but <code class="module"><a href="../mod/mod_info.html">mod_info</a></code> cannot figure
 171           out the line number for the closing
 172           <code class="directive"><a href="../mod/core.html#&lt;/directory&gt;">&lt;/Directory&gt;</a></code>.</li>
 173       <li>Directives generated by third party modules such as <a href="http://perl.apache.org">mod_perl</a>
 174           might not be listed.</li>
 175     </ul>
 176 </div>
 177 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 178 <div class="directive-section"><h2><a name="AddModuleInfo" id="AddModuleInfo">AddModuleInfo</a> <a name="addmoduleinfo" id="addmoduleinfo">Directive</a></h2>
 179 <table class="directive">
 180 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Adds additional information to the module
 181 information displayed by the server-info handler</td></tr>
 182 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AddModuleInfo <var>module-name</var> <var>string</var></code></td></tr>
 183 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 184 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 185 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_info</td></tr>
 186 </table>
 187     <p>This allows the content of <var>string</var> to be shown as
 188     HTML interpreted, <strong>Additional Information</strong> for
 189     the module <var>module-name</var>. Example:</p>
 190
 191     <pre class="prettyprint lang-config">
 192 AddModuleInfo mod_deflate.c 'See &lt;a \
 193     href="http://www.apache.org/docs/trunk/mod/mod_deflate.html"&gt;\
 194     http://www.apache.org/docs/trunk/mod/mod_deflate.html&lt;/a&gt;'
 195     </pre>
 196
 197
 198 </div>
 199 </div>
 200 <div class="bottomlang">
 201 <p><span>Available Languages: </span><a href="../en/mod/mod_info.html" title="English">&nbsp;en&nbsp;</a> |
 202 <a href="../fr/mod/mod_info.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
 203 <a href="../ja/mod/mod_info.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 204 <a href="../ko/mod/mod_info.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 205 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
 206 <script type="text/javascript"><!--//--><![CDATA[//><!--
 207 var comments_shortname = 'httpd';
 208 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_info.html';
 209 (function(w, d) {
 210     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 211         d.write('<div id="comments_thread"><\/div>');
 212         var s = d.createElement('script');
 213         s.type = 'text/javascript';
 214         s.async = true;
 215         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 216         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 217     }
 218     else {
 219         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 220     }
 221 })(window, document);
 222 //--><!]]></script></div><div id="footer">
 223 <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>
 224 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
 225 if (typeof(prettyPrint) !== 'undefined') {
 226     prettyPrint();
 227 }
 228 //--><!]]></script>
 229 </body></html>