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
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>
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.3</p>
17 <img alt="" src="../images/feather.gif" /></div>
18 <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
20 <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.3</a> > <a href="./">Modules</a></div>
21 <div id="page-content">
22 <div id="preamble"><h1>Apache Module mod_info</h1>
24 <p><span>Available Languages: </span><a href="../en/mod/mod_info.html" title="English"> en </a> |
25 <a href="../fr/mod/mod_info.html" hreflang="fr" rel="alternate" title="Français"> fr </a> |
26 <a href="../ja/mod/mod_info.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
27 <a href="../ko/mod/mod_info.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
29 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides a comprehensive overview of the server
30 configuration</td></tr>
31 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
32 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>info_module</td></tr>
33 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_info.c</td></tr></table>
36 <p>To configure <code class="module"><a href="../mod/mod_info.html">mod_info</a></code>, add the following to your
37 <code>httpd.conf</code> file.</p>
39 <div class="example"><p><code>
40 <Location /server-info><br />
42 SetHandler server-info<br />
47 <p>You may wish to use <code class="module"><a href="../mod/mod_access.html">mod_access</a></code> inside the
48 <code class="directive"><a href="../mod/core.html#location"><Location></a></code>
49 directive to limit access to your server configuration
52 <div class="example"><p><code>
53 <Location /server-info><br />
55 SetHandler server-info<br />
56 Require host yourcompany.com<br />
61 <p>Once configured, the server information is obtained by
62 accessing <code>http://your.host.example.com/server-info</code></p>
64 <div id="quickview"><h3 class="directives">Directives</h3>
66 <li><img alt="" src="../images/down.gif" /> <a href="#addmoduleinfo">AddModuleInfo</a></li>
70 <li><img alt="" src="../images/down.gif" /> <a href="#security">Security Issues</a></li>
71 <li><img alt="" src="../images/down.gif" /> <a href="#queries">Selecting the information shown</a></li>
72 <li><img alt="" src="../images/down.gif" /> <a href="#limitations">Known Limitations</a></li>
74 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
76 <h2><a name="security" id="security">Security Issues</a></h2>
77 <p>Once <code class="module"><a href="../mod/mod_info.html">mod_info</a></code> is loaded into the server, its
78 handler capability is available in <em>all</em> configuration
79 files, including per-directory files (<em>e.g.</em>,
80 <code>.htaccess</code>). This may have security-related
81 ramifications for your site.</p>
83 <p>In particular, this module can leak sensitive information
84 from the configuration directives of other Apache modules such as
85 system paths, usernames/passwords, database names, etc. Therefore,
86 this module should <strong>only</strong> be
87 used in a controlled environment and always with caution.</p>
89 <p>You will probably want to use <code class="module"><a href="../mod/mod_authz_host.html">mod_authz_host</a></code>
90 to limit access to your server configuration information.</p>
92 <div class="example"><h3>Access control</h3><p><code>
93 <Location /server-info><br />
95 SetHandler server-info<br />
96 Order allow,deny<br />
97 # Allow access from server itself<br />
98 Allow from 127.0.0.1<br />
99 # Additionally, allow access from local workstation<br />
100 Allow from 192.168.1.17<br />
104 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
105 <div class="section">
106 <h2><a name="queries" id="queries">Selecting the information shown</a></h2>
107 <p>By default, the server information includes a list of
108 all enabled modules, and for each module, a description of
109 the directives understood by that module, the hooks implemented
110 by that module, and the relevant directives from the current
113 <p>Other views of the configuration information are available by
114 appending a query to the <code>server-info</code> request. For
115 example, <code>http://your.host.example.com/server-info?config</code>
116 will show all configuration directives.</p>
119 <dt><code>?<module-name></code></dt>
120 <dd>Only information relevant to the named module</dd>
121 <dt><code>?config</code></dt>
122 <dd>Just the configuration directives, not sorted by module</dd>
123 <dt><code>?hooks</code></dt>
124 <dd>Only the list of Hooks each module is attached to</dd>
125 <dt><code>?list</code></dt>
126 <dd>Only a simple list of enabled modules</dd>
127 <dt><code>?server</code></dt>
128 <dd>Only the basic server information</dd>
130 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
131 <div class="section">
132 <h2><a name="limitations" id="limitations">Known Limitations</a></h2>
133 <p><code class="module"><a href="../mod/mod_info.html">mod_info</a></code> provides its information by reading the
134 parsed configuration, rather than reading the original configuration
135 file. There are a few limitations as a result of the way the parsed
136 configuration tree is created:</p>
138 <li>Directives which are executed immediately rather than being
139 stored in the parsed configuration are not listed. These include
140 <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>,
141 <code class="directive"><a href="../mod/mod_so.html#loadmodule">LoadModule</a></code>, and
142 <code class="directive"><a href="../mod/mod_so.html#loadfile">LoadFile</a></code>.</li>
143 <li>Directives which control the configuration file itself, such as
144 <code class="directive"><a href="../mod/core.html#include">Include</a></code>,
145 <code class="directive"><a href="../mod/core.html#<ifmodule>"><IfModule></a></code> and
146 <code class="directive"><a href="../mod/core.html#<ifdefine>"><IfDefine></a></code> are not
147 listed, but the included configuration directives are.</li>
148 <li>Comments are not listed. (This may be considered a feature.)</li>
149 <li>Configuration directives from <code>.htaccess</code> files are
150 not listed (since they do not form part of the permanent server
152 <li>Container directives such as
153 <code class="directive"><a href="../mod/core.html#<directory>"><Directory></a></code>
154 are listed normally, but <code class="module"><a href="../mod/mod_info.html">mod_info</a></code> cannot figure
155 out the line number for the closing
156 <code class="directive"><a href="../mod/core.html#</directory>"></Directory></a></code>.</li>
157 <li>Directives generated by third party modules such as <a href="http://perl.apache.org">mod_perl</a>
158 might not be listed.</li>
161 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
162 <div class="directive-section"><h2><a name="AddModuleInfo" id="AddModuleInfo">AddModuleInfo</a> <a name="addmoduleinfo" id="addmoduleinfo">Directive</a></h2>
163 <table class="directive">
164 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Adds additional information to the module
165 information displayed by the server-info handler</td></tr>
166 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AddModuleInfo <var>module-name</var> <var>string</var></code></td></tr>
167 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
168 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
169 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_info</td></tr>
171 <p>This allows the content of <var>string</var> to be shown as
172 HTML interpreted, <strong>Additional Information</strong> for
173 the module <var>module-name</var>. Example:</p>
175 <div class="example"><p><code>
176 AddModuleInfo mod_deflate.c 'See <a \<br />
177 <span class="indent">
178 href="http://www.apache.org/docs/trunk/mod/mod_deflate.html">\<br />
179 http://www.apache.org/docs/trunk/mod/mod_deflate.html</a>'
185 <div class="bottomlang">
186 <p><span>Available Languages: </span><a href="../en/mod/mod_info.html" title="English"> en </a> |
187 <a href="../fr/mod/mod_info.html" hreflang="fr" rel="alternate" title="Français"> fr </a> |
188 <a href="../ja/mod/mod_info.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
189 <a href="../ko/mod/mod_info.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
190 </div><div id="footer">
191 <p class="apache">Copyright 2010 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>
192 <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>