Thu Aug 29 2024 11:27:36 GMT+0000 (Coordinated Universal Time)
Drupal Recommended Settings (DRS) is a Composer-based plugin that minimizes the development effort by automating the changes required to run a Drupal site in Acquia Cloud, Cloud IDE, or your local machine.
It adds the following changes by updating the setting.php
file:
DRS supports multisite capability out-of-the box. To configure multisite, you only need to provide the –uri
parameter when using the site:install
command. For example:
drush site:install --uri site1
The following are the prerequisites to pass URL in the -uri
parameter:
Set up the first multi-site with URL:
example.sites.php
and paste it in your /sites/
folder.example.sites copy.php
to sites.php
.Ignore these steps if you have already set up multisite with a simple -uri
such as -uri=site1
or -uri=mysite
.
In sites.php
, add the URL that you want to pass in --uri
. For example:
$sites[‘acquia.com’] = ‘acquia’;
Run the URL in the –uri
parameter:
drush site:install --uri=”acquia.com”
Acquia directory is created under the sites folder.
Drupal projects created using the acquia/drupal-recommended-project
template include DRS out-of-the box. To create the Acquia Drupal recommended project, you can use the composer create-project acquia/drupal-recommended-project
command.
DRS is compatible with Drupal projects created using the drupal/recommended-project
template.
Create the Drupal recommended project:
composer create-project drupal/recommended-project project
Add DRS to the project:
composer require acquia/drupal-recommended-settings
Run the site:install
command:
drush site:install
Notice that the command picks up the default database credentials from local.settings.php
.
Verify multisite features by running the site install command with the -uri
option:
drush site:install --uri site1
Acquia will end support for BLT on December 31, 2024. Therefore, Acquia recommends you to use DRS instead of BLT.
In BLT 14 and later, DRS is included out-of-the box. With this upgrade, DRS provides the setting-generation logic instead of BLT.
If you use BLT 13 or earlier, you can upgrade to BLT 14 by running the migrate
command and automatically update the codebase to use BLT with DRS.
./vendor/bin/blt blt:migrate
After the update, the following changes occur:
Changes in settings.php
:
require DRUPAL_ROOT . "/../vendor/acquia/drupal-recommended-settings/settings/acquia-recommended.settings.php";
/**
* IMPORTANT.
*
* Do not include additional settings here. Instead, add them to settings
* included by `acquia-recommended.settings.php`. See Acquia's documentation for more detail.
*
* @link https://docs.acquia.com/
*/
Changes in local.settings.php
:
use Acquia\Drupal\RecommendedSettings\Helpers\EnvironmentDetector;
Acquia will end support for BLT on December 31, 2024. Therefore, Acquia recommends you to use DRS instead of BLT.
To migrate BLT to DRS:
Run the migrate
command to update the settings
and local.settings
files for each site in a multisite structure:
./vendor/bin/blt blt:migrate
Add DRS to the project:
composer require acquia/drupal-recommended-settings
Remove BLT from codebase:
composer remove acquia/blt
Remove the BLT directory from your repo root:
rm -rf blt
BLT plugins: Acquia recommends exploring composer-based automation for commands contained in BLT plugins such as Behat tests.
For example, the composer test that executes the necessary commands for tasks such as automated testing.
GrumPHP
can be configured to lint Twig.DRS uses a plugin to support Acquia Site Factory functionality. Sites using DRS can use drs-acsf
and run setup
commands to set up the codebase used for Site Factory.
Add and configure the drs-acsf
plugin to the project codebase.
Add the plugin:
composer require acquia/drs-acsf
Initialise acsf
:
./vendor/bin/drush drs:acsf:init:all
./vendor/bin/drush drs:acsf:init:drush
Validate all the settings:
./vendor/bin/drush validate:acsf
If this content did not answer your questions, try searching or contacting our support team for further assistance.