Installing Drupal Starter Kits through Cloud IDE

This starter kit installs the following to your Drupal site:

• Drupal Starter Kits with Site Studio
• A UIKit

It provides drag-and-drop content authoring and low-code site building. An optional add-on content model is available during the installation process. For more information, see Enterprise low-code starter kit.

To install Drupal Starter Kits through the Enterprise low-code starter kit:

1. Access your Drupal project and run the following command:

   copy

   ./vendor/bin/acms acms:install
   

   Note

   Note

   Existing users who want to prevent rebuilding Composer dependencies repeatedly can leverage separate build and install commands. For more information, see Using separate build and install commands.

2. In Please choose bundle from one of the above use case, select acquia_cms_enterprise_low_code and press Enter.

   For selection, you can use the Up and Down arrow keys.

   Note

   Note

   The default value for this query is acquia_cms_enterprise_low_code. Therefore, the system considers the value to be acquia_cms_enterprise_low_code even if you do not specify any value.

3. In Do you want to enable demo content?, type yes to see the operation of Drupal Starter Kits with a content model with demo content and Site Studio components with demo content. Otherwise, type the default value, no.
   • If you type no:

     1. In Do you want to enable the content model?, type yes or no and press Enter.

        This question includes all content types in the site.

4. In Would you like to enable the Acquia DAM modules?, type yes to leverage Acquia DAM modules. Otherwise, type no.
5. In Would you like to add GDPR functionality to the site?, type yes to leverage community-contributed GDPR modules with Drupal Starter Kits. Otherwise, type no. For more information about these modules, see General Data Protection Regulation and EU Cookie Compliance (GDPR Compliance).

6. In Please provide the Google Maps API Key, type the Google Maps API key and press Enter.

   The starter kit wizard does not prompt for the key if you have already configured the environment variable with the export GMAPS_KEY="<your_key>" command. Also, you can skip this step if you do not have the key.

7. In Please provide the Site Studio API Key, type the Site Studio API key and press Enter.

   The starter kit wizard does not prompt for the key if you have already configured the environment variable with the export SITESTUDIO_API_KEY="<your_key>" command. Also, you can skip this step if you do not have the key.

8. In Please provide the Site Studio Organization Key, type the Site Studio Organization key and press Enter.

   The starter kit wizard does not prompt for the key if you have already configured the environment variable with the export SITESTUDIO_ORG_KEY="<your_key>" command. Also, you can skip this step if you do not have the key.

9. Specify the database information, such as name, driver, username, password, host, and port.

   Note

   Note

   To prevent failed installation, ensure that you:

   • Run a MySQL server on the system or use the correct host name or port number when trying to connect to the server.
   • Check that the TCP/IP port you are using is not blocked by a firewall or port blocking service.
   • Check that the database server is running.
   • Check that the database exists or the database users have sufficient privileges to create the database.
   • Enter the correct database name, username, password, hostname, and port.
10. Continue the installation process until you get the confirmation message.
11. If you are an existing Acquia customer who does not use the Site Studio Configuration Management module, do the following steps:

    1. (Optional) If you are already using the blt-site-studio plugin, remove it from your codebase by running the following command:

       copy

       composer remove acquia/blt-site-studio
       

       1. Remove the following lines from the blt/blt.yml file:

          copy

          site-studio:
            rebuild: true
            package-import: true
            cohesion-import: true
          

       Note

       Note

       If you do not leverage the blt-site-studio plugin but use custom scripts instead, ensure that you remove such references from your codebase.

12. Add the Site Studio Configuration Management module to your codebase by running the following command:

    copy

    composer require drupal/sitestudio_config_management
    

    1. Enable the module by running the following command:

       copy

       ./vendor/bin/drush en sitestudio_config_management -y
       

    2. Add the following lines to the settings.php file:

       copy

       $settings['config_sync_directory'] = '../config/default/sync';
       $settings['site_studio_sync'] = '../config/default/site_studio';
       

       Note

       Note

       • If your settings.php file already includes the paths for the config_sync_directory and site_studio_sync parameters, you can skip this step.
       • If your Drupal project has the Drupal Recommended Settings plugin pre-installed, you can skip this step as the system automatically updates the configuration properties in the settings.php file. For more information, see Using the Drupal Recommended Settings plugin.

    3. Verify the configuration import and export commands by running the following commands:

       copy

       ./vendor/bin/drush cex
       ./vendor/bin/drush cim
       

       These commands must automatically export or import Site Studio configurations along with Drupal configurations based on the paths specified in your settings.php file.

