Creating a services.yml File for Drupal
Learn how to add a services.yml file for your Drupal site.Discuss in our Forum Discuss in Slack
Drupal allows users to easily define core services and environment-specific settings within the
sites/default/services.yml configuration file, eliminating the need for hacks to swap functionality. Creating or modifying this file is not required when installing a new Drupal site.
Production and Pre-production Service Configurations
services.yml files may contain environment-specific settings, such as debug-mode settings, or they may be used to configure settings that are applicable to all environments, such as configuring cache contexts, or setting the cookie domain. To avoid the potential for inadvertently deploying debug configuration to production in older Drupal versions, Pantheon placed
sites/default/services.yml in the
.gitignore file, to discourage users from committing this file to the repository.
In current versions, the
services.yml was removed from
.gitignore, and a new mechanism was introduced to control production vs. pre-production configuration changes. Now, in your
sites/default folder, you may use
services.pantheon.preproduction.yml to configure your on-Pantheon service configuration parameters for production and pre-production environments.
The table below illustrates which services file is used in which Pantheon environments:
|Pantheon Environment||Settings Filename|
|Test or Live|
|Dev or any Multidev|
Create and Modify services.yml
Make sure that you have updated your Drupal site to version 9 or higher.
Drupal 8 reached end-of-life status in November 2021, and is no longer supported by Drupal. Read the official announcement on Drupal.org.
Navigate to the
sites/defaultdirectory and create a new
servicesfile. Name it based on which environment you wish to configure settings for:
- All environments:
- Production environment:
- Pre-production environment:
- All environments:
Module specific services should be defined in a separate
.yml file, located in the root directory of the respective module (e.g.
View the following Drupal.org resources for more information: