FCGIWRAP(8) System Manager's Manual FCGIWRAP(8)NAME
fcgiwrap - serve CGI applications over FastCGI
SYNOPSIS
fcgiwrap [OPTIONS]
DESCRIPTION
fcgiwrap is a simple server for running CGI applications over FastCGI. It hopes to provide clean CGI support to Nginx (and other web
servers that may need it).
OPTIONS -c number
Number of fcgiwrap processes to prefork.
-s socket_url
A URL for the listen socket to bind to. By default fcgiwrap expects a listen socket to be passed on file descriptor 0, matching the
FastCGI convention. The recommended way to deploy fcgiwrap is to run it under a process manager that takes care of opening the
socket. However, for simple configurations and one-off tests this option may be used. Valid socket_urls include
unix:/path/to/unix/socket, tcp:dot.ted.qu.ad:port and tcp6:[ipv6_addr]:port.
-h Show a help message and exit.
ENVIRONMENT
When running, fcgiwrap evaluates these environment variables set by the web server calling an fcgi-script. The variables DOCUMENT_ROOT and
SCRIPT_NAME will be concatenated and the resulting executable run as CGI script wrapped as FastCGI, with the remainder after the script
name available as PATH_INFO. To disable PATH_INFO mangling, set up your web server to pass SCRIPT_FILENAME, which should contain the com-
plete path to the script. Then PATH_INFO will not be modified.
DOCUMENT_ROOT
directory which the script resides in
SCRIPT_NAME
actual executable
SCRIPT_FILENAME
complete path to CGI script. When set, overrides DOCUMENT_ROOT and SCRIPT_NAME
EXAMPLE
The fastest way to see fcgiwrap do something is to launch it at the command line like this:
fcgiwrap -s unix:/var/run/fcgiwrap.sock
Apart from potential permission problems etc., it should be ready to accept FastCGI requests and run CGI scripts.
Most probably you will want to launch fcgiwrap by spawn-fcgi using a configuration like this:
FCGI_SOCKET=/var/run/fcgiwrap.sock
FCGI_PROGRAM=/usr/sbin/fcgiwrap
FCGI_USER=nginx
FCGI_GROUP=www
FCGI_EXTRA_OPTIONS="-M 0700"
ALLOWED_ENV="PATH"
Nginx can be configured to have the arbitrary CGI cgit run as FastCGI as follows:
location / {
fastcgi_param DOCUMENT_ROOT /var/www/localhost/htdocs/cgit/;
fastcgi_param SCRIPT_NAME cgit;
fastcgi_pass unix:/var/run/fastcgi.sock;
}
AUTHOR
fcgiwrap was written by Grzegorz Nosek <root@localdomain.pl> with contributions by W-Mark Kubacki <wmark@hurrikane.de>.
This manual page was written by Jordi Mallach <jordi@debian.org> (with contributions by Grzegorz Nosek) for the Debian project (and may be
used by others).
Jun 3, 2010 FCGIWRAP(8)
Check Out this Related Man Page
CGI::Fast(3) User Contributed Perl Documentation CGI::Fast(3)NAME
CGI::Fast - CGI Interface for Fast CGI
SYNOPSIS
use CGI::Fast qw(:standard);
$COUNTER = 0;
while (new CGI::Fast) {
print header;
print start_html("Fast CGI Rocks");
print
h1("Fast CGI Rocks"),
"Invocation number ",b($COUNTER++),
" PID ",b($$),".",
hr;
print end_html;
}
DESCRIPTION
CGI::Fast is a subclass of the CGI object created by CGI.pm. It is specialized to work well FCGI module, which greatly speeds up CGI
scripts by turning them into persistently running server processes. Scripts that perform time-consuming initialization processes, such as
loading large modules or opening persistent database connections, will see large performance improvements.
OTHER PIECES OF THE PUZZLE
In order to use CGI::Fast you'll need the FCGI module. See http://www.cpan.org/ for details.
WRITING FASTCGI PERL SCRIPTS
FastCGI scripts are persistent: one or more copies of the script are started up when the server initializes, and stay around until the
server exits or they die a natural death. After performing whatever one-time initialization it needs, the script enters a loop waiting for
incoming connections, processing the request, and waiting some more.
A typical FastCGI script will look like this:
#!/usr/bin/perl
use CGI::Fast;
&do_some_initialization();
while ($q = new CGI::Fast) {
&process_request($q);
}
Each time there's a new request, CGI::Fast returns a CGI object to your loop. The rest of the time your script waits in the call to new().
When the server requests that your script be terminated, new() will return undef. You can of course exit earlier if you choose. A new
version of the script will be respawned to take its place (this may be necessary in order to avoid Perl memory leaks in long-running
scripts).
CGI.pm's default CGI object mode also works. Just modify the loop this way:
while (new CGI::Fast) {
&process_request;
}
Calls to header(), start_form(), etc. will all operate on the current request.
INSTALLING FASTCGI SCRIPTS
See the FastCGI developer's kit documentation for full details. On the Apache server, the following line must be added to srm.conf:
AddType application/x-httpd-fcgi .fcgi
FastCGI scripts must end in the extension .fcgi. For each script you install, you must add something like the following to srm.conf:
FastCgiServer /usr/etc/httpd/fcgi-bin/file_upload.fcgi -processes 2
This instructs Apache to launch two copies of file_upload.fcgi at startup time.
USING FASTCGI SCRIPTS AS CGI SCRIPTS
Any script that works correctly as a FastCGI script will also work correctly when installed as a vanilla CGI script. However it will not
see any performance benefit.
EXTERNAL FASTCGI SERVER INVOCATION
FastCGI supports a TCP/IP transport mechanism which allows FastCGI scripts to run external to the webserver, perhaps on a remote machine.
To configure the webserver to connect to an external FastCGI server, you would add the following to your srm.conf:
FastCgiExternalServer /usr/etc/httpd/fcgi-bin/file_upload.fcgi -host sputnik:8888
Two environment variables affect how the "CGI::Fast" object is created, allowing "CGI::Fast" to be used as an external FastCGI server.
(See "FCGI" documentation for "FCGI::OpenSocket" for more information.)
FCGI_SOCKET_PATH
The address (TCP/IP) or path (UNIX Domain) of the socket the external FastCGI script to which bind an listen for incoming connections
from the web server.
FCGI_LISTEN_QUEUE
Maximum length of the queue of pending connections.
For example:
#!/usr/local/bin/perl # must be a FastCGI version of perl!
use CGI::Fast;
&do_some_initialization();
$ENV{FCGI_SOCKET_PATH} = "sputnik:8888";
$ENV{FCGI_LISTEN_QUEUE} = 100;
while ($q = new CGI::Fast) {
&process_request($q);
}
CAVEATS
I haven't tested this very much.
AUTHOR INFORMATION
Copyright 1996-1998, Lincoln D. Stein. All rights reserved.
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Address bug reports and comments to: lstein@cshl.org
BUGS
This section intentionally left blank.
SEE ALSO
CGI::Carp, CGI
perl v5.16.3 2011-11-09 CGI::Fast(3)