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