Installing a Drupal distribution¶

Creating a Drupal website using Composer¶

Before creating a Drupal website on Cloud Platform, ensure that your development environment fulfills the following prerequisites:

• Install Composer
• Install Git

To create a Drupal website on Cloud Platform through Composer:

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

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

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

   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.

Related topics¶

• Creating a new application
• Choosing a Drupal distribution