After you install Drupal Starter Kits, you can develop your Drupal site and deploy your changes to Cloud Next.

This starter kit installs Drupal Starter Kits to your Drupal site. An optional add-on content model is available during the installation process. For more information, see Community starter kit.

To install Drupal Starter Kits through the Community starter kit:

1. Access your Drupal project and run the following command:

   copy

   ./vendor/bin/acms acms:install
   

   Note

   Note

   Existing users who want to prevent rebuilding Composer dependencies repeatedly can leverage separate build and install commands. For more information, see Using separate build and install commands.

2. In Please choose bundle from one of the above use case, select acquia_cms_community and press Enter.

   For selection, you can use the Up and Down arrow keys.

3. In Do you want to enable demo content?, type yes to see the operation of Drupal Starter Kits with a content model with demo content and Site Studio components with demo content. Otherwise, type the default value, no.
   • If you type no:

     1. In Do you want to enable the content model?, type yes or no and press Enter.

        This question includes all content types in the site.

4. In Would you like to enable the Acquia DAM modules?, type yes to leverage Acquia DAM modules. Otherwise, type no.
5. In Would you like to add GDPR functionality to the site?, type yes to leverage community-contributed GDPR modules with Drupal Starter Kits. Otherwise, type no. For more information about these modules, see General Data Protection Regulation and EU Cookie Compliance (GDPR Compliance).

6. In Please provide the Google Maps API Key, type the Google Maps API key and press Enter.

   The starter kit wizard does not prompt for the key if you have already configured the environment variable with the export GMAPS_KEY="<your_key>" command. Also, you can skip this step if you do not have the key.

7. Specify the database information, such as name, driver, username, password, host, and port.

   Note

   Note

   To prevent failed installation, ensure that you:

   • Run a MySQL server on the system or use the correct host name or port number when trying to connect to the server.
   • Check that the TCP/IP port you are using is not blocked by a firewall or port blocking service.
   • Check that the database server is running.
   • Check that the database exists or the database users have sufficient privileges to create the database.
   • Enter the correct database name, username, password, hostname, and port.
8. Continue the installation process until you get the confirmation message.

After you install Drupal Starter Kits, you can develop your Drupal site and deploy your changes to Cloud Next.

This starter kit pre-configures Drupal for serving structured, RESTful content to third-party content displays, such as mobile apps, smart displays, and frontend driven websites. For more information, see Headless starter kit.

To install Drupal Starter Kits through the Headless starter kit:

1. Access your Drupal project and run the following command:

   copy

   ./vendor/bin/acms acms:install
   

   Note

   Note

   Existing users who want to prevent rebuilding Composer dependencies repeatedly can leverage separate build and install commands. For more information, see Using separate build and install commands.

2. In Please choose bundle from one of the above use case, select acquia_cms_headless and press Enter.

   For selection, you can use the Up and Down arrow keys.

3. In Do you want to enable demo content?, type yes to see the operation of Drupal Starter Kits with a content model with demo content and Site Studio components with demo content. Otherwise, type the default value, no.
   • If you type no:

     1. In Do you want to enable the content model?, type yes or no and press Enter.

        This question includes all content types in the site.

4. In Would you like to enable the Acquia DAM modules?, type yes to leverage Acquia DAM modules. Otherwise, type no.
5. In Would you like to preconfigure a next.js site?, type yes to configure a Next.js website. Otherwise, type no.
   • If you type yes:
     1. In Please provide the Next.js site url, type the Next.js site URL.
     2. In Please provide the Site Name, type the name of the site.
     3. In Please provide the .env.local file path, type the path of the .env.local file.

6. In Please provide the Google Maps API Key, type the Google Maps API key and press Enter.

   The starter kit wizard does not prompt for the key if you have already configured the environment variable with the export GMAPS_KEY="<your_key>" command. Also, you can skip this step if you do not have the key.

7. Specify the database information, such as name, driver, username, password, host, and port.

   Note

   Note

   To prevent failed installation, ensure that you:

   • Run a MySQL server on the system or use the correct host name or port number when trying to connect to the server.
   • Check that the TCP/IP port you are using is not blocked by a firewall or port blocking service.
   • Check that the database server is running.
   • Check that the database exists or the database users have sufficient privileges to create the database.
   • Enter the correct database name, username, password, hostname, and port.
