The Acquia Drupal Recommended Settings plugin adds the recommended settings to the Drupal project, so developers won't have to edit settings.php manually.

The recommended settings includes:

• The required database credentials.
• Configuration sync directory path.
• File directory path i.e public/private etc.
• Acquia site studio sync directory path.

It allows your websites to be easily installed in both Acquia Cloud IDE & local and deployable on Acquia Cloud.

composer require acquia/drupal-recommended-settings

The Drupal Recommended Settings offer the multi-site feature out of the box. To configure a multi-site, run the following command, and the plugin will automatically generate the settings.php in the backend.

drush site:install --uri site1

The plugin offers various events that allow you to implement custom logic based on when these events are triggered. You can find the examples of such implementations from here.

<?php

/**
* @file
* Include DRS settings.
*/

use Acquia\Drupal\RecommendedSettings\Exceptions\SettingsException;
use Acquia\Drupal\RecommendedSettings\Settings;

// Create settings object.
$siteUri = "site1";
$settings = new Settings(DRUPAL_ROOT, $siteUri);

try {
 // Call generate method.
 $settings->generate();
}
catch (SettingsException $e) {
 echo $e->getMessage();
}

<?php

/**
 * @file
 * Include DRS settings.
 */

use Acquia\Drupal\RecommendedSettings\Exceptions\SettingsException;
use Acquia\Drupal\RecommendedSettings\Settings;

// Create settings object.
$siteUri = "site1";
$settings = new Settings(DRUPAL_ROOT, $siteUri);

// Database details.
$dbSpec = [
  'drupal' => [
    'db' => [
      'database' => 'drupal', // In case of multi-site database name is replaced with the site name.
      'username' => 'drupal',
      'password' => 'drupal',
      'host' => 'localhost',
      'port' => '3306',
    ],
  ],
];

try {
  // Call generate method passing database details.
  $settings->generate($dbSpec);
}
catch (SettingsException $e) {
  echo $e->getMessage();
}

Copyright (C) 2023 Acquia, Inc.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.