README.md

eZ Platform Varnish configuration

Prerequisites

• A working Varnish 4.1 and higher setup with xkey module installed
  • As of eZ Platform 2.5LTS the requirement is Varnish 5.1 (6.0LTS recommended and what we mainly test against)
• Varnish Plus comes with xkey out of the box and can also be used.

Recommended VCL base files

For Varnish to work properly with eZ, you'll need to use the provided configuration:

• eZ Platform 1.13LTS optimized Varnish 4+ VCL
• eZ Platform 2.5LTs optimized Varnish 5.1+ VCL

For tuning the VCL further to you needs, see the following relevant examples:

• FOSHttpCache documentation
• Symfony documentation 2.8 3.4
• xkey vmod doc
• General VCL Varnish doc

Example installation on Debian/Ubuntu:

Starting with Debian 9 and Ubuntu 16.10 installation of xkey VMOD is greatly simplified as new varnish-modules package now exists.

Install:

# If you haven't updated package meta info in a while
apt-get update -q -y

# Install varnish and varnish-modules
# optionally: make sure we have ca-certificates to be able to skip optional dependencies
apt-get install -q -y --force-yes --no-install-recommends ca-certificates varnish-modules varnish

You can now start Varnish with flag to use your customized version of "eZ Platform optimized VCL" above.