]> granicus.if.org Git - apache/blob - docs/manual/mod/mod_info.html.en
fd239a2fe3e96b0086550fd512c31cd85ee7b5d0
[apache] / 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       --><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.0</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.0</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:
8                   </a></th><td>Provides a comprehensive overview of the server
9 configuration</td></tr><tr><th><a href="module-dict.html#Status">Status:
10                   </a></th><td>Extension</td></tr><tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:
11                   </a></th><td>info_module</td></tr><tr><th><a href="module-dict.html#SourceFile">Source File:
12                   </a></th><td>mod_info.c</td></tr></table><h3>Summary</h3>
13     <p>To configure <code class="module"><a href="../mod/mod_info.html">mod_info</a></code>, add the following to your
14     <code>httpd.conf</code> file.</p>
15
16     <div class="example"><p><code>
17       &lt;Location /server-info&gt;<br />
18       <span class="indent">
19         SetHandler server-info<br />
20       </span>
21       &lt;/Location&gt;
22     </code></p></div>
23
24     <p>You may wish to add a 
25     <code class="directive"><a href="../mod/core.html#limit">&lt;Limit&gt;</a></code> 
26     clause inside the 
27     <code class="directive"><a href="../mod/core.html#location">&lt;Location&gt;</a></code>
28     directive to limit access to your server configuration 
29     information.</p>
30
31     <p>Once configured, the server information is obtained by
32     accessing <code>http://your.host.dom/server-info</code></p>
33
34     <div class="note">
35       Note that the configuration files are read by the
36       module at run-time, and therefore the display may
37       <em>not</em> reflect the running server's active
38       configuration if the files have been changed since the server
39       was last reloaded. Also, the configuration files must be
40       readable by the user as which the server is running (see the
41       <code class="directive"><a href="../mod/mpm_common.html#user">User</a></code> directive), or
42       else the directive settings will not be listed.
43
44       <p>It should also be noted that if
45       <code class="module"><a href="../mod/mod_info.html">mod_info</a></code> is compiled into the server, its
46       handler capability is available in <em>all</em> configuration
47       files, including per-directory files (<em>e.g.</em>,
48       <code>.htaccess</code>). This may have security-related
49       ramifications for your site.</p>
50
51       <p>In particular, this module can leak sensitive information
52       from the configuration directives of other Apache modules such as
53       system paths, usernames/passwords, database names, etc.  Due to
54       the way this module works there is no way to block information
55       from it.  Therefore, this module should <strong>only</strong> be
56       used in a controlled environment and always with caution.</p>
57     </div>
58 </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>
59 </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: 
60               </a></th><td>Adds additional information to the module
61 information displayed by the server-info handler</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
62               </a></th><td><code>AddModuleInfo <var>module-name</var> <var>string</var></code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
63               </a></th><td>server config, virtual host</td></tr><tr><th><a href="directive-dict.html#Status">Status:
64               </a></th><td>Extension</td></tr><tr><th><a href="directive-dict.html#Module">Module:
65               </a></th><td>mod_info</td></tr><tr><th><a href="directive-dict.html#Compatibility">Compatibility:
66               </a></th><td>Apache 1.3 and above</td></tr></table>
67     <p>This allows the content of <var>string</var> to be shown as
68     HTML interpreted, <strong>Additional Information</strong> for
69     the module <var>module-name</var>. Example:</p>
70
71     <div class="example"><p><code>
72       AddModuleInfo mod_deflate.c 'See &lt;a \<br />
73       <span class="indent">
74       href="http://www.apache.org/docs-2.0/mod/mod_deflate.html"&gt;\<br />
75       http://www.apache.org/docs-2.0/mod/mod_deflate.html&lt;/a&gt;'
76       </span>
77     </code></p></div>
78 </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>