Local development

Cloud Docker for Commerce is the recommended tool for effective local development and testing of Adobe Commerce.

Prerequisites include the following software:

• Docker—Tools for managing images and building containers
• Mutagen—Developer mode on macOS systems might require this option for file synchronization
• Git—For interaction between your local system and Adobe Commerce on cloud infrastructure source repositories
• Optional—See PHP and Composer:
  • PHP version 8.1
  • Composer version 2.2.4

Docker settings

Cloud Docker for Commerce requires the following Docker resources to support local Docker development. You can allot these resources from the Preferences panel in Docker Desktop. Click the Settings icon next to your username, then choose the Resources tab.

• CPUs: 2
• Memory: 6.00 GB
• Swap: 1.00 GB

Commerce credentials

Before setting up a local workspace, gather the following credentials and account information:

• Authentication keys (Composer keys)

  Authentication keys are 32-character authentication tokens that provide secure access to the Adobe Commerce Composer repository (repo.magento.com), and any other Git services required for development such as GitHub. Your account can have multiple authentication keys. For the workspace setup, start with one specific key for your code repository. If you do not have any keys, contact the Account Owner to create them, or create the authentication keys yourself.

• (Optional) Cloud Project account

  The License Owner or Technical Admin (Super User) should invite you to the Adobe Commerce on cloud infrastructure project. When you receive the e-mail invitation, click the link and follow the prompts to create your account. See Onboarding to Commerce for details.

• (Optional) Encryption Key

  When importing an existing Adobe Commerce instance, capture the encryption key used to protect your access and data for the Adobe Commerce database. For details on this key, see Resolve issues with encryption key.

PHP and Composer

Cloud Docker for Commerce does not require PHP and Composer to be installed locally. Adobe provides an installation script to perform PHP and Composer operations.

The init-docker.sh script runs the following command, which installs the template dependencies and sets both the PHP version and the Cloud Docker for Commerce image version.

Copy
docker run --rm -e "MAGENTO_ROOT=/app" -v "$(pwd)":/app -v ~/.composer/cache:/root/.composer/cache "magento/magento-cloud-docker-php:${PHP_VERSION}-cli-${IMAGE_VERSION}" composer install --ansi
Copied to your clipboard
docker run --rm -e "MAGENTO_ROOT=/app" -v "$(pwd)":/app -v ~/.composer/cache:/root/.composer/cache "magento/magento-cloud-docker-php:${PHP_VERSION}-cli-${IMAGE_VERSION}" composer install --ansi

The script option settings determine the PHP version and Cloud Docker for Commerce image version. The script also adds the default hostname, magento2.docker, to your /etc/hosts file.

The following table lists the available options to use with the init-docker.sh script:

Examples

To run the script with default settings:

Copy
bin/init-docker.sh
Copied to your clipboard
bin/init-docker.sh

To install PHP 8.1 and skip adding the domain to the etc/hosts file:

Copy
bin/init-docker.sh --php 8.1 --add-host no
Copied to your clipboard
bin/init-docker.sh --php 8.1 --add-host no

On initial project installation, you can use cURL to run the installation script and install the template dependencies. See Update the hosts file and install dependencies.

Web server configuration

Cloud Docker for Commerce binds to port 80 on your host environment. Because macOS provides built-in Apache service, and may occupy port 80, you must stop the service. Also, if you have a web server enabled on your workstation, you must stop the service before launching the Docker environment.

Copy
sudo apachectl stop
Copied to your clipboard
sudo apachectl stop

Last updated 9/11/2023

Was this helpful?

Yes

No