nswdpc / silverstripe-cache-headers
Modify cache headers via configuration
Installs: 3 645
Dependents: 1
Suggesters: 0
Security: 0
Stars: 2
Watchers: 3
Forks: 0
Open Issues: 0
Type:silverstripe-vendormodule
Requires
- silverstripe/cms: ^5
Requires (Dev)
- phpunit/phpunit: ^9.5
This package is auto-updated.
Last update: 2024-09-13 06:37:30 UTC
README
The default Silverstripe cache handling sends headers that are not considered cacheable by a proxy such as Cloudflare.
This module allows you to modify this behaviour via configuration, allowing a proxy to cache based on the headers sent by the application.
Useful information
Usage
- Install this extension using composer
- Modify the configuration rules to your requirements
- Test behind your caching proxy to verify Cache-Control and related header values are as expected
Installation
Install via composer:
composer require nswdpc/silverstripe-cache-headers
Documentation
The priority of caching directives in Silverstripe are in this order as follows:
disableCache($force=true)
privateCache($force=true)
publicCache($force=true)
enableCache($force=true)
disableCache()
privateCache()
publicCache()
enableCache()
By default this module enables the cache (enableCache), but does not provide the force parameter as true
.
See documentation for a primer on various options, including sample configurations.
License
Maintainers
Bugtracker
We welcome bug reports, pull requests and feature requests on the Github Issue tracker for this project.
Please review the code of conduct prior to opening a new issue.
Security
If you have found a security issue with this module, please email digital[@]dpc.nsw.gov.au in the first instance, detailing your findings.
Development and contribution
If you would like to make contributions to the module please ensure you raise a pull request and discuss with the module maintainers.
Please review the code of conduct prior to completing a pull request.