--- title: "Codebase Prep for Site Factory Pt 1" date: "2023-06-22T09:05:03+00:00" summary: image: type: "article" url: "/site-factory/help/88661-codebase-prep-site-factory-pt-1" id: "044604d7-8c10-4683-93bb-717d7dc456d6" --- Table of contents will be added Goal ---- Use Cloud IDE to install a Drupal 10 and prepare a codebase for Acquia Site Factory (ACSF). Overview -------- In this comprehensive, three-part guide, I will show how to set up Cloud IDE, install Drupal 10, and finally prepare your codebase for Site Factory by giving it a custom [installation profile](/node/57347). We will leverage Acquia BLT helper scripts and recipes to standardize and accelerate what would otherwise be a lengthier sequence of manual steps. The approach covered here will enable you to install fresh new Drupal sites on ACSF using the current configuration files in your codebase. Additionally, I hope you will gain valuable insights into the end-to-end ACSF deployment workflow, as we will make a few codebase modifications and then push them out to existing ACSF sites. This guide has been divided into three parts so that you can pace yourself. 1. **Set up Cloud IDE, Install Drupal 10, and Prepare your Codebase for Site Factory** 2. [Create a Custom Profile and test New Site Creation with Site Factory](/tutorial/create-custom-profile-use-site-factory-part-2) 3. [Implementing Configuration Management and Proving out the Site Factory Deployment Workflow](/tutorial/implementing-configuration-management-site-factory-part-3) Let's get started. 1. Create your Cloud IDE instance ------------------------------ Login to your Acquia Cloud Platform account: ![Dashboard interface for Acquia TAM 2, showing environments, task log, and options to update code and refresh environments.](https://acquia.widen.net/content/990e92b0-c9d8-4f97-87de-89d569733f47/web/url_82e3080dee8911cea6f5083971322ffe.jpg) Click the “Actions” button and select “Create Cloud IDE”. Give a name to your new Cloud IDE instance and click the “Submit” button: ![Form to create a new Acquia Cloud IDE, labeled "Signorelli IDE," with one environment remaining. Options to cancel or submit.](https://acquia.widen.net/content/f58bcfda-0039-41de-9a08-109b525030d7/web/url_269ae84063dce33079e3a8b12cec2f2f.png) We want to install Drupal 10, so we need to make sure that the PHP version of our environments is set to PHP 8.1: ![Web interface showing PHP version selection for a cloud environment. "PHP 8.1" is selected. Options include PHP 7.0 to 8.1.](https://acquia.widen.net/content/7fc24030-15c4-45a3-a61c-1700a1c7d45b/web/url_51d16119536afe8e54adb56b0bb0a981.png) 2. Cloud IDE Configuration ----------------------- Open your Cloud IDE instance: ![Codebase_image1](https://acquia.widen.net/content/5181a24f-9a4b-48f4-9b2a-2aff51aa505f/web/21dd0_image1.png?w=832&itok=sPkEElkI) ![Acquia Cloud IDE interface with instructions for configuring, copying, or creating a new Drupal application. Features buttons for each step.](https://acquia.widen.net/content/394c7545-33ee-4e28-8025-871dfd4d3f08/web/url_6dba96da7c0e3861d4b0672824b6c681.jpg) Make sure the PHP version of your Cloud IDE is also set to PHP 8.1: php -v PHP 8.1.7 (cli) (built: Jul 6 2022 11:02:45) (NTS) Copyright (c) The PHP Group Zend Engine v4.1.7-dev, Copyright (c) Zend Technologies with Zend OPcache v8.1.7, Copyright (c), by Zend Technologies If your Cloud IDE instance is using an older version of PHP, [you can change it](/node/55934). On the “Get Started” page of your Cloud IDE, click the “Configure IDE” button to connect your IDE to your Cloud Platform account: ![Screenshot of a development environment with instructions to configure the IDE for a Drupal application, including terminal commands and prompts.](https://acquia.widen.net/content/cc52577e-e4a3-477a-aa19-7ef0e493014f/web/url_21ad6dce328d8316ad70335f76f6112e.jpg) 3. Create a new Drupal project --------------------------- The Acquia Drupal Recommended Project is a project template providing a great out-of-the-box experience for new Drupal 10 projects hosted on Acquia. It is based on the Drupal Recommended Project, with the principal difference being the addition of several modules and packages that provide the best possible out-of-the-box experience for Acquia customers. For this tutorial, We will use the 2.0.63 release of the Acquia Drupal Recommended Project:  [https://github.com/acquia/drupal-recommended-project/releases/tag/2.0.63](https://github.com/acquia/drupal-recommended-project/releases/tag/2.0.63) Open a new Terminal window in your Cloud IDE and execute the following composer command: composer create-project acquia/drupal-recommended-project:2.0.63 . Once the process has finished, you can check the current status of your Drupal project by typing "drush status": drush status Drupal version : 10.0.7 Site URI : https://012a8eea-282f-4017-90f5-7c1ec7f89a7c.web.ahdev.cloud PHP binary : /usr/local/php8.1/bin/php PHP config : /usr/local/php8.1/etc/cli/php.ini PHP OS : Linux PHP version : 8.1.7 Drush script : /usr/local/bin/drush Drush version : 11.5.1 Drush temp : /tmp Drush configs : /home/ide/.drush/drush.yml /home/ide/project/vendor/drush/drush/drush.yml Drupal root : /home/ide/project/docroot Site path : sites/default 4. Install Drupal 10 ----------------- Open your local Cloud IDE website to continue the Drupal 10 installation. On the Menu, navigate to “Manage Drupal Application” -> “Open Drupal Application” ![Code editor interface showing a project directory, with a menu option highlighting "Open Drupal Application."](https://acquia.widen.net/content/3c480452-1c16-4baa-be73-1cb0c3609720/web/url_220cc96a43368fddbecbcb4744a7dc82.png) Choose the language for your new site and click the “Save and continue” button: ![Drupal 10.0.7 installation screen showing a six-step process. "Choose language" is selected, with "English" in a dropdown menu.](https://acquia.widen.net/content/d7a5a1db-d6b9-415d-b7f4-d0f8ed842678/web/url_5fb6b9fb09f1795dc718ea6dcb234c98.png) For the installation profile, select “Standard”. Click the “Save and continue” button to continue: ![Codebase_image19](https://acquia.widen.net/content/bb5d048a-9e1f-4ef4-a45e-10cad390e4fc/web/975a0_image19.png?w=1090&itok=khmmrtN8) Leave the default Database type and enter “drupal” as the database, username, and password. Click the “Save and continue” button: ![Drupal setup screen showing database configuration options, including database type, name, username, password, and advanced options. "Save and continue" button below.](https://acquia.widen.net/content/1464843b-3a22-4d4c-9479-fad10c497ce2/web/url_f07b8878f2faba5b773f0f50c29cc199.png) Wait until the installation process has been completed. To complete the Drupal Installation Wizard, you will need to configure your new site and create credentials for the super admin user (uid1). Click the “Save and continue” button to proceed. ![Codebase_image5](https://acquia.widen.net/content/b296e0f0-17f8-41ce-8f86-bef8128222be/web/abef6_image5.png?w=1090&itok=ZxAB1XSJ) You should see your new Drupal 10 site: ![Drupal 10 site installation page with a welcome message and navigation menu.](https://acquia.widen.net/content/54255490-f6fb-4a7a-9692-a75bb371529a/web/url_f9897f30a51e420cd084284e94d7829c.png) Check the status of your new site using drush: drush status Signorelli IDE:~/project (main) $ drush status Drupal version : 10.0.7 Site URI : https://012a8eea-282f-4017-90f5-7c1ec7f89a7c.web.ahdev.cloud DB driver : mysql DB hostname : localhost DB port : 3306 DB username : drupal DB name : drupal Database : Connected Drupal bootstrap : Successful Default theme : olivero Admin theme : claro PHP binary : /usr/local/php8.1/bin/php PHP config : /usr/local/php8.1/etc/cli/php.ini PHP OS : Linux PHP version : 8.1.12 Drush script : /usr/local/bin/drush Drush version : 11.5.1 Drush temp : /tmp Drush configs : /home/ide/.drush/drush.yml /home/ide/project/vendor/drush/drush/drush.yml Install profile : standard Drupal root : /home/ide/project/docroot Site path : sites/default Files, Public : sites/default/files Files, Temp : /tmp Signorelli IDE:~/project (main) $ 5. Install BLT ----------- [https://docs.acquia.com/blt/install/adding-to-project/](/node/56461) At the command prompt, change to your existing project directory with the cd command.  To configure Composer’s minimum-stability and prefer-stable values, run: composer config minimum-stability dev composer config prefer-stable true Install BLT with the following Composer command: composer require acquia/blt:^13.0 ![Code editor displaying a JSON file and terminal commands for configuring a Drupal application, with highlighted text and installation messages.](https://acquia.widen.net/content/e9664d2c-a215-47ab-8a5a-15c14ac69c64/web/url_f8df803b8529960ce6172399b5996e68.jpg) 6. Preparing your codebase for Acquia Cloud Site Factory ----------------------------------------------------- ### Install Acquia BLT ACSF [https://github.com/acquia/blt-acsf](https://github.com/acquia/blt-acsf) composer require acquia/blt-acsf ### Install the ACSF Connector module [https://docs.acquia.com/site-factory/module/](/node/57075)  [https://www.drupal.org/project/acsf](https://www.drupal.org/project/acsf) composer require 'drupal/acsf:^2.73' Activate the ACSF module: drush en acsf Signorelli IDE:~/project (main *) $ drush en acsf The following module(s) will be enabled: acsf, acsf_duplication, acsf_theme, acsf_variables Do you want to continue? (yes/no) [yes]: > yes [success] Successfully enabled: acsf, acsf_duplication, acsf_theme, acsf_variables Signorelli IDE:~/project (main *) $ Configure the Site Factory Connector module in your codebase using BLT: [https://docs.acquia.com/site-factory/workflow/deployments/acsf-init/#adding-the-connector-module-to-your-codebase](/node/57356) blt recipes:acsf:init:all Download and extract the updated Acquia Cloud Site Factory Connector: [https://docs.acquia.com/site-factory/workflow/deployments/acsf-init/#executing-acsf-init-after-module-or-drupal-core-updates](/node/57356) (Run each time there is a core update) blt recipes:acsf:init:drush ![Terminal window displaying commands and outputs related to file copying and site configuration in a Drupal project.](https://acquia.widen.net/content/dae829cb-d51b-45a7-9f55-ae20ede69784/web/url_242df3ca48f8b7b270e2fde2eada7a09.png) ### Install the Config Ignore and Config Split modules [https://www.drupal.org/project/config\_ignore](https://www.drupal.org/project/config_ignore) composer require 'drupal/config_ignore:^2.4' Enable the Config Ignore module: drush en config_ignore Signorelli IDE:~/project (main *) $ drush en config_ignore The following module(s) will be enabled: config_ignore, config_filter Do you want to continue? (yes/no) [yes]: > yes [success] Successfully enabled: config_ignore, config_filter Signorelli IDE:~/project (main *) $ Install the Config Split module: composer require 'drupal/config_split:^1.9' --with-all-dependencies Enable the Config Ignore module: drush en config_split 7. Add my custom Drush Alias Generator bash script ----------------------------------------------- I wrote a custom bash script that simplifies the process of adding Drush aliases to your codebase. This will allow you to run Drush commands against your ACSF sites from your Cloud IDE instance with ease. Inside the project folder, next to the blt, config, and docroot folders, create the following new folders: cd /home/ide/project mkdir drush mkdir drush/sites Using nano or vim, create the new aliasgenerator.sh bash script: nano aliasgenerator.sh Copy the following code and paste it inside your new aliasgenerator.sh script. Follow the instructions inside to configure your bash script so it works with your ACSF account: #!/bin/bash # Author: Leonardo Signorelli # Websites: astralmemories.com, freewebtools.net, codesnippets.freewebtools.net # The Unlicense # ------------- # This is free and unencumbered software released into the public domain. # Anyone is free to copy, modify, publish, use, compile, sell, or # distribute this software, either in source code form or as a compiled # binary, for any purpose, commercial or non-commercial, and by any # means. # In jurisdictions that recognize copyright laws, the author or authors # of this software dedicate any and all copyright interest in the # software to the public domain. We make this dedication for the benefit # of the public at large and to the detriment of our heirs and # successors. We intend this dedication to be an overt act of # relinquishment in perpetuity of all present and future rights to this # software under copyright law. # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. # IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR # OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, # ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR # OTHER DEALINGS IN THE SOFTWARE. # For more information, please refer to # Instructions # ------------ # 1 - Add/Copy this bash script to the root of your ACSF codebase folder (Next to the config, and docroot folders). # 2 - Add your ACSF Application name to the acsf_app_name variable: acsf_app_name="acquiatam2" # 3 - Make this bash script executable with the following command: # chmod +x aliasgenerator.sh # 4 - Execute this script with the following command: # ./aliasgenerator.sh # 5 - Create a new Drush alias for an existing ACSF site and exit the script. # 6 - Now you should be able to execute drush commands against the selected ACSF site with the following structure: # drush @sitename.environment drush_command # Example: # drush @yoursite.01live status # Functions create_new_site_alias () { echo "Make sure to enter the name of a site you already created in your ACSF account." echo "Example: If the ACSF URL assigned to your new site is site1.${acsf_app_name}.acsitefactory.com" echo "Enter site1" echo " " confirmation="novalue" while [ $confirmation != "y" ] do echo -e "Provide the name of the site you want to create a Drush alias: \c " read site_name echo " " echo -e "Is this site name correct?: \"$site_name\" (Yes/No/Cancel = y/n/c)" read confirmation if [ $confirmation == "c" ]; then # Exit the While loop break fi done if [ $confirmation == "c" ]; then echo " " echo "Cancel! Going back to the Main Menu..." echo " " # Cancel this function and go back to the Main Menu return fi # Generate the drush alias for this new site... echo " " echo "Generating the drush alias for $site_name.." # Go to the sites folder inside the drush folder cd drush/sites/ # Create a new yml file for this site echo "01dev:" > $site_name.site.yml echo " uri: $site_name.dev-$acsf_app_name.acsitefactory.com" >> $site_name.site.yml echo " host: ${acsf_app_name}01dev.ssh.enterprise-g1.acquia-sites.com" >> $site_name.site.yml echo " options: { }" >> $site_name.site.yml echo " paths: { dump-dir: /mnt/tmp }" >> $site_name.site.yml echo " root: /var/www/html/$acsf_app_name.01dev/docroot" >> $site_name.site.yml echo " user: $acsf_app_name.01dev" >> $site_name.site.yml echo " ssh: { options: '-p 22' }" >> $site_name.site.yml echo "01live:" >> $site_name.site.yml echo " uri: $site_name.$acsf_app_name.acsitefactory.com" >> $site_name.site.yml echo " host: ${acsf_app_name}01live.ssh.enterprise-g1.acquia-sites.com" >> $site_name.site.yml echo " options: { }" >> $site_name.site.yml echo " paths: { dump-dir: /mnt/tmp }" >> $site_name.site.yml echo " root: /var/www/html/$acsf_app_name.01live/docroot" >> $site_name.site.yml echo " user: $acsf_app_name.01live" >> $site_name.site.yml echo " ssh: { options: '-p 22' }" >> $site_name.site.yml echo "01test:" >> $site_name.site.yml echo " uri: $site_name.test-$acsf_app_name.acsitefactory.com" >> $site_name.site.yml echo " host: ${acsf_app_name}01test.ssh.enterprise-g1.acquia-sites.com" >> $site_name.site.yml echo " options: { }" >> $site_name.site.yml echo " paths: { dump-dir: /mnt/tmp }" >> $site_name.site.yml echo " root: /var/www/html/$acsf_app_name.01test/docroot" >> $site_name.site.yml echo " user: $acsf_app_name.01test" >> $site_name.site.yml echo " ssh: { options: '-p 22' }" >> $site_name.site.yml # Go back cd ../../ echo " " echo "Ready! Going back to the Main Menu..." echo " " } # Splash screen echo " " echo " " echo " " echo " " echo " " echo " | Drush Alias Generator |" echo " " echo " " echo " " # Main Menu selection="novalue" while [ $selection != "2" ] do echo " " echo " |---------------------|" echo " | Main Menu |" echo " |---------------------|" echo " | 1 - New Drush Alias |" echo " | 2 - Exit |" echo " |---------------------|" echo " " echo -e "Select a number from the Main Menu: \c " read selection case "$selection" in 1) echo " " echo "Selected: New Drush Alias" echo "-------------------------" echo " " # Call the function create_new_site_alias ;; 2) echo " " echo "Selected: Exit" echo "--------------" ;; *) echo " " echo "Wrong Selection! Please try again..." echo " " ;; esac done echo " " echo "Exiting this script..." echo " " Save your changes. Make this bash script executable with the following command: chmod +x aliasgenerator.sh Use the following command to execute this script: ./aliasgenerator.sh 8. Edit your blt/blt.yml file -------------------------- To edit your blt/blt.yml file, you will need to find out the ID of your application and the URL of your Acquia repository. Go to your Acquia Platform account and click the “Product Keys” option from the left menu, your Application ID is listed under Username and Application UUID: ![Dashboard showing Acquia Cloud Platform product keys, including username and application UUID, with navigation menu on the left side.](https://acquia.widen.net/content/3a16f648-461d-4d66-9825-8a84ea15ea46/web/url_d02afbcf4151234da5b2d2045ccb69d2.jpg) To find out the URL of your Acquia repository, go to your Acquia Platform account and click the “Actions” to reveal the dropdown and select “View Git information”: ![Dashboard interface for Acquia TAM 2 - ACSF Sites, showing environments, actions menu, and options to update code or launch Cloud IDE.](https://acquia.widen.net/content/23d9c907-9a13-49ea-af95-28e01eb7b073/web/url_a5885971cb9b6db7b06f91f9e31b3bce.png) ![Git information window showing repository URL and basic Git commands for cloning, staging, committing, and pushing changes.](https://acquia.widen.net/content/e788b362-1f2d-4dbe-957e-7c4cdb775e57/web/url_c2fb0fa67d4f1b85a59e2e5ef702d604.png) Edit your blt/blt.yml file and replace its content with the following code: project: machine_name: d10acsf cloud: appId: 48efba74-75af-43ef-8455-32e6f043c375 git: default_branch: master remotes: cloud: '[email protected]:acquiatam2.git' deploy: tag_source: true drush: aliases: remote: site1.01test local: self ci: self default_alias: '${drush.aliases.local}' Replace the following three keys: machine\_name, appId, Acquia SVN git remote url: * machine\_name: YOUR\_MACHINE\_NAME (Example: d10acsf) * cloud: * appId: YOUR\_APP\_ID (Example: 48efba74-75af-43ef-8455-32e6f043c375) * git: * remotes: * cloud: YOUR\_ACQUIA\_GIT\_URL (Example: '[\[email protected\]](/cdn-cgi/l/email-protection#98f9fbe9edf1f9ecf9f5aad8ebeef6b5aaaba1a0b6fdf6ecfdeae8eaf1ebfdb5ffa9b6f0f7ebecf1f6ffb6f9fbe9edf1f9b6fbf7f5):acquiatam2.git') 9. Push your codebase to your remote repository -------------------------------------------- Create a new repository on GitHub.com ([https://github.com/new](https://github.com/new)). To avoid errors, do not initialize the new repository with README, license, or gitignore files. [https://github.com/new](https://github.com/new) I named my repository “d10acsf”: ![GitHub interface for creating a new repository, showing fields for repository name, description, privacy settings, and license options.](https://acquia.widen.net/content/dbf2d04f-ce67-448d-af53-812f13ff72d8/web/url_1a362cbd95ef98ca413574934da3ad45.png) Click the “Create Repository” button. To enable your IDE to push code to GitHub.com, [add the public key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account?platform=linux) to your GitHub.com account profile.(Visit [https://github.com/settings/profile](https://github.com/settings/profile) and select "SSH and GPG Keys" You can locate the public key within your IDE by navigating to ~/.ssh cd ~/.ssh Once you add the public key to GitHub.com, you can test whether the connection between your Cloud IDE and GitHub.com is working as follows: ssh -T [email protected] Finally, go back to your Cloud IDE instance and execute the following git commands to push your new codebase to your repository: git remote add origin https://github.com/astralmemories/d10acsf.git git branch -M main git push -u origin main Make sure to replace [https://github.com/astralmemories/d10acsf.git](https://github.com/astralmemories/d10acsf.git) with your own remote repository URL. Export the current Drupal configuration: drush cex Push your codebase changes to your repository: git add -A git commit -m "BLT-001: Base codebase commit." git push ![GitHub repository page showing files and recent commits. Right sidebar includes project details, languages, and license information.](https://acquia.widen.net/content/d876e327-a7ff-44d6-8b3f-40bd9451af28/web/url_d211aaa387bdbf2083a92a86c1198749.png) Congratulations on completing the initial phase of this three-step guide! You have navigated through the process of creating a new Drupal 10 codebase that is configured for ACSF. Now, let's head to the next phase where you will learn how to craft a custom Drupal installation profile. Next phase: [Create a Custom Profile and test New Site Creation with Site Factory](/tutorial/create-custom-profile-use-site-factory-part-2)