Commit 9fbc3560 authored by Geoff Simmons's avatar Geoff Simmons

Update docs about requirements and installation.

parent 57fccb78
...@@ -4,15 +4,33 @@ INSTALLATION ...@@ -4,15 +4,33 @@ INSTALLATION
Installing prerequisites Installing prerequisites
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
libbrotli is required. It may be available as a package (try ``libbrotli-dev``), The VFP requires the Google brotli library, which is installed as
alternatively the source can be found at https://github.com/google/brotli.git 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 Building from source
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
The VFP is built against a Varnish installation, and the autotools Source builds require the development version of libbrotli, which may
use ``pkg-config(1)`` to locate the necessary header files and other be available as a package for your distribution under a name like
resources. This sequence will install the VMOD:: ``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 > ./autogen.sh # for builds from the git repo
> ./configure > ./configure
...@@ -24,11 +42,13 @@ resources. This sequence will install the VMOD:: ...@@ -24,11 +42,13 @@ resources. This sequence will install the VMOD::
See `CONTRIBUTING.rst <CONTRIBUTING.rst>`_ for notes about building See `CONTRIBUTING.rst <CONTRIBUTING.rst>`_ for notes about building
from source. from source.
If you have installed Varnish in non-standard directories, call If you have installed Varnish or libbrotli in non-standard
``autogen.sh`` and ``configure`` with the ``PKG_CONFIG_PATH`` directories, call ``autogen.sh`` and ``configure`` with the
environment variable set to include the paths where the ``.pc`` file ``PKG_CONFIG_PATH`` environment variable set to include the paths
can be located for ``varnishapi``. For example, when varnishd where the ``.pc`` file can be located for all of ``varnishapi``,
configure was called with ``--prefix=$PREFIX``, use:: ``libbrotlienc``, ``libbrotlidec`` and ``libbrotlicommon``. For
example, when varnishd configure was called with ``--prefix=$PREFIX``,
use::
> PKG_CONFIG_PATH=${PREFIX}/lib/pkgconfig > PKG_CONFIG_PATH=${PREFIX}/lib/pkgconfig
> export PKG_CONFIG_PATH > export PKG_CONFIG_PATH
......
...@@ -484,22 +484,14 @@ REQUIREMENTS ...@@ -484,22 +484,14 @@ REQUIREMENTS
The VFP currently requires the Varnish master branch. The VFP currently requires the Varnish master branch.
The VFP also requires the `Google brotli library`_, which is installed The VFP also requires the `Google brotli library`_, see
as separate libraries for compression and decompression, `INSTALL.rst <INSTALL.rst>`_ in the source directory for details.
``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 has been tested with version 1.0.5 of both the encoder and The VFP has been tested with version 1.0.5 of both the encoder and
decoder libraries. decoder libraries.
If you are building the VFP from source, you will need development If you are building the VFP from source, you will need development
versions of the brotli libraries. See versions of the brotli libraries. See `INSTALL.rst <INSTALL.rst>`_.
`CONTRIBUTING.rst <CONTRIBUTING.rst>`_ in the source directory
for details.
INSTALLATION INSTALLATION
============ ============
......
...@@ -448,22 +448,14 @@ REQUIREMENTS ...@@ -448,22 +448,14 @@ REQUIREMENTS
The VFP currently requires the Varnish master branch. The VFP currently requires the Varnish master branch.
The VFP also requires the `Google brotli library`_, which is installed The VFP also requires the `Google brotli library`_, see
as separate libraries for compression and decompression, `INSTALL.rst <INSTALL.rst>`_ in the source directory for details.
``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 has been tested with version 1.0.5 of both the encoder and The VFP has been tested with version 1.0.5 of both the encoder and
decoder libraries. decoder libraries.
If you are building the VFP from source, you will need development If you are building the VFP from source, you will need development
versions of the brotli libraries. See versions of the brotli libraries. See `INSTALL.rst <INSTALL.rst>`_.
`CONTRIBUTING.rst <CONTRIBUTING.rst>`_ in the source directory
for details.
INSTALLATION INSTALLATION
============ ============
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment