HTTP cache handling for eZ Platform, using multi tagging (incl Varnish xkey)
Branch: master
Clone or download
Pull request Compare This branch is even with ezsystems:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
features
spec
src
tests
.gitignore
.php_cs
.travis.yml
LICENSE
README.md
bootstrap.php
composer.json
phpspec.yml
phpunit.xml

README.md

Build Status Downloads Latest release License

platform-http-cache

Provides HTTP cache handling for eZ Platform, by default since version 1.12. From ezpublish-kernel, it adds support for mult-tagging for Symfony Proxy, Varnish (using xkey). Support for Fastly is part of the eZ Platform Cloud Enterprise offer as of 1.13 LTS.

Usage with Varnish

For usage with Varnish see the dedicated document in docs/varnish

Features

xkey header on ContentView responses

Responses from /content/view will be tagged based on their contents:

curl -i -X HEAD 'http://localhost:8000/'

HTTP/1.1 200 OK
Host: localhost:8000
Connection: close
Cache-Control: public, s-maxage=60
Content-Type: text/html; charset=UTF-8
Vary: X-User-Hash
xkey: content-1 content-type-1 location-2 parent-1 path-1 path-2 ez-all

As of v0.7, if you have several repositories configured, the tags will be prefixed by repository name on non default repository. E.g. "intranet_path-1".

For further reading on tags see docs/using_tags.md.

Toggling of cache on ContentView responses

Responses from /content/view will be made cachable, and the shared max age will be set if it is enabled.

Purging of tagged HTTP cache on Repository operations

A set of Slots will send HTTP PURGE requests for each cache tag affected by write operations.

Configuration

Drivers

This bundle lets you configure drivers for handling HTTP cache. The following exists from eZ:

  • local: extended Symfony Proxy to support tagging and varying by user rights (available in this bundle)
  • http aka varnish: Varnish proxy using and customizing FosHttpCache for purging (available in this bundle)
  • fastly: Fastly CDN proxy (available with eZ Platform Enterprise and documented separately)

Configuring these is done using global ezpublish.http_cache.purge_type config. By default it is set to use %purge_type% parameter, and can be set in app/config/parameters.yml like so:

parameters:
    purge_type: varnish

For further reading on drivers see docs/drivers.md.

Tags

For further reading on tags see docs/using_tags.md.