granicus.if.org Git - apache/blob - docs/manual/mod/mod_cgi.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_cgi - 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/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>
  19 <p class="apache">Apache HTTP Server Version 2.5</p>
  20 <img alt="" src="../images/feather.gif" /></div>
  21 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  22 <div id="path">
  23 <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>
  24 <div id="page-content">
  25 <div id="preamble"><h1>Apache Module mod_cgi</h1>
  26 <div class="toplang">
  27 <p><span>Available Languages: </span><a href="../en/mod/mod_cgi.html" title="English">&nbsp;en&nbsp;</a> |
  28 <a href="../ja/mod/mod_cgi.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
  29 <a href="../ko/mod/mod_cgi.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
  30 </div>
  31 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Execution of CGI scripts</td></tr>
  32 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
  33 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>cgi_module</td></tr>
  34 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_cgi.c</td></tr></table>
  35 <h3>Summary</h3>
  36
  37     <p>Any file that has the handler
  38     <code>cgi-script</code> will be treated
  39     as a CGI script, and run by the server, with its output being
  40     returned to the client. Files acquire this handler either by
  41     having a name containing an extension defined by the
  42     <code class="directive"><a href="../mod/mod_mime.html#addhandler">AddHandler</a></code> directive, or by being
  43     in a <code class="directive"><a href="../mod/mod_alias.html#scriptalias">ScriptAlias</a></code>
  44     directory.</p>
  45
  46     <p>For an introduction to using CGI scripts with Apache, see
  47     our tutorial on <a href="../howto/cgi.html">Dynamic Content
  48     With CGI</a>.</p>
  49
  50     <p>When using a multi-threaded MPM under unix, the module
  51     <code class="module"><a href="../mod/mod_cgid.html">mod_cgid</a></code> should be used in place of
  52     this module. At the user level, the two modules are essentially
  53     identical.</p>
  54
  55     <p>For backward-compatibility, the cgi-script handler will also be activated
  56     for any file with the mime-type <code>application/x-httpd-cgi</code>. The
  57     use of the magic mime-type is deprecated.</p>
  58 </div>
  59 <div id="quickview"><h3 class="directives">Directives</h3>
  60 <ul id="toc">
  61 <li><img alt="" src="../images/down.gif" /> <a href="#scriptlog">ScriptLog</a></li>
  62 <li><img alt="" src="../images/down.gif" /> <a href="#scriptlogbuffer">ScriptLogBuffer</a></li>
  63 <li><img alt="" src="../images/down.gif" /> <a href="#scriptloglength">ScriptLogLength</a></li>
  64 </ul>
  65 <h3>Topics</h3>
  66 <ul id="topics">
  67 <li><img alt="" src="../images/down.gif" /> <a href="#env">CGI Environment variables</a></li>
  68 <li><img alt="" src="../images/down.gif" /> <a href="#cgi-debug">CGI Debugging</a></li>
  69 </ul><h3>See also</h3>
  70 <ul class="seealso">
  71 <li><code class="directive"><a href="../mod/core.html#acceptpathinfo">AcceptPathInfo</a></code></li>
  72 <li><code class="directive"><a href="../mod/core.html#options">Options</a></code> ExecCGI</li>
  73 <li><code class="directive"><a href="../mod/mod_alias.html#scriptalias">ScriptAlias</a></code></li>
  74 <li><code class="directive"><a href="../mod/mod_mime.html#addhandler">AddHandler</a></code></li>
  75 <li><a href="../suexec.html">Running CGI programs under different
  76     user IDs</a></li>
  77 <li><a href="http://www.ietf.org/rfc/rfc3875">CGI Specification</a></li>
  78 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  79 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  80 <div class="section">
  81 <h2><a name="env" id="env">CGI Environment variables</a></h2>
  82     <p>The server will set the CGI environment variables as described
  83     in the <a href="http://www.ietf.org/rfc/rfc3875">CGI specification</a>,
  84     with the following provisions:</p>
  85
  86     <dl>
  87       <dt>PATH_INFO</dt>
  88
  89       <dd>This will not be available if the <code class="directive"><a href="../mod/core.html#acceptpathinfo">AcceptPathInfo</a></code> directive is explicitly set to
  90       <code>off</code>.  The default behavior, if <code class="directive">AcceptPathInfo</code> is not given, is that <code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code> will accept path info (trailing <code>
  91       /more/path/info</code> following the script filename in the URI),
  92       while the core server will return a 404 NOT FOUND error for requests
  93       with additional path info. Omitting the <code class="directive">AcceptPathInfo</code> directive has the same effect as setting
  94       it <code>On</code> for <code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code> requests.</dd>
  95
  96       <dt>REMOTE_HOST</dt>
  97
  98       <dd>This will only be set if <code class="directive"><a href="../mod/core.html#hostnamelookups">HostnameLookups</a></code> is set to <code>on</code> (it
  99       is off by default), and if a reverse DNS lookup of the accessing
 100       host's address indeed finds a host name.</dd>
 101
 102       <dt>REMOTE_IDENT</dt>
 103
 104       <dd>This will only be set if <code class="directive"><a href="../mod/mod_ident.html#identitycheck">IdentityCheck</a></code> is set to
 105       <code>on</code> and the accessing host supports the ident
 106       protocol. Note that the contents of this variable cannot be
 107       relied upon because it can easily be faked, and if there is a
 108       proxy between the client and the server, it is usually
 109       totally useless.</dd>
 110
 111       <dt>REMOTE_USER</dt>
 112
 113       <dd>This will only be set if the CGI script is subject to
 114       authentication.</dd>
 115     </dl>
 116 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 117 <div class="section">
 118 <h2><a name="cgi-debug" id="cgi-debug">CGI Debugging</a></h2>
 119     <p>Debugging CGI scripts has traditionally been difficult, mainly
 120     because it has not been possible to study the output (standard
 121     output and error) for scripts which are failing to run
 122     properly. These directives provide more detailed logging of errors
 123     when they occur.</p>
 124
 125     <h3>CGI Logfile Format</h3>
 126       <p>When configured, the CGI error log logs any CGI which does not
 127       execute properly. Each CGI script which fails to operate causes
 128       several lines of information to be logged. The first two lines
 129       are always of the format:</p>
 130
 131       <div class="example"><p><code>
 132         %% [<var>time</var>] <var>request-line</var><br />
 133         %% <var>HTTP-status</var> <var>CGI-script-filename</var>
 134       </code></p></div>
 135
 136       <p>If the error is that CGI script cannot be run, the log file
 137       will contain an extra two lines:</p>
 138
 139       <div class="example"><p><code>
 140         %%error<br />
 141         <var>error-message</var>
 142       </code></p></div>
 143
 144       <p>Alternatively, if the error is the result of the script
 145       returning incorrect header information (often due to a bug in
 146       the script), the following information is logged:</p>
 147
 148       <div class="example"><p><code>
 149         %request<br />
 150         <var>All HTTP request headers received</var><br />
 151         <var>POST or PUT entity (if any)</var><br />
 152         %response<br />
 153         <var>All headers output by the CGI script</var><br />
 154         %stdout<br />
 155         <var>CGI standard output</var><br />
 156         %stderr<br />
 157         <var>CGI standard error</var><br />
 158       </code></p></div>
 159
 160       <p>(The %stdout and %stderr parts may be missing if the script did
 161       not output anything on standard output or standard error).</p>
 162
 163 </div>
 164 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 165 <div class="directive-section"><h2><a name="ScriptLog" id="ScriptLog">ScriptLog</a> <a name="scriptlog" id="scriptlog">Directive</a></h2>
 166 <table class="directive">
 167 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Location of the CGI script error logfile</td></tr>
 168 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ScriptLog <var>file-path</var></code></td></tr>
 169 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 170 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 171 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code>, <code class="module"><a href="../mod/mod_cgid.html">mod_cgid</a></code></td></tr>
 172 </table>
 173     <p>The <code class="directive">ScriptLog</code> directive sets the CGI
 174     script error logfile. If no <code class="directive">ScriptLog</code> is given,
 175     no error log is created. If given, any CGI errors are logged into the
 176     filename given as argument. If this is a relative file or path it is
 177     taken relative to the <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>.
 178     </p>
 179
 180     <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">
 181       ScriptLog logs/cgi_log
 182     </pre>
 183 </div>
 184
 185     <p>This log will be opened as the user the child processes run
 186     as, <em>i.e.</em> the user specified in the main <code class="directive"><a href="../mod/mod_unixd.html#user">User</a></code> directive. This means that
 187     either the directory the script log is in needs to be writable
 188     by that user or the file needs to be manually created and set
 189     to be writable by that user. If you place the script log in
 190     your main logs directory, do <strong>NOT</strong> change the
 191     directory permissions to make it writable by the user the child
 192     processes run as.</p>
 193
 194     <p>Note that script logging is meant to be a debugging feature
 195     when writing CGI scripts, and is not meant to be activated
 196     continuously on running servers. It is not optimized for speed
 197     or efficiency, and may have security problems if used in a
 198     manner other than that for which it was designed.</p>
 199
 200 </div>
 201 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 202 <div class="directive-section"><h2><a name="ScriptLogBuffer" id="ScriptLogBuffer">ScriptLogBuffer</a> <a name="scriptlogbuffer" id="scriptlogbuffer">Directive</a></h2>
 203 <table class="directive">
 204 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum amount of PUT or POST requests that will be recorded
 205 in the scriptlog</td></tr>
 206 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ScriptLogBuffer <var>bytes</var></code></td></tr>
 207 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ScriptLogBuffer 1024</code></td></tr>
 208 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 209 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 210 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code>, <code class="module"><a href="../mod/mod_cgid.html">mod_cgid</a></code></td></tr>
 211 </table>
 212     <p>The size of any PUT or POST entity body that is logged to
 213     the file is limited, to prevent the log file growing too big
 214     too quickly if large bodies are being received. By default, up
 215     to 1024 bytes are logged, but this can be changed with this
 216     directive.</p>
 217
 218 </div>
 219 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 220 <div class="directive-section"><h2><a name="ScriptLogLength" id="ScriptLogLength">ScriptLogLength</a> <a name="scriptloglength" id="scriptloglength">Directive</a></h2>
 221 <table class="directive">
 222 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Size limit of the CGI script logfile</td></tr>
 223 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ScriptLogLength <var>bytes</var></code></td></tr>
 224 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ScriptLogLength 10385760</code></td></tr>
 225 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 226 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 227 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code>, <code class="module"><a href="../mod/mod_cgid.html">mod_cgid</a></code></td></tr>
 228 </table>
 229     <p><code class="directive">ScriptLogLength</code> can be used to limit the
 230     size of the CGI script logfile. Since the logfile logs a lot of
 231     information per CGI error (all request headers, all script output)
 232     it can grow to be a big file. To prevent problems due to unbounded
 233     growth, this directive can be used to set an maximum file-size for
 234     the CGI logfile. If the file exceeds this size, no more
 235     information will be written to it.</p>
 236
 237 </div>
 238 </div>
 239 <div class="bottomlang">
 240 <p><span>Available Languages: </span><a href="../en/mod/mod_cgi.html" title="English">&nbsp;en&nbsp;</a> |
 241 <a href="../ja/mod/mod_cgi.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 242 <a href="../ko/mod/mod_cgi.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 243 </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>
 244 <script type="text/javascript"><!--//--><![CDATA[//><!--
 245 var comments_shortname = 'httpd';
 246 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_cgi.html';
 247 (function(w, d) {
 248     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 249         d.write('<div id="comments_thread"><\/div>');
 250         var s = d.createElement('script');
 251         s.type = 'text/javascript';
 252         s.async = true;
 253         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 254         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 255     }
 256     else {
 257         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 258     }
 259 })(window, document);
 260 //--><!]]></script></div><div id="footer">
 261 <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>
 262 <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[//><!--
 263 if (typeof(prettyPrint) !== 'undefined') {
 264     prettyPrint();
 265 }
 266 //--><!]]></script>
 267 </body></html>