The following is a guide to installing the Section Drupal module into an existing Drupal 8 application. This module allows Section’s global, distributed caching layer to quickly respond to invalidation events from a Drupal instance in exactly the same way that Drupal’s internal cache or a local varnish cache running on the host machine does, ensuring that the content in Section’s global caching layer is never stale.
- An existing Section application. For help setting up an application, go here
- A user account to be associated with the Drupal Module (many customers choose to create a user account that exists simply to authenticate cache clearing and is not associated with a specific, real person). To create an account please contact us at this link and for help adding a new user to an app please see here
- The Drupal 8 purge module installed.
- The Drupal 8 key module installed.
- Drush installed if you want to purge any invalidation type over CLI. (requires purge 8.x-3.x-dev or newer for Drush 9 support)
- Modify your VCL to disable cache on certain pages like admin panel. Here’s an example, but lots will probably need to be changed for section.
- The blocks of code within
if (req.method == "BAN")and
if (req.method == "PURGE")are not necessary on section because bans are handled via the API.
- You may also want to prevent caching (pass) on pages with certain cache tags:
obj.http.Section-Cache-Tags ~ "4bt8"(hash of
obj.http.Section-Cache-Tags ~ "3vnt"(hash of
obj.http.Section-Cache-Tags ~ "r8q3"(hash of
- Alternately you can pass on caching pages if there is a session cookie.
- The blocks of code within
Download the Section Purger
This module can be found here. Download the latest release as a zip/tar file and load into your Drupal instance. We also support installing via composer.
Enable Purge and Section Purger Modules
Click the Extend tab in the admin console or otherwise navigate to
/admin/modules. If the Purge module is installed correctly, this page should contain a section called PURGE with various available submodules. Enable the
Purge Tokens, and
Purge UI submodules. We are also compatible with Drush but it is not required.
You also need to enable a way to process cache invalidation items. You choices are the
Cron processor and the
Late runtime processor.The
Cron Processor will process cache invalidations only when the cronjob is run (it runs automatically on a predefined schedule or you can initiate it manually from the admin console), while the
Late runtime processor will process the purge queue when a page is requested. It does not matter to our module whether you choose either or both, however in production environments, you should only be using cron as there would be a significant page load time increase with the late runtime processor as it would need to make an api request every time a purge is in the queue, and if the request times out the end-user may get a 500 internal server error thrown by Drupal.
Finally, enable the Section Purger module and the
Core Tags Queuer. This module ensures that Drupal sends the appropriate cache tags that our module uses to evict expired assets from the cache.
Safely store your Aperture Password with the key module
/admin/config/system/keys/add and input your section.io password. Use key type
Authentication, and choose whichever key provider you find to be the safest in your particular environment. (More info on this in the key module documentation).
Configure Full Page Cache Max Age
/admin/config/development/performance and set
Page Cache Max Age to whatever value you prefer. Since the extension is clearing the cache whenever a change event occurs, there is no need to wait for object resources to expire naturally and you can safely choose 1 year. Varnish Cache’s default behavior is to cache according to the cache-control headers on the response, but Varnish Cache can also be configured to set its own internal TTL value for cached objects based on content-type, status, or other response attributes. For more information on this, please see our Varnish Cache guides.
Enable the Section Purger within the Purge UI
/admin/config/development/performance. If your installation of the purge module succeeded, you’ll see a
Purge tab next to the
Performance tab at the top of the page.
Next, click on
Add Purger to open the UI to create a new Purger and select
Section Bundled Purger. Once created, you should see a flash message informing you that the purger has been successfully created.
The Section Bundled Purger combines API requests for tags, which reduces processing time on the origin, and potentially page load time if you are using the late runtime processor (cron is best for production environments).
Next, click on the small arrow next to the purger and click
configure. This will open the UI to fill in your account credentials and connect your Drupal module to the Section platform.
Drupal Site Name field should be the full hostname of the site for which you are configuring the purger, and is only necessary when setting up a Drupal 8 multisite. If your Drupal instance is not a multi-site, then this field can be left blank.
Varnish Proxy Instance Name field will usually be varnish. This name is defined in the section config in your application’s repository. This is useful if, for example you have multiple varnish instances that handle different things. You can set up a purger for each instance of varnish (if using Drupal site name, this would be per-instance and per-site-name)
Once here, input the details of the user account you would like to use to authenticate with our API. Once done, click
Save Configuration. Once saved and configured properly, the status bar on the right hand side should show all green as pictured below.
Check the logs to confirm that queuer is working (optional)
You can set the logging levels from the block on the right sidebar on the purge page.
You can view the logs at
Raise the timeout if necessary
If you are seeing timeout errors connecting to aperture, raise the timeout in the purger settings. We recommend a timeout of 2, but feel free to increase this to 5 when using the cron processor.