mod_cgid.html.en revision 564ee5b847469eb8a61120179ce70a0213965785
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose This file is generated from xml source: DO NOT EDIT
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<title>mod_cgid - Apache HTTP Server Version 2.5</title>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<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" />
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<script src="/style/scripts/prettify.min.js" type="text/javascript">
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<link href="/images/favicon.ico" rel="shortcut icon" /></head>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<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>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<p class="apache">Apache HTTP Server Version 2.5</p>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<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.5</a> > <a href="./">Modules</a></div>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<div id="preamble"><h1>Apache Module mod_cgid</h1>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<p><span>Available Languages: </span><a href="/en/mod/mod_cgid.html" title="English"> en </a> |
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<a href="/fr/mod/mod_cgid.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a> |
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<a href="/ja/mod/mod_cgid.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<a href="/ko/mod/mod_cgid.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Execution of CGI scripts using an
ff6e24f4474cca6226cd44c47ba2ec6ba6cf9a16Sumit Bose<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>cgid_module</td></tr>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_cgid.c</td></tr>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Unix threaded MPMs only</td></tr></table>
ff6e24f4474cca6226cd44c47ba2ec6ba6cf9a16Sumit Bose <p>Except for the optimizations and the additional <code class="directive"><a href="#scriptsock">ScriptSock</a></code> directive noted below,
ff6e24f4474cca6226cd44c47ba2ec6ba6cf9a16Sumit Bose <code class="module"><a href="/mod/mod_cgid.html">mod_cgid</a></code> behaves similarly to <code class="module"><a href="/mod/mod_cgi.html">mod_cgi</a></code>.
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose <strong>See the <code class="module"><a href="/mod/mod_cgi.html">mod_cgi</a></code> summary for additional details
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose <p>On certain unix operating systems, forking a process from a
9d17f436795a36b1b1126f444923aa847fd0f93aPavel Reichl multi-threaded server is a very expensive operation because the
9d17f436795a36b1b1126f444923aa847fd0f93aPavel Reichl new process will replicate all the threads of the parent
9d17f436795a36b1b1126f444923aa847fd0f93aPavel Reichl process. In order to avoid incurring this expense on each CGI
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose invocation, <code class="module"><a href="/mod/mod_cgid.html">mod_cgid</a></code> creates an external daemon that is
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose responsible for forking child processes to run CGI scripts. The
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose main server communicates with this daemon using a unix domain
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose <p>This module is used by default instead of
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose <code class="module"><a href="/mod/mod_cgi.html">mod_cgi</a></code> whenever a multi-threaded MPM
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose is selected during the compilation process. At the user level,
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose this module is identical in configuration and operation to
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose <code class="module"><a href="/mod/mod_cgi.html">mod_cgi</a></code>. The only exception is the
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose additional directive <code>ScriptSock</code> which gives the
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose name of the socket to use for communication with the cgi
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<div id="quickview"><h3 class="directives">Directives</h3>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<li><img alt="" src="/images/down.gif" /> <a href="#cgidscripttimeout">CGIDScriptTimeout</a></li>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<li><img alt="" src="/images/right.gif" /> <a href="mod_cgi.html#scriptlog">ScriptLog</a></li>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<li><img alt="" src="/images/right.gif" /> <a href="mod_cgi.html#scriptlogbuffer">ScriptLogBuffer</a></li>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<li><img alt="" src="/images/right.gif" /> <a href="mod_cgi.html#scriptloglength">ScriptLogLength</a></li>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<li><img alt="" src="/images/down.gif" /> <a href="#scriptsock">ScriptSock</a></li>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<li><code class="module"><a href="/mod/mod_cgi.html">mod_cgi</a></code></li>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<li><a href="/suexec.html">Running CGI programs under different
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<div class="directive-section"><h2><a name="CGIDScriptTimeout" id="CGIDScriptTimeout">CGIDScriptTimeout</a> <a name="cgidscripttimeout" id="cgidscripttimeout">Directive</a></h2>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The length of time to wait for more output from the
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CGIDScriptTimeout <var>time</var>[s|ms]</code></td></tr>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>value of <code class="directive"><a href="/mod/core.html#timeout">Timeout</a></code> directive when
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
4e5e846de22407f825fe3b4040d79606818a2419Jakub Hrozek<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cgid</td></tr>
8babbeee01e67893af4828ddfc922ecac0be4197Pavel Reichl<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>CGIDScriptTimeout defaults to zero in releases 2.4 and earlier
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose <p>This directive limits the length of time to wait for more output from
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose the CGI program. If the time is exceeded, the request and CGI are
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose terminated.</p>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">CGIDScriptTimeout 20</pre>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<div class="directive-section"><h2><a name="ScriptSock" id="ScriptSock">ScriptSock</a> <a name="scriptsock" id="scriptsock">Directive</a></h2>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The filename prefix of the socket to use for communication with
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ScriptSock <var>file-path</var></code></td></tr>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ScriptSock cgisock</code></td></tr>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
8babbeee01e67893af4828ddfc922ecac0be4197Pavel Reichl<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cgid</td></tr>
8babbeee01e67893af4828ddfc922ecac0be4197Pavel Reichl <p>This directive sets the filename prefix of the socket to use for
8babbeee01e67893af4828ddfc922ecac0be4197Pavel Reichl communication with the CGI daemon, an extension corresponding to
8babbeee01e67893af4828ddfc922ecac0be4197Pavel Reichl the process ID of the server will be appended. The socket will be opened
8babbeee01e67893af4828ddfc922ecac0be4197Pavel Reichl using the permissions of the user who starts Apache (usually
8babbeee01e67893af4828ddfc922ecac0be4197Pavel Reichl root). To maintain the security of communications with CGI
8babbeee01e67893af4828ddfc922ecac0be4197Pavel Reichl scripts, it is important that no other user has permission to
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose write in the directory where the socket is located.</p>
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose <p>If <var>file-path</var> is not an absolute path, the location specified
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose will be relative to the value of
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose <code class="directive"><a href="/mod/core.html#defaultruntimedir">DefaultRuntimeDir</a></code>.</p>
8babbeee01e67893af4828ddfc922ecac0be4197Pavel Reichl <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">ScriptSock /var/run/cgid.sock</pre>
4e5e846de22407f825fe3b4040d79606818a2419Jakub Hrozek<p><span>Available Languages: </span><a href="/en/mod/mod_cgid.html" title="English"> en </a> |
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<a href="/fr/mod/mod_cgid.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a> |
d064fef06dcbcb5f6c1be03e286b1a3433d6dfd7Sumit Bose<a href="/ja/mod/mod_cgid.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
9d17f436795a36b1b1126f444923aa847fd0f93aPavel Reichl<a href="/ko/mod/mod_cgid.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
9d17f436795a36b1b1126f444923aa847fd0f93aPavel Reichl</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>
9d17f436795a36b1b1126f444923aa847fd0f93aPavel Reichl<script type="text/javascript"><!--//--><![CDATA[//><!--
9d17f436795a36b1b1126f444923aa847fd0f93aPavel Reichlvar comments_shortname = 'httpd';
9d17f436795a36b1b1126f444923aa847fd0f93aPavel Reichlvar comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_cgid.html';
9d17f436795a36b1b1126f444923aa847fd0f93aPavel Reichl(function(w, d) {
9d17f436795a36b1b1126f444923aa847fd0f93aPavel Reichl if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
9d17f436795a36b1b1126f444923aa847fd0f93aPavel Reichl d.write('<div id="comments_thread"><\/div>');
9d17f436795a36b1b1126f444923aa847fd0f93aPavel Reichl var s = d.createElement('script');
9d17f436795a36b1b1126f444923aa847fd0f93aPavel Reichl s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
9d17f436795a36b1b1126f444923aa847fd0f93aPavel Reichl (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
9d17f436795a36b1b1126f444923aa847fd0f93aPavel Reichl d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
9d17f436795a36b1b1126f444923aa847fd0f93aPavel Reichl})(window, document);
9d17f436795a36b1b1126f444923aa847fd0f93aPavel Reichl<p class="apache">Copyright 2015 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>
9d17f436795a36b1b1126f444923aa847fd0f93aPavel Reichl<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[//><!--
9d17f436795a36b1b1126f444923aa847fd0f93aPavel Reichlif (typeof(prettyPrint) !== 'undefined') {
9d17f436795a36b1b1126f444923aa847fd0f93aPavel Reichl prettyPrint();