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 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
   5 <!--
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7               This file is generated from xml source: DO NOT EDIT
   8         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   9       -->
  10 <title>mod_info - Apache HTTP Server Version 2.5</title>
  11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  13 <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" />
  14 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  15 </script>
  16
  17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  18 <body>
  19 <div id="page-header">
  20 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.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>
  21 <p class="apache">Apache HTTP Server Version 2.5</p>
  22 <img alt="" src="../images/feather.png" /></div>
  23 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  24 <div id="path">
  25 <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>
  26 <div id="page-content">
  27 <div id="preamble"><h1>Apache Module mod_info</h1>
  28 <div class="toplang">
  29 <p><span>Available Languages: </span><a href="../en/mod/mod_info.html" title="English">&nbsp;en&nbsp;</a> |
  30 <a href="../fr/mod/mod_info.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
  31 <a href="../ja/mod/mod_info.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
  32 <a href="../ko/mod/mod_info.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
  33 </div>
  34 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides a comprehensive overview of the server
  35 configuration</td></tr>
  36 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  37 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>info_module</td></tr>
  38 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_info.c</td></tr></table>
  39 <h3>Summary</h3>
  40
  41     <p>To configure <code class="module"><a href="../mod/mod_info.html">mod_info</a></code>, add the following to your
  42     <code>httpd.conf</code> file.</p>
  43
  44     <pre class="prettyprint lang-config">&lt;Location "/server-info"&gt;
  45     SetHandler server-info
  46 &lt;/Location&gt;</pre>
  47
  48
  49     <p>You may wish to use <code class="module"><a href="../mod/mod_authz_host.html">mod_authz_host</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">&lt;Location "/server-info"&gt;
  55     SetHandler server-info
  56     Require host example.com
  57 &lt;/Location&gt;</pre>
  58
  59
  60     <p>Once configured, the server information is obtained by
  61     accessing <code>http://your.host.example.com/server-info</code></p>
  62 </div>
  63 <div id="quickview"><h3>Topics</h3>
  64 <ul id="topics">
  65 <li><img alt="" src="../images/down.gif" /> <a href="#security">Security Issues</a></li>
  66 <li><img alt="" src="../images/down.gif" /> <a href="#queries">Selecting the information shown</a></li>
  67 <li><img alt="" src="../images/down.gif" /> <a href="#startup">Dumping the configuration on startup</a></li>
  68 <li><img alt="" src="../images/down.gif" /> <a href="#limitations">Known Limitations</a></li>
  69 </ul><h3 class="directives">Directives</h3>
  70 <ul id="toc">
  71 <li><img alt="" src="../images/down.gif" /> <a href="#addmoduleinfo">AddModuleInfo</a></li>
  72 </ul>
  73 <h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&amp;list_id=144532&amp;product=Apache%20httpd-2&amp;query_format=specific&amp;order=changeddate%20DESC%2Cpriority%2Cbug_severity&amp;component=mod_info">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component=mod_info">Report a bug</a></li></ul><h3>See also</h3>
  74 <ul class="seealso">
  75 <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><a title="Permanent link" href="#security" class="permalink">&para;</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">&lt;Location "/server-info"&gt;
  95     SetHandler server-info
  96     # Allow access from server itself
  97     Require ip 127.0.0.1
  98
  99     # Additionally, allow access from local workstation
 100     Require ip 192.168.1.17
 101 &lt;/Location&gt;</pre>
 102 </div>
 103 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 104 <div class="section">
 105 <h2><a name="queries" id="queries">Selecting the information shown</a><a title="Permanent link" href="#queries" class="permalink">&para;</a></h2>
 106     <p>By default, the server information includes a list of
 107     all enabled modules, and for each module, a description of
 108     the directives understood by that module, the hooks implemented
 109     by that module, and the relevant directives from the current
 110     configuration.</p>
 111
 112     <p>Other views of the configuration information are available by
 113     appending a query to the <code>server-info</code> request. For
 114     example, <code>http://your.host.example.com/server-info?config</code>
 115     will show all configuration directives.</p>
 116
 117     <dl>
 118         <dt><code>?&lt;module-name&gt;</code></dt>
 119             <dd>Only information relevant to the named module</dd>
 120         <dt><code>?config</code></dt>
 121             <dd>Just the configuration directives, not sorted by module</dd>
 122         <dt><code>?hooks</code></dt>
 123             <dd>Only the list of Hooks each module is attached to</dd>
 124         <dt><code>?list</code></dt>
 125             <dd>Only a simple list of enabled modules</dd>
 126         <dt><code>?server</code></dt>
 127             <dd>Only the basic server information</dd>
 128         <dt><code>?providers</code></dt>
 129             <dd>List the providers that are available on your server</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><a title="Permanent link" href="#startup" class="permalink">&para;</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.</p>
 137
 138     <pre class="prettyprint lang-sh">httpd -DDUMP_CONFIG -k start</pre>
 139
 140
 141     <p>Pre-parsed means that directives like
 142     <code class="directive"><a href="../mod/core.html#ifdefine">&lt;IfDefine&gt;</a></code> and
 143     <code class="directive"><a href="../mod/core.html#ifmodule">&lt;IfModule&gt;</a></code> are
 144     evaluated and environment variables are replaced. However it does
 145     not represent the final state of the configuration. In particular,
 146     it does not represent the merging or overriding that may happen
 147     for repeated directives.</p>
 148
 149     <p>This is roughly equivalent to the <code>?config</code> query.</p>
 150 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 151 <div class="section">
 152 <h2><a name="limitations" id="limitations">Known Limitations</a><a title="Permanent link" href="#limitations" class="permalink">&para;</a></h2>
 153     <p><code class="module"><a href="../mod/mod_info.html">mod_info</a></code> provides its information by reading the
 154     parsed configuration, rather than reading the original configuration
 155     file. There are a few limitations as a result of the way the parsed
 156     configuration tree is created:</p>
 157     <ul>
 158       <li>Directives which are executed immediately rather than being
 159           stored in the parsed configuration are not listed. These include
 160           <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>,
 161           <code class="directive"><a href="../mod/mod_so.html#loadmodule">LoadModule</a></code>, and
 162           <code class="directive"><a href="../mod/mod_so.html#loadfile">LoadFile</a></code>.</li>
 163       <li>Directives which control the configuration file itself, such as
 164           <code class="directive"><a href="../mod/core.html#include">Include</a></code>,
 165           <code class="directive"><a href="../mod/core.html#ifmodule">&lt;IfModule&gt;</a></code> and
 166           <code class="directive"><a href="../mod/core.html#ifdefine">&lt;IfDefine&gt;</a></code> are not
 167           listed, but the included configuration directives are.</li>
 168       <li>Comments are not listed. (This may be considered a feature.)</li>
 169       <li>Configuration directives from <code>.htaccess</code> files are
 170           not listed (since they do not form part of the permanent server
 171           configuration).</li>
 172       <li>Container directives such as
 173           <code class="directive"><a href="../mod/core.html#directory">&lt;Directory&gt;</a></code>
 174           are listed normally, but <code class="module"><a href="../mod/mod_info.html">mod_info</a></code> cannot figure
 175           out the line number for the closing
 176           <code class="directive"><a href="../mod/core.html#directory">&lt;/Directory&gt;</a></code>.</li>
 177       <li>Directives generated by third party modules such as <a href="http://perl.apache.org">mod_perl</a>
 178           might not be listed.</li>
 179     </ul>
 180 </div>
 181 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 182 <div class="directive-section"><h2><a name="AddModuleInfo" id="AddModuleInfo">AddModuleInfo</a> <a name="addmoduleinfo" id="addmoduleinfo">Directive</a><a title="Permanent link" href="#addmoduleinfo" class="permalink">&para;</a></h2>
 183 <table class="directive">
 184 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Adds additional information to the module
 185 information displayed by the server-info handler</td></tr>
 186 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AddModuleInfo <var>module-name</var> <var>string</var></code></td></tr>
 187 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 188 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 189 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_info</td></tr>
 190 </table>
 191     <p>This allows the content of <var>string</var> to be shown as
 192     HTML interpreted, <strong>Additional Information</strong> for
 193     the module <var>module-name</var>. Example:</p>
 194
 195     <pre class="prettyprint lang-config">AddModuleInfo mod_deflate.c 'See &lt;a \
 196     href="http://httpd.apache.org/docs/trunk/mod/mod_deflate.html"&gt;\
 197     http://httpd.apache.org/docs/trunk/mod/mod_deflate.html&lt;/a&gt;'</pre>
 198
 199
 200 </div>
 201 </div>
 202 <div class="bottomlang">
 203 <p><span>Available Languages: </span><a href="../en/mod/mod_info.html" title="English">&nbsp;en&nbsp;</a> |
 204 <a href="../fr/mod/mod_info.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
 205 <a href="../ja/mod/mod_info.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 206 <a href="../ko/mod/mod_info.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 207 </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>
 208 <script type="text/javascript"><!--//--><![CDATA[//><!--
 209 var comments_shortname = 'httpd';
 210 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_info.html';
 211 (function(w, d) {
 212     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 213         d.write('<div id="comments_thread"><\/div>');
 214         var s = d.createElement('script');
 215         s.type = 'text/javascript';
 216         s.async = true;
 217         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 218         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 219     }
 220     else {
 221         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 222     }
 223 })(window, document);
 224 //--><!]]></script></div><div id="footer">
 225 <p class="apache">Copyright 2018 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>
 226 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.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[//><!--
 227 if (typeof(prettyPrint) !== 'undefined') {
 228     prettyPrint();
 229 }
 230 //--><!]]></script>
 231 </body></html>