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