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" />
  12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13 <body>
  14 <div id="page-header">
  15 <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>
  16 <p class="apache">Apache HTTP Server Version 2.1</p>
  17 <img alt="" src="../images/feather.gif" /></div>
  18 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  19 <div id="path">
  20 <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>
  21 <div id="page-content">
  22 <div id="preamble"><h1>Apache Module mod_info</h1>
  23 <div class="toplang">
  24 <p><span>Available Languages: </span><a href="../en/mod/mod_info.html" title="English">&nbsp;en&nbsp;</a> |
  25 <a href="../ja/mod/mod_info.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a></p>
  26 </div>
  27 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides a comprehensive overview of the server
  28 configuration</td></tr>
  29 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  30 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>info_module</td></tr>
  31 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_info.c</td></tr></table>
  32 <h3>Summary</h3>
  33
  34     <p>To configure <code class="module"><a href="../mod/mod_info.html">mod_info</a></code>, add the following to your
  35     <code>httpd.conf</code> file.</p>
  36
  37     <div class="example"><p><code>
  38       &lt;Location /server-info&gt;<br />
  39       <span class="indent">
  40         SetHandler server-info<br />
  41       </span>
  42       &lt;/Location&gt;
  43     </code></p></div>
  44
  45     <p>Once configured, the server information is obtained by
  46     accessing <code>http://your.host.example.com/server-info</code></p>
  47 </div>
  48 <div id="quickview"><h3 class="directives">Directives</h3>
  49 <ul id="toc">
  50 <li><img alt="" src="../images/down.gif" /> <a href="#addmoduleinfo">AddModuleInfo</a></li>
  51 </ul>
  52 <h3>Topics</h3>
  53 <ul id="topics">
  54 <li><img alt="" src="../images/down.gif" /> <a href="#security">Security Issues</a></li>
  55 <li><img alt="" src="../images/down.gif" /> <a href="#queries">Selecting the information shown</a></li>
  56 <li><img alt="" src="../images/down.gif" /> <a href="#limitations">Known Limitations</a></li>
  57 </ul></div>
  58 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  59 <div class="section">
  60 <h2><a name="security" id="security">Security Issues</a></h2>
  61     <p>Once <code class="module"><a href="../mod/mod_info.html">mod_info</a></code> is loaded into the server, its
  62     handler capability is available in <em>all</em> configuration
  63     files, including per-directory files (<em>e.g.</em>,
  64     <code>.htaccess</code>). This may have security-related
  65     ramifications for your site.</p>
  66
  67     <p>In particular, this module can leak sensitive information
  68     from the configuration directives of other Apache modules such as
  69     system paths, usernames/passwords, database names, etc. Therefore,
  70     this module should <strong>only</strong> be
  71     used in a controlled environment and always with caution.</p>
  72
  73     <p>You will probably want to use <code class="module"><a href="../mod/mod_access.html">mod_access</a></code>
  74     to limit access to your server configuration information.</p>
  75
  76     <div class="example"><h3>Access control</h3><p><code>
  77       &lt;Location /server-info&gt;<br />
  78       <span class="indent">
  79         SetHandler server-info<br />
  80         Order allow,deny<br />
  81         # Allow access from server itself<br />
  82         Allow from 127.0.0.1<br />
  83         # Additionally, allow access from local workstation<br />
  84         Allow from 192.168.1.17<br />
  85       </span>
  86       &lt;/Location&gt;
  87     </code></p></div>
  88 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  89 <div class="section">
  90 <h2><a name="queries" id="queries">Selecting the information shown</a></h2>
  91     <p>By default, the server information includes a list of
  92     all enabled modules, and for each module, a description of
  93     the directives understood by that module, the hooks implemented
  94     by that module, and the relevant directives from the current
  95     configuration.</p>
  96
  97     <p>Other views of the configuration information are available by
  98     appending a query to the <code>server-info</code> request. For
  99     example, <code>http://your.host.dom/server-info?config</code>
 100     will show all configuration directives.</p>
 101
 102     <dl>
 103         <dt><code>?&lt;module-name&gt;</code></dt>
 104             <dd>Only information relevant to the named module</dd>
 105         <dt><code>?config</code></dt>
 106             <dd>Just the configuration directives, not sorted by module</dd>
 107         <dt><code>?list</code></dt>
 108             <dd>Only a simple list of enabled modules</dd>
 109         <dt><code>?server</code></dt>
 110             <dd>Only the basic server information</dd>
 111     </dl>
 112 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 113 <div class="section">
 114 <h2><a name="limitations" id="limitations">Known Limitations</a></h2>
 115     <p><code class="module"><a href="../mod/mod_info.html">mod_info</a></code> provides its information by reading the
 116     parsed configuration, rather than reading the original configuration
 117     file. There are a few limitations as a result of the way the parsed
 118     configuration tree is created:</p>
 119     <ul>
 120       <li>Directives which are executed immediately rather than being
 121           stored in the parsed configuration are not listed. These include
 122           <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>,
 123           <code class="directive"><a href="../mod/mod_so.html#loadmodule">LoadModule</a></code>, and
 124           <code class="directive"><a href="../mod/mod_so.html#loadfile">LoadFile</a></code>.</li>
 125       <li>Directives which control the configuration file itself, such as
 126           <code class="directive"><a href="../mod/core.html#include">Include</a></code>,
 127           <code class="directive"><a href="../mod/core.html#&lt;ifmodule&gt;">&lt;IfModule&gt;</a></code> and
 128           <code class="directive"><a href="../mod/core.html#&lt;ifdefine&gt;">&lt;IfDefine&gt;</a></code> are not
 129           listed, but the included configuration directives are.</li>
 130       <li>Comments are not listed. (This may be considered a feature.)</li>
 131       <li>Configuration directives from <code>.htaccess</code> files are
 132           not listed (since they do not form part of the permanent server
 133           configuration).</li>
 134       <li>Container directives such as
 135           <code class="directive"><a href="../mod/core.html#&lt;directory&gt;">&lt;Directory&gt;</a></code>
 136           are listed normally, but <code class="module"><a href="../mod/mod_info.html">mod_info</a></code> cannot figure
 137           out the line number for the closing
 138           <code class="directive"><a href="../mod/core.html#&lt;/directory&gt;">&lt;/Directory&gt;</a></code>.</li>
 139       <li>Directives generated by third party modules such as <code class="module"><a href="../mod/mod_perl.html">mod_perl</a></code>
 140           might not be listed.</li>
 141     </ul>
 142 </div>
 143 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 144 <div class="directive-section"><h2><a name="AddModuleInfo" id="AddModuleInfo">AddModuleInfo</a> <a name="addmoduleinfo" id="addmoduleinfo">Directive</a></h2>
 145 <table class="directive">
 146 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Adds additional information to the module
 147 information displayed by the server-info handler</td></tr>
 148 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AddModuleInfo <var>module-name</var> <var>string</var></code></td></tr>
 149 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 150 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 151 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_info</td></tr>
 152 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Apache 1.3 and above</td></tr>
 153 </table>
 154     <p>This allows the content of <var>string</var> to be shown as
 155     HTML interpreted, <strong>Additional Information</strong> for
 156     the module <var>module-name</var>. Example:</p>
 157
 158     <div class="example"><p><code>
 159       AddModuleInfo mod_deflate.c 'See &lt;a \<br />
 160       <span class="indent">
 161         href="http://www.apache.org/docs-2.1/mod/mod_deflate.html"&gt;\<br />
 162         http://www.apache.org/docs-2.1/mod/mod_deflate.html&lt;/a&gt;'
 163       </span>
 164     </code></p></div>
 165
 166 </div>
 167 </div>
 168 <div class="bottomlang">
 169 <p><span>Available Languages: </span><a href="../en/mod/mod_info.html" title="English">&nbsp;en&nbsp;</a> |
 170 <a href="../ja/mod/mod_info.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a></p>
 171 </div><div id="footer">
 172 <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>
 173 <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>
 174 </body></html>