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.2</p> 20<img alt="" src="/images/feather.gif" /></div> 21<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div> 22<div id="path"> 23<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.2</a> > <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"> en </a> | 28<a href="/ja/mod/mod_info.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | 29<a href="/ko/mod/mod_info.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p> 30</div> 31<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides a comprehensive overview of the server 32configuration</td></tr> 33<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr> 34<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>info_module</td></tr> 35<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_info.c</td></tr></table> 36<h3>Summary</h3> 37 38 <p>To configure <code class="module"><a href="/mod/mod_info.html">mod_info</a></code>, add the following to your 39 <code>httpd.conf</code> file.</p> 40 41 <div class="example"><p><code> 42 <Location /server-info><br /> 43 <span class="indent"> 44 SetHandler server-info<br /> 45 </span> 46 </Location> 47 </code></p></div> 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"><Location></a></code> 51 directive to limit access to your server configuration 52 information:</p> 53 54 <div class="example"><p><code> 55 <Location /server-info><br /> 56 <span class="indent"> 57 SetHandler server-info<br /> 58 Order deny,allow<br /> 59 Deny from all<br /> 60 Allow from yourcompany.com<br /> 61 </span> 62 </Location> 63 </code></p></div> 64 65 <p>Once configured, the server information is obtained by 66 accessing <code>http://your.host.example.com/server-info</code></p> 67</div> 68<div id="quickview"><h3 class="directives">Directives</h3> 69<ul id="toc"> 70<li><img alt="" src="/images/down.gif" /> <a href="#addmoduleinfo">AddModuleInfo</a></li> 71</ul> 72<h3>Topics</h3> 73<ul id="topics"> 74<li><img alt="" src="/images/down.gif" /> <a href="#security">Security Issues</a></li> 75<li><img alt="" src="/images/down.gif" /> <a href="#queries">Selecting the information shown</a></li> 76<li><img alt="" src="/images/down.gif" /> <a href="#limitations">Known Limitations</a></li> 77</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> 78<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 79<div class="section"> 80<h2><a name="security" id="security">Security Issues</a></h2> 81 <p>Once <code class="module"><a href="/mod/mod_info.html">mod_info</a></code> is loaded into the server, its 82 handler capability is available in <em>all</em> configuration 83 files, including per-directory files (<em>e.g.</em>, 84 <code>.htaccess</code>). This may have security-related 85 ramifications for your site.</p> 86 87 <p>In particular, this module can leak sensitive information 88 from the configuration directives of other Apache modules such as 89 system paths, usernames/passwords, database names, etc. Therefore, 90 this module should <strong>only</strong> be 91 used in a controlled environment and always with caution.</p> 92 93 <p>You will probably want to use <code class="module"><a href="/mod/mod_authz_host.html">mod_authz_host</a></code> 94 to limit access to your server configuration information.</p> 95 96 <div class="example"><h3>Access control</h3><p><code> 97 <Location /server-info><br /> 98 <span class="indent"> 99 SetHandler server-info<br /> 100 Order allow,deny<br /> 101 # Allow access from server itself<br /> 102 Allow from 127.0.0.1<br /> 103 # Additionally, allow access from local workstation<br /> 104 Allow from 192.168.1.17<br /> 105 </span> 106 </Location> 107 </code></p></div> 108</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 109<div class="section"> 110<h2><a name="queries" id="queries">Selecting the information shown</a></h2> 111 <p>By default, the server information includes a list of 112 all enabled modules, and for each module, a description of 113 the directives understood by that module, the hooks implemented 114 by that module, and the relevant directives from the current 115 configuration.</p> 116 117 <p>Other views of the configuration information are available by 118 appending a query to the <code>server-info</code> request. For 119 example, <code>http://your.host.example.com/server-info?config</code> 120 will show all configuration directives.</p> 121 122 <dl> 123 <dt><code>?<module-name></code></dt> 124 <dd>Only information relevant to the named module</dd> 125 <dt><code>?config</code></dt> 126 <dd>Just the configuration directives, not sorted by module</dd> 127 <dt><code>?hooks</code></dt> 128 <dd>Only the list of Hooks each module is attached to</dd> 129 <dt><code>?list</code></dt> 130 <dd>Only a simple list of enabled modules</dd> 131 <dt><code>?server</code></dt> 132 <dd>Only the basic server information</dd> 133 </dl> 134</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 135<div class="section"> 136<h2><a name="limitations" id="limitations">Known Limitations</a></h2> 137 <p><code class="module"><a href="/mod/mod_info.html">mod_info</a></code> provides its information by reading the 138 parsed configuration, rather than reading the original configuration 139 file. There are a few limitations as a result of the way the parsed 140 configuration tree is created:</p> 141 <ul> 142 <li>Directives which are executed immediately rather than being 143 stored in the parsed configuration are not listed. These include 144 <code class="directive"><a href="/mod/core.html#serverroot">ServerRoot</a></code>, 145 <code class="directive"><a href="/mod/mod_so.html#loadmodule">LoadModule</a></code>, and 146 <code class="directive"><a href="/mod/mod_so.html#loadfile">LoadFile</a></code>.</li> 147 <li>Directives which control the configuration file itself, such as 148 <code class="directive"><a href="/mod/core.html#include">Include</a></code>, 149 <code class="directive"><a href="/mod/core.html#<ifmodule>"><IfModule></a></code> and 150 <code class="directive"><a href="/mod/core.html#<ifdefine>"><IfDefine></a></code> are not 151 listed, but the included configuration directives are.</li> 152 <li>Comments are not listed. (This may be considered a feature.)</li> 153 <li>Configuration directives from <code>.htaccess</code> files are 154 not listed (since they do not form part of the permanent server 155 configuration).</li> 156 <li>Container directives such as 157 <code class="directive"><a href="/mod/core.html#<directory>"><Directory></a></code> 158 are listed normally, but <code class="module"><a href="/mod/mod_info.html">mod_info</a></code> cannot figure 159 out the line number for the closing 160 <code class="directive"><a href="/mod/core.html#</directory>"></Directory></a></code>.</li> 161 <li>Directives generated by third party modules such as 162 <a href="http://perl.apache.org">mod_perl</a> 163 might not be listed.</li> 164 </ul> 165</div> 166<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 167<div class="directive-section"><h2><a name="AddModuleInfo" id="AddModuleInfo">AddModuleInfo</a> <a name="addmoduleinfo" id="addmoduleinfo">Directive</a></h2> 168<table class="directive"> 169<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Adds additional information to the module 170information displayed by the server-info handler</td></tr> 171<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AddModuleInfo <var>module-name</var> <var>string</var></code></td></tr> 172<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr> 173<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr> 174<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_info</td></tr> 175<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Apache 1.3 and above</td></tr> 176</table> 177 <p>This allows the content of <var>string</var> to be shown as 178 HTML interpreted, <strong>Additional Information</strong> for 179 the module <var>module-name</var>. Example:</p> 180 181 <div class="example"><p><code> 182 AddModuleInfo mod_deflate.c 'See <a \<br /> 183 <span class="indent"> 184 href="http://www.apache.org/docs/2.2/mod/mod_deflate.html">\<br /> 185 http://www.apache.org/docs/2.2/mod/mod_deflate.html</a>;' 186 </span> 187 </code></p></div> 188 189</div> 190</div> 191<div class="bottomlang"> 192<p><span>Available Languages: </span><a href="/en/mod/mod_info.html" title="English"> en </a> | 193<a href="/ja/mod/mod_info.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | 194<a href="/ko/mod/mod_info.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p> 195</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&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> 196<script type="text/javascript"><!--//--><![CDATA[//><!-- 197var comments_shortname = 'httpd'; 198var comments_identifier = 'http://httpd.apache.org/docs/2.2/mod/mod_info.html'; 199(function(w, d) { 200 if (w.location.hostname.toLowerCase() == "httpd.apache.org") { 201 d.write('<div id="comments_thread"><\/div>'); 202 var s = d.createElement('script'); 203 s.type = 'text/javascript'; 204 s.async = true; 205 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; 206 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); 207 } 208 else { 209 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); 210 } 211})(window, document); 212//--><!]]></script></div><div id="footer"> 213<p class="apache">Copyright 2013 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> 214<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[//><!-- 215if (typeof(prettyPrint) !== 'undefined') { 216 prettyPrint(); 217} 218//--><!]]></script> 219</body></html>
