Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
L
libvmod-blobsynth
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
uplex-varnish
libvmod-blobsynth
Commits
776c2ee2
Commit
776c2ee2
authored
Nov 06, 2014
by
Lasse Karstensen
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update documentation for 4.0 builds.
parent
f4887c22
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
14 additions
and
30 deletions
+14
-30
README.rst
README.rst
+14
-30
No files found.
README.rst
View file @
776c2ee2
...
...
@@ -6,8 +6,7 @@ vmod_example
Varnish Example Module
----------------------
:Author: Martin Blix Grydeland
:Date: 2011-05-26
:Date: 2014-11-05
:Version: 1.0
:Manual section: 3
...
...
@@ -19,8 +18,7 @@ import example;
DESCRIPTION
===========
Example Varnish vmod demonstrating how to write an out-of-tree Varnish vmod
for Varnish 3.0 and later.
Example Varnish vmod demonstrating how to write an out-of-tree Varnish vmod.
Implements the traditional Hello World as a vmod.
...
...
@@ -46,32 +44,28 @@ Example
INSTALLATION
============
This is an example skeleton for developing out-of-tree Varnish
vmods available from the 3.0 release. It implements the "Hello, World!"
as a vmod callback. Not particularly useful in good hello world
tradition,but demonstrates how to get the glue around a vmod working.
The source tree is based on autotools to configure the building, and
does also have the necessary bits in place to do functional unit tests
using the
varnishtest
tool.
using the
``varnishtest``
tool.
Usage::
Building requires the Varnish header files and uses pkg-config to find
the necessary paths.
./configure VARNISHSRC=DIR [VMODDIR=DIR]
If you have installed Varnish to a non-standard directory, you may need to
override PKG_CONFIG_PATH so configure can find varnishapi.pc.
Usage::
`VARNISHSRC` is the directory of the Varnish source tree for which to
compile your vmod. Both the `VARNISHSRC` and `VARNISHSRC/include`
will be added to the include search paths for your module.
./autogen.sh
./configure
Optionally you can also set the vmod install directory by adding
`VMODDIR=DIR` (defaults to the pkg-config discovered directory from your
Varnish installation).
Make targets:
* make - builds the vmod
* make install - installs your vmod
in `VMODDIR`
* make - builds the vmod
.
* make install - installs your vmod
.
* make check - runs the unit tests in ``src/tests/*.vtc``
* make distcheck - run check and prepare a tarball of the vmod.
In your VCL you could then use this vmod along the following lines::
...
...
@@ -82,16 +76,6 @@ In your VCL you could then use this vmod along the following lines::
set resp.http.hello = example.hello("World");
}
HISTORY
=======
This manual page was released as part of the libvmod-example package,
demonstrating how to create an out-of-tree Varnish vmod.
For further examples and inspiration check out the vmod directory:
https://www.varnish-cache.org/vmods
COPYRIGHT
=========
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment