ostark/upper

A cache plugin for Craft - supporting multiple Edge Caches

, _(*1)

The pep pill for your Craft site

, _(*2)

Upper speeds up Craft dramatically using a Cache Proxy in front of your webserver., _(*3)

The Plugin adds the neccessary Cache-Control and XKEY/Surrogate-Key/Cache-Tag headers to your pages. When Entries or Sections get updated in the Control Panel it takes care of the cache invalidation., _(*4)

If you need an introduction to HTTP Caching, I highly recommend this article., _(*5)

Sponsor

Development happens in my free time, but also during working hours. Thanks fortrabbit.com!, _(*6)

If you are looking additional integrations (Cache Drivers), feel free to contribute or raise an issue., _(*7)

Supported Cache Drivers

• KeyCDN (CDN/SaaS)
• Fastly (CDN/SaaS)
• Cloudflare (CDN/SaaS)
• Varnish with XKEY support (your own proxy)
• Dummy (does nothing)

Installation

1. Install with Composer via composer require ostark/upper from your project directory
2. Install plugin with this command php craft plugin/install upper or in the Craft CP under Settings > Plugins
3. A new configuration file gets generated automatically in your-project/config/upper.php.

Fastly Setup

UPPER_DRIVER=fastly
FASTLY_API_TOKEN=<REPLACE-ME>
FASTLY_SERVICE_ID=<REPLACE-ME>
FASTLY_DOMAIN=http://<REPLACE-ME>

KeyCDN Setup

UPPER_DRIVER=keycdn
KEYCDN_API_KEY=<REPLACE-ME>
KEYCDN_ZONE_URL=<REPLACE-ME>.kxcdn.com
KEYCDN_ZONE_ID=<REPLACE-ME>

Cloudflare Setup

UPPER_DRIVER=cloudflare
CLOUDFLARE_API_TOKEN=<REPLACE-ME>
CLOUDFLARE_ZONE_ID=<REPLACE-ME>
CLOUDFLARE_DOMAIN=https://<REPLACE-ME>

By default, Cloudflare's CDN does not cache HTML content. You need to create a Cache Level: Cache Everything Page Rule to enable caching for "pages"., _(*8)

If you don't use Cloudflare Enterprise with native Cache-Tag support, make sure to enable useLocalTags in your config/upper.php file (default), otherwise disable it., _(*9)

You can generate a token in the Cloudflare dashboard. You want to create a custom token with the "Zone.Cache Purge" permission that is restricted to the DNS zone(s) you wish to clear Cloudflare's cache for., _(*10)

Varnish Setup

Varnish URL supports multiple servers, separate with comma. E.g http://1.1.1.1,http://2.2.2.2, _(*11)

UPPER_DRIVER=varnish
VARNISH_URL=<REPLACE-ME>

Tuning

In a template, you can fully disable caching like so:, _(*12)

{% do upper.cache.never() %}

…which is a shorthand for:, _(*13)

{% header "Cache-Control: private, no-cache" %}

By default the defaultMaxAge config setting will be used to determine the cache duration to set. This can be overridden in a template:, _(*14)

{% do upper.cache.for('5 minutes') %}

…which is shorthand for:, _(*15)

{% header "Cache-Control: public, s-maxage=300" %}

Performance results

, _(*16)

Cache Tag Headers

, _(*17)

Disclaimer

Even if the name of the plugin and some wordings are intentional, the author does not glorify any drug abuse. 🍻 The plugin is inspired by the joshangell/Falcon., _(*18)