README

This recipe provides configuration and settings files to help you set up a Drupal site optimized for the Pantheon hosting environment. It includes best-practice settings for file paths and integration with Pantheon's platform features.

What is Included?

• assets/pantheon.settings.php: Pantheon-specific settings, including file temp path overrides and integration with Pantheon-provided assets.
• assets/redis.settings.php: (If present) Redis cache integration settings for Drupal on Pantheon.
• assets/pantheon.yml: Example Pantheon configuration file to enable Redis and Solr services.

Composer Packages Included

This recipe requires several packages to optimize your Drupal site for Pantheon:

• drupal/imagemagick: Integrates the ImageMagick toolkit with Drupal for advanced image processing and better performance, recommended for Pantheon environments where image manipulation is required.
• drupal/pantheon_advanced_page_cache: Provides advanced page caching tailored for Pantheon, improving site speed and leveraging Pantheon's edge caching infrastructure.
• drupal/redis: Adds Redis integration for Drupal, enabling high-performance caching and session storage, which is supported and recommended on Pantheon for scalable sites.
• drupal/search_api_pantheon: Integrates Drupal's Search API with Pantheon's Solr service, allowing for robust, scalable search functionality optimized for Pantheon hosting.
• pantheon-systems/drupal-integrations: Contains Pantheon-specific integrations and helper code to ensure Drupal works seamlessly with Pantheon's platform features and workflows.

Installation Instructions

1. Copy Settings Files

   Copy the provided settings files into your Drupal site's sites/default/settings directory. For example:

   cp assets/pantheon.settings.php /path/to/docroot/sites/default/settings/pantheon.settings.php
   cp assets/redis.settings.php /path/to/docroot/sites/default/settings/redis.settings.php
   

   (Copy only the files you need. If you do not use Redis, you can skip the redis.settings.php file.)

2. Include Settings in Your Main Settings File

   Edit your sites/default/settings/includes.settings.php file and add the files to the $additionalSettingsFiles array;

3. Activate Redis and Solr Services on Pantheon

   To enable Redis (object cache) and Solr (search) services, add the following to your pantheon.yml file at the root of your repository:

   search:
     version: 8
   object_cache:
     version: 6.2
   

   You can use the provided example file at assets/pantheon.yml as a starting point. For more details on Pantheon YAML configuration, see the Pantheon documentation.

   NOTE: Don't forget to activate both services in the Pantheon Dashboard after adding them to your pantheon.yml.

Best Practices

• Do not commit sensitive information (such as database credentials) to version control.
• Always review and test settings in a non-production environment before deploying to live.
• For more information on Pantheon Drupal best practices, see Pantheon Docs.

This recipe is maintained for compatibility with Drupal 10/11 and Pantheon platform requirements.