Developer mode

Developer mode supports an active development environment with full, writable file system permissions.

This option builds the Docker environment in developer mode and verifies configured service versions. On macOS and Windows systems, performance is slower in developer mode because of additional file synchronization operations. However, you can improve performance by using either the manual-native or the mutagen file synchronization option when you generate the docker-compose.yml file. See Synchronizing data in Docker.

Large files (>1 GB) can cause a period of inactivity. DB dumps and archive files—ZIP, SQL, GZ, and BZ2—are not necessary to sync. You can find exclusions to these file types in the mutagen.sh file.

Prerequisites:

• Complete the installation steps.
• Install file synchronization tools if needed.

To launch the Docker environment in developer mode:

1. In your local project root, generate the Docker Compose configuration file. You can use the service configuration options, such as --php, to specify a version.

   Copy
   ./vendor/bin/ece-docker build:compose --mode="developer"
   Copied to your clipboard
   ./vendor/bin/ece-docker build:compose --mode="developer"

   The --mode option in this step determines the mode in a later deploy step.

   If necessary, set the option for [synchronizing data in Docker][sync]. For example:

   Copy
   ./vendor/bin/ece-docker build:compose --mode="developer" --sync-engine="mutagen"
   Copied to your clipboard
   ./vendor/bin/ece-docker build:compose --mode="developer" --sync-engine="mutagen"

   You can further customize the Docker Compose configuration file by adding additional options to the build:compose command. For example, you can set the software version for a service, or add Xdebug configuration. See service configuration options.

2. Optional: If you have a custom PHP configuration file, copy the default configuration DIST file to your custom configuration file and make any necessary changes.

   Copy
   cp .docker/config.php.dist .docker/config.php
   Copied to your clipboard
   cp .docker/config.php.dist .docker/config.php

3. Build files to containers and run in the background.

   Copy
   docker compose up -d
   Copied to your clipboard
   docker compose up -d

4. If you selected the manual-native option, start the file synchronization.

   To copy all data from the local machine to the Docker volume:

   Copy
   ./bin/magento-docker copy-to --all
   Copied to your clipboard
   ./bin/magento-docker copy-to --all

   Also, you can provide a specific directory from the local machine to copy to the Docker volume, for example vendor:

   Copy
   ./bin/magento-docker copy-to vendor
   Copied to your clipboard
   ./bin/magento-docker copy-to vendor

   To copy all data from the Docker volume to the local machine:

   Copy
   ./bin/magento-docker copy-from --all
   Copied to your clipboard
   ./bin/magento-docker copy-from --all

   Also, you can provide a specific directory from the Docker volume to copy from, such as vendor:

   Copy
   ./bin/magento-docker copy-from vendor
   Copied to your clipboard
   ./bin/magento-docker copy-from vendor

5. If you selected mutagen for file synchronization, start the file synchronization.

   Copy
   bash ./mutagen.sh
   Copied to your clipboard
   bash ./mutagen.sh

   Important:

   If you host your Docker environment on Windows and the session start fails, update the mutagen.sh file to change the value for the --symlink-mode option to portable.

6. Install Adobe Commerce in your Docker environment.

   • For Adobe Commerce version 2.4 and 2.4.1 only, apply patches before you deploy.

     Copy
     docker compose run --rm deploy php ./vendor/bin/ece-patches apply
     Copied to your clipboard
     docker compose run --rm deploy php ./vendor/bin/ece-patches apply

   • Deploy Adobe Commerce in the Docker container.

     Copy
     docker compose run --rm deploy cloud-deploy
     Copied to your clipboard
     docker compose run --rm deploy cloud-deploy

   • Run post-deploy hooks.

     Copy
     docker compose run --rm deploy cloud-post-deploy
     Copied to your clipboard
     docker compose run --rm deploy cloud-post-deploy

   Developer mode does not require the build operation.

7. Configure and connect Varnish.

   Copy
   docker compose run --rm deploy magento-command config:set system/full_page_cache/caching_application 2 --lock-env
   Copied to your clipboard
   docker compose run --rm deploy magento-command config:set system/full_page_cache/caching_application 2 --lock-env

   Copy
   docker compose run --rm deploy magento-command setup:config:set --http-cache-hosts=varnish
   Copied to your clipboard
   docker compose run --rm deploy magento-command setup:config:set --http-cache-hosts=varnish

8. Clear the cache.

   Copy
   docker compose run --rm deploy magento-command cache:clean
   Copied to your clipboard
   docker compose run --rm deploy magento-command cache:clean

9. Access the local storefront by opening one of the following URLs in a browser:

   • http://magento2.docker

   • https://magento2.docker

10. Use the default credentials to log in to the Admin (https://magento2.docker/admin).

    • username = Admin
    • password = 123123q

11. Access the default email service: http://magento2.docker:8025

Last updated 9/11/2023

Was this helpful?

Yes

No