Skip to content

Scrutinizer Code Quality Code Coverage Build Status Code Intelligence Status

FastCGI Cache Bust plugin for Craft CMS 5.x

Bust the Nginx FastCGI Cache when entries are saved or created.

Screenshot

Requirements

This plugin requires Craft CMS 5.0.0 or later.

Installation

To install FastCGI Cache Bust, follow these steps:

  1. Install with Composer via composer require nystudio107/craft-fastcgicachebust from your project directory
  2. Install the plugin via ./craft install/plugin fastcgi-cache-bust via the CLI, or in the Control Panel, go to Settings → Plugins and click the “Install” button for FastCGI Cache Bust.

You can also install FastCGI Cache Bust via the Plugin Store in the Craft Control Panel.

FastCGI Cache Bust Overview

FastCGI Cache Bust is a simple plugin that clears your entire FastCGI Cache any time an entry is saved. This is somewhat of a scortched earth approach to cache invalidation, but it ensure cache coherency.

Check out the article Static Page Caching with Craft CMS for details on how to set up FastCGI Cache on your site.

Configuring FastCGI Cache Bust

Click on the gear icon next to the plugin to configure it by adding the full absolute path to your Nginx FastCGI Cache directory. If you require more than one FastCGI Cache directory cleared, separate the paths with a comma (,).

Using FastCGI Cache Bust

FastCGI Cache Bust listens for elements being saved, and busts the entire FastCGI Cache automatically when that happens.

FastCGI Cache Bust will also bust the entire FastCGI Cache whenever Template caches are deleted.

You can also manually clear the FastCGI Cache via Craft’s 'Clear Caches’ tool

FastCGI Cache Bust Roadmap

Some things to do, and ideas for potential features:

  • We could invalidate only affected caches onElementSave instead of the entire cache

Brought to you by nystudio107