~ubuntu-branches/ubuntu/feisty/apache2/feisty

<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>

<p class="apache">Apache HTTP Server Version 2.2</p>

<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>

<div id="preamble"><h1>Apache Module mod_cgi</h1>

<p><span>Available Languages: </span><a href="../en/mod/mod_cgi.html" title="English"> en </a> |

<a href="../ja/mod/mod_cgi.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |

</div>

<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Execution of CGI scripts</td></tr>

<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>

<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>cgi_module</td></tr>

<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_cgi.c</td></tr></table>

<h3>Summary</h3>

<p>Any file that has the mime type

<code>application/x-httpd-cgi</code> or handler

<code>cgi-script</code> (Apache 1.1 or later) will be treated

as a CGI script, and run by the server, with its output being

returned to the client. Files acquire this type either by

having a name containing an extension defined by the

<code class="directive"><a href="../mod/mod_mime.html#addtype">AddType</a></code> directive, or by being

in a <code class="directive"><a href="../mod/mod_alias.html#scriptalias">ScriptAlias</a></code>

directory.</p>

<p>When the server invokes a CGI script, it will add a variable

called <code>DOCUMENT_ROOT</code> to the environment. This

variable will contain the value of the

<code class="directive"><a href="../mod/core.html#documentroot">DocumentRoot</a></code> configuration

variable.</p>

<p>For an introduction to using CGI scripts with Apache, see

our tutorial on <a href="../howto/cgi.html">Dynamic Content

With CGI</a>.</p>

<p>When using a multi-threaded MPM under unix, the module

<code class="module"><a href="../mod/mod_cgid.html">mod_cgid</a></code> should be used in place of

this module. At the user level, the two modules are essentially

identical.</p>

</div>

<div id="quickview"><h3 class="directives">Directives</h3>

<li><img alt="" src="../images/down.gif" /> <a href="#scriptlog">ScriptLog</a></li>

<li><img alt="" src="../images/down.gif" /> <a href="#scriptlogbuffer">ScriptLogBuffer</a></li>

<li><img alt="" src="../images/down.gif" /> <a href="#scriptloglength">ScriptLogLength</a></li>

</ul>

<h3>Topics</h3>

<li><img alt="" src="../images/down.gif" /> <a href="#env">CGI Environment variables</a></li>

<li><img alt="" src="../images/down.gif" /> <a href="#cgi-debug">CGI Debugging</a></li>

</ul><h3>See also</h3>

<li><code class="directive"><a href="../mod/core.html#acceptpathinfo">AcceptPathInfo</a></code></li>

<li><code class="directive"><a href="../mod/core.html#options">Options</a></code></li>

<li><code class="directive"><a href="../mod/mod_alias.html#scriptalias">ScriptAlias</a></code></li>

<li><code class="directive"><a href="../mod/mod_mime.html#addhandler">AddHandler</a></code></li>

<li><a href="../suexec.html">Running CGI programs under different

user IDs</a></li>

<li><a href="http://hoohoo.ncsa.uiuc.edu/cgi/">CGI Specification</a></li>

</ul></div>

<h2><a name="env" id="env">CGI Environment variables</a></h2>

<p>The server will set the CGI environment variables as described

in the <a href="http://hoohoo.ncsa.uiuc.edu/cgi/">CGI

specification</a>, with the following provisions:</p>

<dl>

<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

<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>

/more/path/info</code> following the script filename in the URI),

while the core server will return a 404 NOT FOUND error for requests

with additional path info. Omitting the <code class="directive">AcceptPathInfo</code> directive has the same effect as setting

it <code>On</code> for <code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code> requests.</dd>

<dt>REMOTE_HOST</dt>

100

<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

101

is off by default), and if a reverse DNS lookup of the accessing

102

host's address indeed finds a host name.</dd>

103

104

<dt>REMOTE_IDENT</dt>

105

106

<dd>This will only be set if <code class="directive"><a href="../mod/core.html#identitycheck">IdentityCheck</a></code> is set to

107

<code>on</code> and the accessing host supports the ident

108

protocol. Note that the contents of this variable cannot be

109

relied upon because it can easily be faked, and if there is a

110

proxy between the client and the server, it is usually

111

totally useless.</dd>

112

113

<dt>REMOTE_USER</dt>

114

115

<dd>This will only be set if the CGI script is subject to

116

authentication.</dd>

117

</dl>

118

</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>

119

120

<h2><a name="cgi-debug" id="cgi-debug">CGI Debugging</a></h2>

121

<p>Debugging CGI scripts has traditionally been difficult, mainly

122

because it has not been possible to study the output (standard

123

output and error) for scripts which are failing to run

124

properly. These directives, included in Apache 1.2 and later,

125

provide more detailed logging of errors when they occur.</p>

126

127

