granicus.if.org Git - apache/blob - docs/manual/mod/mod_cgid.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 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
   5 <!--
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7               This file is generated from xml source: DO NOT EDIT
   8         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   9       -->
  10 <title>mod_cgid - Apache HTTP Server Version 2.5</title>
  11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  13 <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" />
  14 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  15 </script>
  16
  17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  18 <body>
  19 <div id="page-header">
  20 <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>
  21 <p class="apache">Apache HTTP Server Version 2.5</p>
  22 <img alt="" src="../images/feather.png" /></div>
  23 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  24 <div id="path">
  25 <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>
  26 <div id="page-content">
  27 <div id="preamble"><h1>Apache Module mod_cgid</h1>
  28 <div class="toplang">
  29 <p><span>Available Languages: </span><a href="../en/mod/mod_cgid.html" title="English">&nbsp;en&nbsp;</a> |
  30 <a href="../fr/mod/mod_cgid.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
  31 <a href="../ja/mod/mod_cgid.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
  32 <a href="../ko/mod/mod_cgid.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
  33 </div>
  34 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Execution of CGI scripts using an
  35     external CGI daemon</td></tr>
  36 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
  37 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>cgid_module</td></tr>
  38 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_cgid.c</td></tr>
  39 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Unix threaded MPMs only</td></tr></table>
  40 <h3>Summary</h3>
  41
  42     <p>Except for the optimizations and the additional <code class="directive"><a href="#scriptsock">ScriptSock</a></code> directive noted below,
  43     <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>.
  44     <strong>See the <code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code> summary for additional details
  45     about Apache and CGI.</strong></p>
  46
  47     <p>On certain unix operating systems, forking a process from a
  48     multi-threaded server is a very expensive operation because the
  49     new process will replicate all the threads of the parent
  50     process. In order to avoid incurring this expense on each CGI
  51     invocation, <code class="module"><a href="../mod/mod_cgid.html">mod_cgid</a></code> creates an external daemon that is
  52     responsible for forking child processes to run CGI scripts. The
  53     main server communicates with this daemon using a unix domain
  54     socket.</p>
  55
  56     <p>This module is used by default instead of
  57     <code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code> whenever a multi-threaded MPM
  58     is selected during the compilation process. At the user level,
  59     this module is identical in configuration and operation to
  60     <code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code>. The only exception is the
  61     additional directive <code>ScriptSock</code> which gives the
  62     name of the socket to use for communication with the cgi
  63     daemon.</p>
  64 </div>
  65 <div id="quickview"><h3 class="directives">Directives</h3>
  66 <ul id="toc">
  67 <li><img alt="" src="../images/down.gif" /> <a href="#cgidscripttimeout">CGIDScriptTimeout</a></li>
  68 <li><img alt="" src="../images/right.gif" /> <a href="mod_cgi.html#scriptlog">ScriptLog</a></li>
  69 <li><img alt="" src="../images/right.gif" /> <a href="mod_cgi.html#scriptlogbuffer">ScriptLogBuffer</a></li>
  70 <li><img alt="" src="../images/right.gif" /> <a href="mod_cgi.html#scriptloglength">ScriptLogLength</a></li>
  71 <li><img alt="" src="../images/down.gif" /> <a href="#scriptsock">ScriptSock</a></li>
  72 </ul>
  73 <h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&amp;list_id=144532&amp;product=Apache%20httpd-2&amp;query_format=specific&amp;order=changeddate%20DESC%2Cpriority%2Cbug_severity&amp;component=mod_cgid">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component=mod_cgid">Report a bug</a></li></ul><h3>See also</h3>
  74 <ul class="seealso">
  75 <li><code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code></li>
  76 <li><a href="../suexec.html">Running CGI programs under different
  77     user IDs</a></li>
  78 <li><a href="#comments_section">Comments</a></li></ul></div>
  79
  80 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  81 <div class="directive-section"><h2><a name="CGIDScriptTimeout" id="CGIDScriptTimeout">CGIDScriptTimeout</a> <a name="cgidscripttimeout" id="cgidscripttimeout">Directive</a> <a title="Permanent link" href="#cgidscripttimeout" class="permalink">&para;</a></h2>
  82 <table class="directive">
  83 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The length of time to wait for more output from the
  84 CGI program</td></tr>
  85 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CGIDScriptTimeout <var>time</var>[s|ms]</code></td></tr>
  86 <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
  87 unset</code></td></tr>
  88 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
  89 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
  90 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cgid</td></tr>
  91 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>CGIDScriptTimeout defaults to zero in releases 2.4 and earlier
  92 </td></tr>
  93 </table>
  94     <p>This directive limits the length of time to wait for more output from
  95     the CGI program.  If the time is exceeded, the request and CGI are
  96     terminated.</p>
  97
  98     <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">CGIDScriptTimeout 20</pre>
  99 </div>
 100
 101
 102 </div>
 103 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 104 <div class="directive-section"><h2><a name="ScriptSock" id="ScriptSock">ScriptSock</a> <a name="scriptsock" id="scriptsock">Directive</a> <a title="Permanent link" href="#scriptsock" class="permalink">&para;</a></h2>
 105 <table class="directive">
 106 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The filename prefix of the socket to use for communication with
 107 the cgi daemon</td></tr>
 108 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ScriptSock <var>file-path</var></code></td></tr>
 109 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ScriptSock cgisock</code></td></tr>
 110 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 111 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 112 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cgid</td></tr>
 113 </table>
 114     <p>This directive sets the filename prefix of the socket to use for
 115     communication with the CGI daemon, an extension corresponding to
 116     the process ID of the server will be appended. The socket will be opened
 117     using the permissions of the user who starts Apache (usually
 118     root). To maintain the security of communications with CGI
 119     scripts, it is important that no other user has permission to
 120     write in the directory where the socket is located.</p>
 121
 122     <p>If <var>file-path</var> is not an absolute path, the location specified
 123     will be relative to the value of
 124     <code class="directive"><a href="../mod/core.html#defaultruntimedir">DefaultRuntimeDir</a></code>.</p>
 125
 126     <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">ScriptSock /var/run/cgid.sock</pre>
 127 </div>
 128
 129
 130 </div>
 131 </div>
 132 <div class="bottomlang">
 133 <p><span>Available Languages: </span><a href="../en/mod/mod_cgid.html" title="English">&nbsp;en&nbsp;</a> |
 134 <a href="../fr/mod/mod_cgid.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
 135 <a href="../ja/mod/mod_cgid.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 136 <a href="../ko/mod/mod_cgid.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 137 </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>
 138 <script type="text/javascript"><!--//--><![CDATA[//><!--
 139 var comments_shortname = 'httpd';
 140 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_cgid.html';
 141 (function(w, d) {
 142     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 143         d.write('<div id="comments_thread"><\/div>');
 144         var s = d.createElement('script');
 145         s.type = 'text/javascript';
 146         s.async = true;
 147         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 148         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 149     }
 150     else {
 151         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 152     }
 153 })(window, document);
 154 //--><!]]></script></div><div id="footer">
 155 <p class="apache">Copyright 2019 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>
 156 <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[//><!--
 157 if (typeof(prettyPrint) !== 'undefined') {
 158     prettyPrint();
 159 }
 160 //--><!]]></script>
 161 </body></html>