aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorStefan Bühler <stbuehler@web.de>2013-05-29 13:46:45 +0200
committerStefan Bühler <stbuehler@web.de>2013-05-29 13:46:45 +0200
commit9541b9d885087474f71c66b272a0a0ae721dcc0d (patch)
tree80dcd4aa9ffb22deb0ae1d2381560efd3521fc4a /README.rst
parentf214917c92c3f9f14e66597bbdbb48fe59cfd6f2 (diff)
downloadfcgi-cgi-9541b9d885087474f71c66b272a0a0ae721dcc0d.tar.gz
fcgi-cgi-9541b9d885087474f71c66b272a0a0ae721dcc0d.zip
make README a proper formatted README.rst
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst54
1 files changed, 54 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..14825f4
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,54 @@
+Description
+-----------
+
+:Homepage:
+ http://redmine.lighttpd.net/projects/fcgi-cgi/wiki
+
+fcgi-cgi is a FastCGI application to run normal cgi applications. It doesn't
+make CGI applications faster, but it allows you to run them on a different
+host and with different user permissions (without the need for suexec).
+
+lighttpd2 won't have a mod_cgi, so you need this FastCGI wrapper to be able
+to execute standard cgi applications like mailman and cgit.
+
+fcgi-cgi is released under the `MIT license <http://git.lighttpd.net/fcgi-cgi.cgi/tree/COPYING>`_
+
+Usage
+-----
+
+Examples for spawning a fcg-cgi instance with daemontools or runit::
+
+ #!/bin/sh
+ # run script
+
+ exec spawn-fcgi -n -s /tmp/fastcgi-cgi.sock -u www-default -U www-data -- /usr/bin/fcgi-cgi
+
+
+Build dependencies
+------------------
+
+* glib >= 2.16.0 (http://www.gtk.org/)
+* libev (http://software.schmorp.de/pkg/libev.html)
+* cmake or autotools (for snapshots/releases the autotool generated files are included)
+
+
+Build
+-----
+
+* snapshot/release with autotools::
+
+ ./configure
+ make
+
+* build from git: ``git clone git://git.lighttpd.net/fcgi-cgi.git``
+
+ * with autotools::
+
+ ./autogen.sh
+ ./configure
+ make
+
+ * with cmake (should work with snapshots/releases too)::
+
+ cmake .
+ make