summaryrefslogtreecommitdiffabout
path: root/README
blob: 95d5c29161fc3b5b0f21887b899e7275e454ba34 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
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 <gray@gnu.org>


* 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:
  

Return to:

Send suggestions and report system problems to the System administrator.