From 405eeb454e6420ecef3ba0803c7033df414f33f1 Mon Sep 17 00:00:00 2001 From: Sergey Poznyakoff Date: Sat, 19 Oct 2013 10:00:46 +0300 Subject: Version 1.0 --- README | 77 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) (limited to 'README') diff --git a/README b/README index e69de29..95d5c29 100644 --- a/README +++ b/README @@ -0,0 +1,77 @@ +Vmod-sql README +Copyright (C) 2013 Sergey Poznyakoff +See the end of file for copying conditions. + +* Introduction + +This file contains brief information about configuring, testing +and using vmod-sql. It is *not* intended as a replacement +for the documentation, and is provided as a brief reference only. +For accessing complete vmod-sql documentation, see the section +'Documentation' below. + +* Overview + +Vmod-sql is a module for Varnish Cache. It provides API for accessing +MySQL and PostgreSQL databases from VCL scripts. + +* Installation + +In order to compile the package you need to have Varnish source tree. +At least Varnish 3.0.1 is required. Supposing that the varnish source tree +is available under /usr/src/varnish-3.0.1, run: + + ./configure --with-varnish-source=/usr/src/varnish-3.0.1 + +The `--with-varnish-source' option is mandatory: it tells configure +where Varnish sources reside. + +Once configured, do + + make + +This will build the module. After this step you can optionally run +'make test' to test the package. + +Finally, run the following command as root: + + make install + +* Documentation + +A complete documentation in manpage and texinfo formats is shipped with +the package, in the directory doc/. To read it without installing the +package run `info -f doc/vmod-sql.info', or, to view the manpage: +`man ./doc/vmod-sql.3'. After successful installation, the +documentation can be accessed by running `info vmod-sql' and the manpage, +by `man vmod-sql'. + +An online copy of the documentation is available from +http://www.gnu.org.ua/software/vmod-sql. + +* Bug reporting + +Send bug reports and suggestions to + + +* Copyright information: + +Copyright (C) 2013 Sergey Poznyakoff + + Permission is granted to anyone to make or distribute verbatim copies + of this document as received, in any medium, provided that the + copyright notice and this permission notice are preserved, + thus giving the recipient permission to redistribute in turn. + + Permission is granted to distribute modified versions + of this document, or of portions of it, + under the above conditions, provided also that they + carry prominent notices stating who last changed them. + + +Local Variables: +mode: outline +paragraph-separate: "[ ]*$" +version-control: never +End: + -- cgit v1.2.1