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

Source

http://svn.plone.org/svn/collective/stxnext.varnishpurger/trunk

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.

Source Distribution

stxnext.varnishpurger-0.3.0.tar.gz (9.2 kB view details)

Uploaded Source

File details

Details for the file stxnext.varnishpurger-0.3.0.tar.gz.

File metadata

File hashes

Hashes for stxnext.varnishpurger-0.3.0.tar.gz
Algorithm Hash digest
SHA256 58cefc7fc65c12dda6f426bcad0b1fb7d2fa5e5792de5f890289321e0684448f
MD5 3083030ca5858e40c9a270afbd7e80fe
BLAKE2b-256 be8b16ba69cb0dffbc562d8f93cdb6679007079be7a73f8f8872cc8d33f2b52f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page