granicus.if.org Git - apache/blob - docs/manual/mod/mod_cgid.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
   3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
   4
   5 <!--
   6  Copyright 2002-2004 The Apache Software Foundation
   7
   8  Licensed under the Apache License, Version 2.0 (the "License");
   9  you may not use this file except in compliance with the License.
  10  You may obtain a copy of the License at
  11
  12      http://www.apache.org/licenses/LICENSE-2.0
  13
  14  Unless required by applicable law or agreed to in writing, software
  15  distributed under the License is distributed on an "AS IS" BASIS,
  16  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  See the License for the specific language governing permissions and
  18  limitations under the License.
  19 -->
  20
  21 <modulesynopsis metafile="mod_cgid.xml.meta">
  22
  23 <name>mod_cgid</name>
  24 <description>Execution of CGI scripts using an
  25     external CGI daemon</description>
  26 <status>Base</status>
  27 <sourcefile>mod_cgid.c</sourcefile>
  28 <identifier>cgid_module</identifier>
  29 <compatibility>Unix threaded MPMs only</compatibility>
  30
  31 <summary>
  32     <p>Except for the optimizations and the additional <directive
  33     module="mod_cgid">ScriptSock</directive> directive noted below,
  34     <module>mod_cgid</module> behaves similarly to <module>mod_cgi</module>.
  35     <strong>See the <module>mod_cgi</module> summary for additional details
  36     about Apache and CGI.</strong></p>
  37
  38     <p>On certain unix operating systems, forking a process from a
  39     multi-threaded server is a very expensive operation because the
  40     new process will replicate all the threads of the parent
  41     process. In order to avoid incurring this expense on each CGI
  42     invocation, <module>mod_cgid</module> creates an external daemon that is
  43     responsible for forking child processes to run CGI scripts. The
  44     main server communicates with this daemon using a unix domain
  45     socket.</p>
  46
  47     <p>This module is used by default instead of
  48     <module>mod_cgi</module> whenever a multi-threaded MPM
  49     is selected during the compilation process. At the user level,
  50     this module is identical in configuration and operation to
  51     <module>mod_cgi</module>. The only exception is the
  52     additional directive <code>ScriptSock</code> which gives the
  53     name of the socket to use for communication with the cgi
  54     daemon.</p>
  55 </summary>
  56
  57 <seealso><module>mod_cgi</module></seealso>
  58 <seealso><a href="../suexec.html">Running CGI programs under different user IDs</a></seealso>
  59
  60 <directivesynopsis location="mod_cgi">
  61 <name>ScriptLog</name>
  62 </directivesynopsis>
  63
  64 <directivesynopsis location="mod_cgi">
  65 <name>ScriptLogLength</name>
  66 </directivesynopsis>
  67
  68 <directivesynopsis location="mod_cgi">
  69 <name>ScriptLogBuffer</name>
  70 </directivesynopsis>
  71
  72 <directivesynopsis>
  73 <name>ScriptSock</name>
  74 <description>The name of the socket to use for communication with
  75 the cgi daemon</description>
  76 <syntax>ScriptSock <var>file-path</var></syntax>
  77 <default>ScriptSock logs/cgisock</default>
  78 <contextlist><context>server config</context>
  79 <context>virtual host</context></contextlist>
  80
  81 <usage>
  82     <p>This directive sets the name of the socket to use for
  83     communication with the CGI daemon. The socket will be opened
  84     using the permissions of the user who starts Apache (usually
  85     root). To maintain the security of communications with CGI
  86     scripts, it is important that no other user has permission to
  87     write in the directory where the socket is located.</p>
  88
  89     <example><title>Example</title>
  90       ScriptSock /var/run/cgid.sock
  91     </example>
  92
  93 </usage>
  94 </directivesynopsis>
  95
  96 </modulesynopsis>
  97