Project structure

Last update: February 3, 2025

CREATED FOR:

  • Admin
  • Developer

An Adobe Commerce on cloud infrastructure project includes essential files for credentials and application configuration. These files are available in as template according to the Adobe Commerce version. See the cloud templates based on Adobe Commerce version in the magento/magento-cloud GitHub repository.

The following table describes the files included in a cloud project:

FileDescription
/.magento/routes.yamlConfiguration file that redirects www to the apex domain and php application to serve HTTP. See Configure routes.
/.magento/services.yamlA configuration file that defines a MySQL instance (MariaDB), Redis, and OpenSearch or Elasticsearch. See Configure services.
/appThe code folder is used for custom modules. The design folder is used for custom themes. The etc folder contains configuration files for the application.
/m2-hotfixesUsed for custom patches.
/updateA service folder used by the support module.
.gitignoreSpecify which files and directories to ignore. See .gitignore reference.
.magento.app.yamlA configuration file that defines the properties to build your application. See Configure application.
.magento.env.yamlConfiguration file for the build, deploy, and post-deploy phases. The ece-tools package includes a sample of this file. See Configure environments.
composer.jsonFetches Adobe Commerce and the configuration scripts to prepare your application. See Required packages.
composer.lockStores version dependencies for every package. See Required packages.
magento-vars.phpUsed to define multiple stores and sites using variables.
NOTE
When you push your local changes to the remote server, the deploy script uses the values defined by configuration files in the .magento directory, then the script deletes the directory and its contents. Your local development environment is not affected.

Application root directory

The location of the application root directory depends on the environment.

  • Starter and Pro Integration: /app
  • Starter Production: /<project-ID>
  • Pro Staging: /<project-ID>_stg
  • Pro Production: /<project-ID>

Writable directories

The remote Integration, Staging, and Production environments are read only. The following directories are the only writable directories for security reasons:

  • var
  • pub/static
  • pub/media
  • app/etc
  • /tmp
NOTE
In Production and Staging environments, each node in the three-node cluster has a /tmp directory that is not shared with the other nodes.

Ignore files

There is a base .gitignore file with the Adobe Commerce on cloud infrastructure project repository. See the latest .gitignore file in the magento-cloud repository. To add a file that is in the .gitignore list, you can use the -f (force) option when staging a commit:

git add <path/filename> -f

Change base template

You can use the following steps to change the structure of an existing project to reflect the latest base template for Adobe Commerce on cloud infrastructure.

  1. Clone the project to a local workstation.

  2. Update the composer.json file with the following values for the extra section.

    "extra": {
    "magento-force": true
    "magento-deploystrategy": "copy"
}

  3. Add the .gitignore file designed for the base template. For example, if you need the .gitignore file for the version 2.2.6 template, use the .gitignore for 2.2.6 file as a reference.

  4. Clear the git cache.

    git rm -r --cached .

  5. Add and commit changes.

    git add -A && git commit -m "Update base template"
WARNING
The deployment process begins when you perform a merge, push, or synchronization of your environment, or when you trigger a manual redeployment, during which the Commerce application is in maintenance mode. For a Production environment, Adobe recommends completing this work during off-peak hours to avoid service disruptions.
Previous pageProject overview
Next pageUser access

Commerce


B2B Reimagined: Transforming Go-to-Market Strategies for Profitable Growth

Online | Strategy Keynote | General Audience

B2B brands are facing a digital revolution. Buyers expect hyper-relevant content and self-service, while internally AI is transforming...

Wed, Mar 19, 1:00 PM PDT (8:00 PM UTC)

Register

Put the Customer at the Center and Build Relationships That Last a Lifetime

Online | Strategy Keynote | General Audience

First impressions last a lifetime. Great first impressions feel personal, connected, and relevant right from the start. From the first...

Wed, Mar 19, 2:30 PM PDT (9:30 PM UTC)

Register

Connect with Experience League at Summit!

Get front-row access to top sessions, hands-on activities, and networking—wherever you are!

Learn more

Register now