Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
L
libvfp-brotli
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
libvfp-brotli
Commits
9fbc3560
Commit
9fbc3560
authored
Feb 18, 2019
by
Geoff Simmons
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update docs about requirements and installation.
parent
57fccb78
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
36 additions
and
32 deletions
+36
-32
INSTALL.rst
INSTALL.rst
+30
-10
README.rst
README.rst
+3
-11
vfp_brotli.vcc
src/vfp_brotli.vcc
+3
-11
No files found.
INSTALL.rst
View file @
9fbc3560
...
...
@@ -4,15 +4,33 @@ INSTALLATION
Installing prerequisites
~~~~~~~~~~~~~~~~~~~~~~~~
libbrotli is required. It may be available as a package (try ``libbrotli-dev``),
alternatively the source can be found at https://github.com/google/brotli.git
The VFP requires the Google brotli library, which is installed as
separate libraries for compression and decompression,
``libbrotlienc.so`` and ``libbrotlidec.so``. These in turn depend on a
third library ``libbrotlicommon.so``. Package managers for most
distributions provide these under a name like ``libbrotli`` or
``libbrotli1`` (and the package manager takes care of the dependencies
for you).
For deployment with Varnish, the non-development version of libbrotli
is sufficient, while the development version is necessary for source
builds (see below).
You can also build libbrotli from the source repository at
https://github.com/google/brotli.git
Building from source
~~~~~~~~~~~~~~~~~~~~
The VFP is built against a Varnish installation, and the autotools
use ``pkg-config(1)`` to locate the necessary header files and other
resources. This sequence will install the VMOD::
Source builds require the development version of libbrotli, which may
be available as a package for your distribution under a name like
``libbrotli-dev`` or ``libbrotli-devel``. An install from the
libbrotli source is also sufficient.
The VFP is built against a Varnish installation, and the autotools use
``pkg-config(1)`` to locate the necessary header files and other
resources for both Varnish and libbrotli. This sequence will install
the VMOD::
> ./autogen.sh # for builds from the git repo
> ./configure
...
...
@@ -24,11 +42,13 @@ resources. This sequence will install the VMOD::
See `CONTRIBUTING.rst <CONTRIBUTING.rst>`_ for notes about building
from source.
If you have installed Varnish in non-standard directories, call
``autogen.sh`` and ``configure`` with the ``PKG_CONFIG_PATH``
environment variable set to include the paths where the ``.pc`` file
can be located for ``varnishapi``. For example, when varnishd
configure was called with ``--prefix=$PREFIX``, use::
If you have installed Varnish or libbrotli in non-standard
directories, call ``autogen.sh`` and ``configure`` with the
``PKG_CONFIG_PATH`` environment variable set to include the paths
where the ``.pc`` file can be located for all of ``varnishapi``,
``libbrotlienc``, ``libbrotlidec`` and ``libbrotlicommon``. For
example, when varnishd configure was called with ``--prefix=$PREFIX``,
use::
> PKG_CONFIG_PATH=${PREFIX}/lib/pkgconfig
> export PKG_CONFIG_PATH
...
...
README.rst
View file @
9fbc3560
...
...
@@ -484,22 +484,14 @@ REQUIREMENTS
The VFP currently requires the Varnish master branch.
The VFP also requires the `Google brotli library`_, which is installed
as separate libraries for compression and decompression,
``libbrotlienc.so`` and ``libbrotlidec.so``. These in turn depend on a
third library ``libbrotlicommon.so``. Package managers for most
distributions provide these under names like ``libbrotli`` or
``libbrotli1`` (and the package manager takes care of the dependencies
for you). You can also build the library from source; see the
repository address shown below.
The VFP also requires the `Google brotli library`_, see
`INSTALL.rst <INSTALL.rst>`_ in the source directory for details.
The VFP has been tested with version 1.0.5 of both the encoder and
decoder libraries.
If you are building the VFP from source, you will need development
versions of the brotli libraries. See
`CONTRIBUTING.rst <CONTRIBUTING.rst>`_ in the source directory
for details.
versions of the brotli libraries. See `INSTALL.rst <INSTALL.rst>`_.
INSTALLATION
============
...
...
src/vfp_brotli.vcc
View file @
9fbc3560
...
...
@@ -448,22 +448,14 @@ REQUIREMENTS
The VFP currently requires the Varnish master branch.
The VFP also requires the `Google brotli library`_, which is installed
as separate libraries for compression and decompression,
``libbrotlienc.so`` and ``libbrotlidec.so``. These in turn depend on a
third library ``libbrotlicommon.so``. Package managers for most
distributions provide these under names like ``libbrotli`` or
``libbrotli1`` (and the package manager takes care of the dependencies
for you). You can also build the library from source; see the
repository address shown below.
The VFP also requires the `Google brotli library`_, see
`INSTALL.rst <INSTALL.rst>`_ in the source directory for details.
The VFP has been tested with version 1.0.5 of both the encoder and
decoder libraries.
If you are building the VFP from source, you will need development
versions of the brotli libraries. See
`CONTRIBUTING.rst <CONTRIBUTING.rst>`_ in the source directory
for details.
versions of the brotli libraries. See `INSTALL.rst <INSTALL.rst>`_.
INSTALLATION
============
...
...
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