8. Continue the installation process until you get the confirmation message.

After you install Drupal Starter Kits, you can develop your Drupal site and deploy your changes to Cloud Next.

This starter kit installs Acquia CMS to your Drupal site. An optional add-on content model is available during the installation process. For more information, see Community starter kit.

To install Acquia CMS through the Community starter kit:

1. Access your Drupal project and run the following command:

   ./vendor/bin/acms acms:install
   

   Note

   Existing users who want to prevent rebuilding Composer dependencies repeatedly can leverage separate build and install commands. For more information, see Using separate build and install commands.

2. In Please choose bundle from one of the above use case, select acquia_cms_community and press Enter.

   For selection, you can use the Up and Down arrow keys.

3. In Do you want to enable demo content?, type yes to see the operation of Acquia CMS with a content model with demo content and Site Studio components with demo content. Otherwise, type the default value, no.
   • If you type no:

     1. In Do you want to enable the content model?, type yes or no and press Enter.

        This question includes all content types in the site.

4. In Would you like to enable the Acquia DAM modules?, type yes to leverage Acquia DAM modules. Otherwise, type no.
5. In Would you like to add GDPR functionality to the site?, type yes to leverage community-contributed GDPR modules with Acquia CMS. Otherwise, type no. For more information about these modules, see General Data Protection Regulation and EU Cookie Compliance (GDPR Compliance).

6. In Please provide the Google Maps API Key, type the Google Maps API key and press Enter.

   The starter kit wizard does not prompt for the key if you have already configured the environment variable with the export GMAPS_KEY="<your_key>" command. Also, you can skip this step if you do not have the key.

7. Specify the database information, such as name, driver, username, password, host, and port.

   Note

   To prevent failed installation, ensure that you:

   • Run a MySQL server on the system or use the correct host name or port number when trying to connect to the server.
   • Check that the TCP/IP port you are using is not blocked by a firewall or port blocking service.
   • Check that the database server is running.
   • Check that the database exists or the database users have sufficient privileges to create the database.
   • Enter the correct database name, username, password, hostname, and port.
8. Continue the installation process until you get the confirmation message.

After you install Acquia CMS, you can develop your Drupal site and deploy your changes to Cloud Next.

This starter kit preconfigures Drupal for serving structured, RESTful content to third-party content displays, such as mobile apps, smart displays, and frontend driven websites. For more information, see Headless starter kit.

To install Acquia CMS through the Acquia CMS Headless starter kit:

1. Access your Drupal project and run the following command:

   ./vendor/bin/acms acms:install
   

   Note

   Existing users who want to prevent rebuilding Composer dependencies repeatedly can leverage separate build and install commands. For more information, see Using separate build and install commands.

2. In Please choose bundle from one of the above use case, select acquia_cms_headless and press Enter.

   For selection, you can use the Up and Down arrow keys.

3. In Do you want to enable demo content?, type yes to see the operation of Acquia CMS with a content model with demo content and Site Studio components with demo content. Otherwise, type the default value, no.
   • If you type no:

     1. In Do you want to enable the content model?, type yes or no and press Enter.

        This question includes all content types in the site.

4. In Would you like to enable the Acquia DAM modules?, type yes to leverage Acquia DAM modules. Otherwise, type no.
5. In Would you like to preconfigure a next.js site?, type yes to configure a Next.js website. Otherwise, type no.
   • If you type yes:
     1. In Please provide the Next.js site url, type the Next.js site URL.
     2. In Please provide the Site Name, type the name of the site.
     3. In Please provide the .env.local file path, type the path of the .env.local file.

6. In Please provide the Google Maps API Key, type the Google Maps API key and press Enter.

   The starter kit wizard does not prompt for the key if you have already configured the environment variable with the export GMAPS_KEY="<your_key>" command. Also, you can skip this step if you do not have the key.

7. Specify the database information, such as name, driver, username, password, host, and port.

   Note

   To prevent failed installation, ensure that you:

   • Run a MySQL server on the system or use the correct host name or port number when trying to connect to the server.
   • Check that the TCP/IP port you are using is not blocked by a firewall or port blocking service.
   • Check that the database server is running.
   • Check that the database exists or the database users have sufficient privileges to create the database.
   • Enter the correct database name, username, password, hostname, and port.
8. Continue the installation process until you get the confirmation message.

After you install Acquia CMS, you can develop your Drupal site and deploy your changes to Cloud Next.