README

1 files changed, 41 insertions, 0 deletions

diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..c417be7
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,41 @@
+========
+fcgiwrap
+========
+:Info:		Simple FastCGI wrapper for CGI scripts
+:Homepage:	http://nginx.localdomain.pl/wiki/FcgiWrap
+:Author:	Grzegorz Nosek <root@localdomain.pl>
+
+Features
+========
+ - very lightweight (84KB of private memory per instance)
+ - fixes broken CR/LF in headers
+ - handles environment in a sane way (CGI scripts get HTTP-related env. vars from FastCGI parameters and inherit all the others from ``fcgiwrap``'s environment)
+ - no configuration, so you can run several sites off the same ``fcgiwrap`` pool
+ - passes CGI stderr output to ``fcgiwrap``'s stderr (this is by design but stderr could be also passed to FastCGI stderr stream)
+
+Installation
+============
+
+requirements
+------------
+``Makefile`` and ``configure`` script is generated by GNU *autotools*. Therefore you need the latter.
+
+``fcgiwrap`` links to *dev-libs/fcgi* which can be obtained from http://www.fastcgi.com/ .
+
+procedure
+---------
+To install::
+
+    autoconf
+    ./configure
+    make
+    make install
+
+*fcgiwrap* will be copied to ``/usr/local/bin/fcgiwrap``.
+You can omit ``make install`` and install it e.g., in ``/usr/sbin`` by hand.
+
+usage
+-----
+Most probably you will want ``fcgiwrap`` be launched by `www-servers/spawn-fcgi <http://redmine.lighttpd.net/projects/spawn-fcgi>`_. Or you could use the author's Perl launcher - see the homepage for that.
+
+When running, ``fcgiwrap`` evaluates environment variables *DOCUMENT_ROOT* and *SCRIPT_NAME*, concatenes them and invokes the resulting executable (should it exist).