Skip to main content

Plone viewlet for purging varnish cache for given url.

Project description

stxnext.varnishpurger

Overview

A viewlet containing the link to perform action of purging varnish cache for actual object’s views.

Installation

If you are using zc.buildout to manage your project, you can do this:

  • Add stxnext.varnishpurger to the list of eggs to install, e.g.:

    [buildout]
    ...
    eggs =
        ...
        stxnext.varnishpurger
    
  • If you’re using plone.recipe.zope2instance recipe to manage your instance add this lines to install a ZCML slug:

    [instance]
    recipe = plone.recipe.zope2instance
    ...
    zcml =
        ...
        stxnext.varnishpurger
    
  • Re-run buildout, e.g. with:

    $ ./bin/buildout
    

You can skip the ZCML slug if you are going to explicitly include the package from another package’s configure.zcml file.

Finally go to portal_quickinstaller and install stxnext.varnishpurger product.

Usage

After installation one new viewlet above object’s content will be displayed. The viewlet contains a link to purge content of actual url from varnish cache. In site properties there is additional configuration where you can define the address of varnish instance url (by default: localhost:6081).

The varnish configuration file should contain customized vcl_recv subroutine to purge given object by it’s UID:

sub vcl_recv {

        ...

   if (req.request == "PURGE") {
        if (!client.ip ~ purge) {
             error 405 "Not allowed.";
            }
        purge("obj.http.X-Context-Uid ~ " req.url);
            error 200 "Purged";
        return(lookup);
   }

    ...

}

Tested With

Plone 3, Plone 4 and Varnish 2.1.x

References

varnish: http://www.varnish-cache.org

Plone: http://plone.org

Author & Contact

Author:
  • Radosław Jankiewicz <radoslaw.jankiewicz@stxnext.pl>
  • Wojciech Lichota <wojciech.lichota@stxnext.pl>
  • Marcin Ossowski <marcin.ossowski@stxnext.pl>
http://stxnext.pl/open-source/files/stx-next-logo

STX Next Sp. z o.o.

http://stxnext.pl

info@stxnext.pl

Changelog

0.3.0 (2011-12-08)

  • Link for executing purging action moved from a viewlet to the ‘Actions’ dropdown [radekj]

0.2.0 (2011-11-03)

  • Fixes to work with Plone 4.1 [radekj]

0.1.2 (2011-05-13)

  • Moved to collective svn, updated docs [radekj]

0.1.1 (2010-05-24)

  • Fixed setting UID in http header for FSPageTemplate views [radekj]

0.1.0 (2010-05-13)

  • Initial release [radekj]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for stxnext.varnishpurger, version 0.3.0
Filename, size File type Python version Upload date Hashes
Filename, size stxnext.varnishpurger-0.3.0.tar.gz (9.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page