<h3>CGI Logfile Format</h3>

128

<p>When configured, the CGI error log logs any CGI which does not

129

execute properly. Each CGI script which fails to operate causes

130

several lines of information to be logged. The first two lines

131

are always of the format:</p>

132

133

134

%% [<var>time</var>] <var>request-line</var><br />

135

%% <var>HTTP-status</var> <var>CGI-script-filename</var>

136

</code></p></div>

137

138

<p>If the error is that CGI script cannot be run, the log file

139

will contain an extra two lines:</p>

140

141

142

%%error<br />

143

<var>error-message</var>

144

</code></p></div>

145

146

<p>Alternatively, if the error is the result of the script

147

returning incorrect header information (often due to a bug in

148

the script), the following information is logged:</p>

149

150

151

%request<br />

152

<var>All HTTP request headers received</var><br />

153

<var>POST or PUT entity (if any)</var><br />

154

%response<br />

155

<var>All headers output by the CGI script</var><br />

156

%stdout<br />

157

<var>CGI standard output</var><br />

158

%stderr<br />

159

<var>CGI standard error</var><br />

160

</code></p></div>

161

162

<p>(The %stdout and %stderr parts may be missing if the script did

163

not output anything on standard output or standard error).</p>

164

165

</div>

166

167

<div class="directive-section"><h2><a name="ScriptLog" id="ScriptLog">ScriptLog</a> <a name="scriptlog" id="scriptlog">Directive</a></h2>

168

169

<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Location of the CGI script error logfile</td></tr>

170

<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ScriptLog <var>file-path</var></code></td></tr>

171

<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>

172

<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>

173

<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>

174

</table>

175

<p>The <code class="directive">ScriptLog</code> directive sets the CGI

176

script error logfile. If no <code class="directive">ScriptLog</code> is given,

177

no error log is created. If given, any CGI errors are logged into the

178

filename given as argument. If this is a relative file or path it is

179

taken relative to the <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>.

180

</p>

181

182

<div class="example"><h3>Example</h3><p><code>

183

ScriptLog logs/cgi_log

184

</code></p></div>

185

186

<p>This log will be opened as the user the child processes run

187

as, <em>i.e.</em> the user specified in the main <code class="directive"><a href="../mod/mpm_common.html#user">User</a></code> directive. This means that

188

either the directory the script log is in needs to be writable

189

by that user or the file needs to be manually created and set

190

to be writable by that user. If you place the script log in

191

your main logs directory, do <strong>NOT</strong> change the

192

directory permissions to make it writable by the user the child

193

processes run as.</p>

194

195

<p>Note that script logging is meant to be a debugging feature

196

when writing CGI scripts, and is not meant to be activated

197

continuously on running servers. It is not optimized for speed

198

or efficiency, and may have security problems if used in a

199

manner other than that for which it was designed.</p>

200

201

</div>

202

203

<div class="directive-section"><h2><a name="ScriptLogBuffer" id="ScriptLogBuffer">ScriptLogBuffer</a> <a name="scriptlogbuffer" id="scriptlogbuffer">Directive</a></h2>

204

205

<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum amount of PUT or POST requests that will be recorded

206

in the scriptlog</td></tr>

207

<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ScriptLogBuffer <var>bytes</var></code></td></tr>

208

<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ScriptLogBuffer 1024</code></td></tr>

209

<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>

210

<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>

211

212

</table>

213

<p>The size of any PUT or POST entity body that is logged to

214

the file is limited, to prevent the log file growing too big

215

too quickly if large bodies are being received. By default, up

216

to 1024 bytes are logged, but this can be changed with this

217

directive.</p>

218

219

</div>

220

221

<div class="directive-section"><h2><a name="ScriptLogLength" id="ScriptLogLength">ScriptLogLength</a> <a name="scriptloglength" id="scriptloglength">Directive</a></h2>

222

223

<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Size limit of the CGI script logfile</td></tr>

224

<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ScriptLogLength <var>bytes</var></code></td></tr>

225

<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ScriptLogLength 10385760</code></td></tr>

226

<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>

227

<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>

228

229

</table>

230

<p><code class="directive">ScriptLogLength</code> can be used to limit the

231

size of the CGI script logfile. Since the logfile logs a lot of

232

information per CGI error (all request headers, all script output)

233

it can grow to be a big file. To prevent problems due to unbounded

234

growth, this directive can be used to set an maximum file-size for

235

the CGI logfile. If the file exceeds this size, no more

236

information will be written to it.</p>

237

238

</div>

239

</div>

240

241

<p><span>Available Languages: </span><a href="../en/mod/mod_cgi.html" title="English"> en </a> |

242

<a href="../ja/mod/mod_cgi.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |

243

244

</div><div id="footer">

245

246

247

</body></html>

b'\\ No newline at end of file'

Older »