Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ostark/upper
Integrates Edge Caches like Fastly, KeyCDN, Cloudflare and Varnish with Craft.
https://github.com/ostark/upper
cache cache-purge cloudflare craft-plugin craft3 craftcms fastly keycdn
Last synced: about 2 months ago
JSON representation
Integrates Edge Caches like Fastly, KeyCDN, Cloudflare and Varnish with Craft.
- Host: GitHub
- URL: https://github.com/ostark/upper
- Owner: ostark
- License: mit
- Archived: true
- Created: 2017-10-20T13:41:16.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-02-16T08:19:20.000Z (10 months ago)
- Last Synced: 2024-04-27T04:35:06.768Z (8 months ago)
- Topics: cache, cache-purge, cloudflare, craft-plugin, craft3, craftcms, fastly, keycdn
- Language: PHP
- Homepage:
- Size: 563 KB
- Stars: 102
- Watchers: 4
- Forks: 22
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-cloudflare - Upper - Speeds up craft dramatically using a cache proxy in front of your webserver. (DNS)
- awesome-cloudflare - Upper - Speeds up craft dramatically using a cache proxy in front of your webserver. (DNS)
README
# The pep pill for your Craft site
[](https://packagist.org/packages/ostark/upper)
[](https://packagist.org/packages/ostark/upper)
[](https://packagist.org/packages/ostark/upper)
Upper speeds up Craft dramatically using a **Cache Proxy** in front of your webserver.
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.
If you need an introduction to HTTP Caching, I highly recommend [this article](https://blog.fortrabbit.com/mastering-http-caching).
## Sponsor
Development happens in my free time, but also during working hours.
Thanks [fortrabbit.com](https://www.fortrabbit.com/craft-hosting)!
If you are looking additional integrations (Cache Drivers), feel free to contribute or [raise an issue](https://github.com/ostark/upper/issues).
## Supported Cache Drivers
* [KeyCDN](https://www.keycdn.com) (CDN/SaaS)
* [Fastly](https://www.fastly.com) (CDN/SaaS)
* [Cloudflare](https://www.cloudflare.com) (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=
FASTLY_SERVICE_ID=
FASTLY_DOMAIN=http://
```
### KeyCDN Setup
```
UPPER_DRIVER=keycdn
KEYCDN_API_KEY=
KEYCDN_ZONE_URL=.kxcdn.com
KEYCDN_ZONE_ID=
```
### Cloudflare Setup
```
UPPER_DRIVER=cloudflare
CLOUDFLARE_API_TOKEN=
CLOUDFLARE_ZONE_ID=
CLOUDFLARE_DOMAIN=https://
```
By default, Cloudflare's CDN does not cache HTML content. You need to create a [**Cache Level: Cache Everything**](https://support.cloudflare.com/hc/en-us/articles/202775670-How-Do-I-Tell-Cloudflare-What-to-Cache-) Page Rule to enable caching for "pages".
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.
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.
### Varnish Setup
Varnish URL supports multiple servers, separate with comma. E.g `http://1.1.1.1,http://2.2.2.2`
```
UPPER_DRIVER=varnish
VARNISH_URL=
```
### Tuning
In a template, you can fully disable caching like so:
```
{% do upper.cache.never() %}
```
…which is a shorthand for:
```
{% 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:
```
{% do upper.cache.for('5 minutes') %}
```
…which is shorthand for:
```
{% header "Cache-Control: public, s-maxage=300" %}
```
### Performance results
### Cache Tag Headers
## 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](https://github.com/joshangell/Falcon).