If tags are stored, URIs on which the entry has been known to appear are also purged.Īdditionally, if the element is an entry, any bindings configured for the section and entry type being edited will also be performed. The element types taken into account isĮntries, categories, matrix blocks and assets. If the saved element is an asset, all urls for elements related to that asset, either directly or through a Matrix block, is purged. If the saved element is an entry, all directly related entry urls, all related category urls, and all urls for elements related through an entries Matrix blocks, is purged. If purgeRelated is enabled, the urls for all related elements are also purged. If purgeRelated is disabled, only the url for the element itself, or the owners url if the element is a Matrix block, is purged. When an element is saved, the plugin collects the urls that it thinks need to be updated, and creates a new task that sends purge requests to the Varnish server for each url. The following options can be given for each host: Option It's up to you what name you give each host, which is defined as the array key for each array within varnishHosts. So long as you're already passing the admin area with Varnish, an example syntax for preventing caching with this cookie would be as follows: The name of the cookie can be set with this variable. When logging into the admin, Citrus will set a recognisable cookie which can be optionally used within the Varnish VCL to disable the cache for administrative users on the front end. See "Configuring Varnish" for more information. banQueryHeaderĭefines the header to use for HTTP banning. If one of these three options is omitted and bansSupported is true, Citrus will fall back to the HTTP method for banning.
If using the admin socket method for adding bans, the relevant details for the Varnish host IP, admin port and secret file (usually found in /etc/varnish) will need to be entered here. Important: changing this option after ban bindings have been added can lead loss of binding settings. Otherwise use false and no banning related options will appear. If either the admin socket or HTTP banning can be performed on the Varnish hosts, set this option to true. purgeUrlMapĪ lookup map for purging additional urls that needs it when a given url is purged. Useful for debugging in production environments without having to enable devMode. When set to 1 some additional logging is forced even if devMode is disabled. This should normally be enabled to make sure that all relevant urls are updated, but could be disabled on high traffic websites to make sure the cache stays as warm as possible. purgeRelatedĮnables or disables purging of related urls when an element is saved. purgeEnabledĮnables or disables purging on Entry editing within the Citrus plugin. 'varnishUrl' => 'http: //123.123.123.120', 'varnishHostName' => '',Īll HTTP based requests will be sent to the server by its IP but a Host header will also define the host name required. The varnishUrl setting can also be an array if you are running a multi language site, e.g: The following settings are the default: Option To configure Citrus, create a new citrus.php config file in your config folder, and override settings as needed.
Configure tags as necessary in the template.Override default configuration if necessary.Enable the Citrus plugin in Craft (Settings > Plugins).Copy the /citrus folder to your Craft plugin folder.
Citrus tagr download#
Download and extract the contents of the zip.🍊 Multiple Varnish hosts Download Citrusĭownload the latest version here Installation 🍊 A tagging system, to identify where entries are located A Craft CMS plugin for purging and banning Varnish caches when elements are saved.
0 kommentar(er)
