Installing a Drupal distribution¶

1. Execute the following Composer commands on your local machine, with the Drupal version adjusted from 9.0.0 based on the latest stable version available on Drupal.org:

   composer create-project --no-install drupal/recommended-project:^9.0.0 .
   sed -i'.original' 's/web\//docroot\//g' composer.json && rm composer.json.original
   composer require drush/drush:^10.2 drupal/mysql56 --no-update
   composer update
   

   The Composer commands will do the following:

   • Create a Drupal project.

   • Ensure the Drupal uses an Acquia compatible directory structure.

   • Require the MySQL 5.6 contributed module, which is temporarily necessary to run Drupal 9 on Cloud Platform environments.

     Note

     This is not required if you are using MySQL 5.7.

   • Require Drush 10.2 or later.

2. Create a settings.php file and update it by following the instructions on the Acquia require line documentation page.

3. Commit and push your new project to Cloud Platform using Git.

4. Set your Cloud Platform environment to use PHP 7.4 or later.

5. If your environment has an existing database used by one of your earlier or existing Drupal websites, Acquia recommends you:

   • Perform a database backup.

   • Download your Cloud Platform Drush aliases.

   • Use Drush to drop the database on your Cloud Platform environment (replace @my.alias with the appropriate alias for your application and environment) as displayed in the following example:

     ./vendor/bin/drush @my.alias sql-drop
     

     This ensures you have a clean database for your Drupal 9 install.

6. Click the link in the Cloud Platform user interface to access the URL of the Cloud Platform environment and proceed to /core/install.php.

7. Follow the prompts on your website to complete the installation process.

1. Clone your Acquia repository into a new folder, such as ProjectName, and create a branch:

   git clone [email protected]:Sitename.git ProjectName
   cd ProjectName
   git checkout -b MyBranchName
   

2. Create composer.json and composer.lock files:

   composer create-project --no-install drupal/recommended-project .
   

   Important

   Ensure that you include the dot at the end.

3. Modify the composer.json file by replacing web with docroot. Use your preferred editor or run the following command:

   sed -i'.original' 's/web\//docroot\//g' composer.json
   

4. Add asset-packagist.org as another repository to provide access to supplement packages.drupal.org and provide access to additional packages:

   composer config repositories.1 composer https://asset-packagist.org
   

5. Configure the location and name of the vendor directory:

   composer config vendor-dir vendor
   

6. Select your preferred installation type from the following options:

   • source

   • dist

   • auto

   composer config preferred-install dist
   

7. Add the following useful projects:

   composer require drush/drush:^11.0 --no-update
   composer require drupal/stage_file_proxy --no-update
   composer require cweagans/composer-patches --no-update
   

8. (Optional) Add the following in the section labeled extra in your composer.json file for future patches. For more information, see Patching with Composer.

   Include these lines if you need to add a patch to core or a module:

   "enable-patching": true,
   "patches": {
      "drupal/[module_name]": {
         "Note regarding the nature of the patch being applied": "https://www.drupal.org/files/issues/[patch_name].patch"
      }
   },
   

9. Configure Composer to continue if a patch fails:

   composer config extra.composer-exit-on-patch-failure false
   

10. Add the following after the section labeled extra in your composer.json file. These scripts remove .git folders after each update to make sure git tracks all files:

    "scripts": {
       "post-install-cmd": [
          "find docroot vendor -name '.git' | xargs rm -rf",
          "find docroot vendor -name '.github' | xargs rm -rf"
       ],
       "post-update-cmd": [
          "find docroot vendor -name '.git' | xargs rm -rf",
          "find docroot vendor -name '.github' | xargs rm -rf"
       ]
    }
    

11. To install all dependencies, run the following command:

    composer install
    

12. To add your database connection, copy default.settings.php to the settings.php file, and modify the settings.php file by following the instructions on the Acquia require line page:

    cp docroot/sites/default/default.settings.php docroot/sites/default/settings.php
    

13. Add the following to your settings.php file for configuration management:

    $settings["config_sync_directory"] = $app_root . '/../config/' . basename($site_path);
    

14. Add and commit your code:

    git add .
    git commit -m "Initial commit of new Drupal core site."
    

15. Push your changes to the Acquia repository. To create a tracking branch on the remote repository, run the following command:

    git push --set-upstream origin MyBranchName
    

16. Navigate to your Cloud Platform application and switch the code to your branch on your preferred testing environment.

You can access the site page and follow the Drupal installation steps.