aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README34
1 files changed, 29 insertions, 5 deletions
diff --git a/README b/README
index 8e68d6a..1917254 100644
--- a/README
+++ b/README
@@ -1,29 +1,39 @@
Varnish-mib README
-Copyright (C) 2014-2015 Sergey Poznyakoff
See the end of file for copying conditions.
* Introduction
This file contains brief information about configuring, testing
and using Varnish-mib. It is *not* intended as a replacement
for the documentation, and is provided as a brief reference only.
For a detailed documentation, please see the varnish-mib(8)
manpage.
+If you are building varnish-mib from Git repository, jump to
+the section GIT SOURCES, below.
+
* Overview
Varnish-mib is a dynamically loadable object module for net-snmp
snmpd, that provides access to Varnish Cache statistics. It uses
MIBs from varnishsnmp project (http://varnishsnmp.sourceforge.net).
+This and other versions of Varnish-mib is available for download from
+<http://download.gnu.org.ua/release/varnish-mib>. The following table
+describes the relation between the release number and the version
+of Varnish API version it is written for:
+
+ 1.0 and up to 2.0 Varnish 4.0 and 4.1
+ 2.0 (this release) Varnish 5.2.0
+ 3.0 Varnish 5.2.1
+
* Installation
-In order to compile the package you need to have Net-snmp and Varnish
-installed. Only Varnish 4.x is supported. The installation sequence
-is as usual:
+In order to compile the package you need to have Net-SNMP and Varnish
+installed. The installation sequence is as usual:
./configure [options]
make
make install
(the last step normally requires root privileges). For generic
@@ -37,20 +47,34 @@ $PREFIX/lib/snmp, where $PREFIX stands for the installation prefix.
** --with-mibdir=DIR
Install MIBs (the file VARNISH-MIB.txt in DIR. By default it is
installed in $prefix/share/snmp.
+* GIT SOURCES
+
+If you cloned the sources from GIT, you will need the following
+additional tools in order to bootstrap the package:
+
+ + Perl
+ + mib2c
+ + Perl module Inline::C
+ + Flex
+
+Make sure to check out the branch corresponding to the version of
+Varnish you are using. Run ./bootstrap. Then, proceed as discussed
+above.
+
* Bug reporting
Send bug reports and suggestions to <gray@gnu.org>
* Copyright information:
-Copyright (C) 2014 Sergey Poznyakoff
+Copyright (C) 2014-2018 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.

Return to:

Send suggestions and report system problems to the System administrator.