summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYorhel <git@yorhel.nl>2012-10-15 11:57:40 +0200
committerYorhel <git@yorhel.nl>2012-10-15 11:57:40 +0200
commita91be80889758e867a53be81701f88ce3373d2cf (patch)
tree0d77b7b3a584dc7c3d634bb6c4ae0500625dc02b
parentd9ae43c0b83254b80feb6303d181749f567aceb1 (diff)
README updates
-rw-r--r--README54
1 files changed, 16 insertions, 38 deletions
diff --git a/README b/README
index 7874171..df2fafc 100644
--- a/README
+++ b/README
@@ -1,13 +1,14 @@
p.blicky.net source code
------------------------
+
REQUIREMENTS
A webserver with CGI support (tested with lighttpd and apache)
- perl (only tested on 5.12)
- postgresql (only tested on 8.4 and 9.0)
+ perl (tested on 5.12 - 5.16)
+ postgresql (should work on 8.4+)
vim (7.x)
- TUWF (Get it from http://dev.yorhel.nl/tuwf)
+ TUWF (Available from CPAN and http://dev.yorhel.nl/tuwf)
DBI
DBD::Pg
Text::VimColor
@@ -17,43 +18,20 @@ INSTALL
1. Create a postgresql database
2. Load the schema from index.cgi in your database
- 3. Configure your webserver. Make sure all requests are passed to index.cgi,
- with the query string set to the actual URL. Also make sure the correct
- environment variables are set for your database login to work. The following
- example can be used for lighttpd:
-
- $HTTP["host"] == "p.blicky.net" {
- server.document-root = "/path/to/dir/"
- cgi.assign = ( ".cgi" => "")
- server.error-handler-404 = "/index.cgi"
- setenv.add-environment = (
- "DBI_DSN" => "dbi:Pg:dbname=<databasename>",
- "DBI_USER" => "<databaseuser>",
- "DBI_PASS" => "<databasepassword>"
- "TUWF_LOG" => "</path/to/logfile>"
- )
- }
-
- Or with Apache 2.2 (with mod_cgi and mod_rewrite). Most of this can
- probably also be configured using a .htaccess, assuming the httpd has been
- configured to read those. Also make sure that +ExecCGI is enabled in the
- directory configuration.
-
- <VirtualHost *:*>
- ServerName p.blicky.net
- DocumentRoot /path/to/dir
- AddHandler cgi-script .cgi
- SetEnv DBI_DSN dbi:Pg:dbname=<databasename>
- SetEnv DBI_USER <databaseuser>
- SetEnv DBI_PASS <databasepassword>
- SetEnv TUWF_LOG </path/to/logfile>
- RewriteEngine On
- RewriteCond "%{DOCUMENT_ROOT}/%{REQUEST_URI}" !-s
- RewriteRule ^/(.*)$ /index.cgi?$1
- </VirtualHost>
+ 3. Configure your webserver, check the TUWF documentation for instructions
+ and examples. The following environment variables need to be set from your
+ web server config:
+
+ DBI_DSN -> dbi:Pg:dbname=<databasename>
+ DBI_USER -> <databaseuser>
+ DBI_PASS -> <databasepassword>
+ TUWF_LOG -> </path/to/logfile>
+ On lighttpd, use "setenv.add-environment" to do this, for Apache you can
+ use the SetEnv directive for CGI mode and DefaultInitEnv for FastCGI
+ setups.
CONTACT
- ayo@blicky.net
+ projects@yorhel.nl