### Configure Installation Script Extension (ioncube)

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/extend-docker-configuration.md

Example configuration for installing the 'ioncube' extension using a provided installation script. This script downloads, extracts, and copies the ionCube loader.

```bash
cd /tmp
curl -O https://downloads.ioncube.com/loader_downloads/ioncube_loaders_lin_x86-64.tar.gz
tar zxvf ioncube_loaders_lin_x86-64.tar.gz
export PHP_VERSION=$(php -r "echo PHP_MAJOR_VERSION.'.'.PHP_MINOR_VERSION;")
export PHP_EXT_DIR=$(php-config --extension-dir)
cp "./ioncube/ioncube_loader_lin_">${PHP_VERSION}.so" "${PHP_EXT_DIR}/ioncube.so"
rm -rf ./ioncube
rm ioncube_loaders_lin_x86-64.tar.gz
```

```php
public static function getConfig(): array
...

            'ioncube' => [
                '>=7.0 <=7.3' => [
                    self::EXTENSION_TYPE => self::EXTENSION_TYPE_INSTALLATION_SCRIPT,
                    self::EXTENSION_INSTALLATION_SCRIPT => <<< BASH
cd /tmp
curl -O https://downloads.ioncube.com/loader_downloads/ioncube_loaders_lin_x86-64.tar.gz
tar zxvf ioncube_loaders_lin_x86-64.tar.gz
export PHP_VERSION=$(php -r "echo PHP_MAJOR_VERSION.'.'.PHP_MINOR_VERSION;")
export PHP_EXT_DIR=$(php-config --extension-dir)
cp "./ioncube/ioncube_loader_lin_">${PHP_VERSION}.so" "${PHP_EXT_DIR}/ioncube.so"
rm -rf ./ioncube
rm ioncube_loaders_lin_x86-64.tar.gz
BASH
                ],
            ],
...
```

--------------------------------

### Display Help for Commerce Cloud Docker Installation Script

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/setup/initialize-docker.md

Execute this command to view the available options and usage instructions for the `init-docker.sh` script. This is useful for customizing your Docker environment setup.

```bash
curl -sL https://github.com/magento/magento-cloud-docker/releases/download/1.3.5/init-docker.sh | bash -s -- --help
```

--------------------------------

### Clone and Start Code Server

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/README.md

Clones the adp-devsite repository, installs dependencies, and starts the code server for local development.

```bash
git clone https://github.com/AdobeDocs/adp-devsite
cd adp-devsite
npm install
npm run dev
```

--------------------------------

### Clone and Start Runtime Connector

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/README.md

Clones the devsite-runtime-connector repository, installs dependencies, and starts the runtime connector server for local development.

```bash
git clone https://github.com/aemsites/devsite-runtime-connector
cd devsite-runtime-connector
npm install
npm run dev
```

--------------------------------

### Start Content Server

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/README.md

Starts the content server for local development. This command should be run from your content repository.

```bash
npm run dev
```

--------------------------------

### Example build commands for Database Service

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/containers/index.md

Examples of build commands to configure the database service with specific versions or image types.

```bash
ece-docker build:compose --db <mariadb-version>
```

```bash
ece-docker build:compose --db <mysql-version> --db-image
```

--------------------------------

### Initialize Commerce Cloud Docker with Installation Script

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/setup/initialize-docker.md

Use this command to download and execute the initialization script for Commerce Cloud Docker. It installs template dependencies and configures the hosts file. Specify the PHP version using the --php option.

```bash
curl -sL https://github.com/magento/magento-cloud-docker/releases/download/1.3.5/init-docker.sh | bash -s -- --php 8.2
```

--------------------------------

### Start Cloud Docker Environment

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/test/application-testing.md

Start the Cloud Docker for Commerce environment. Developer Mode can be optionally enabled.

```bash
./bin/magento-docker up
```

--------------------------------

### Start Containers with Cloud Docker CLI

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/quick-reference.md

Use the `start` command to start previously stopped Docker containers.

```bash
./bin/magento-docker start
```

--------------------------------

### Start Mutagen File Synchronization

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/deploy/developer-mode.md

Starts the Mutagen file synchronization process. Ensure Mutagen is installed and configured.

```bash
bash ./mutagen.sh
```

--------------------------------

### Run PostDeploy Functional Test Example

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/test/code-testing.md

An example command to run the PostDeployCest functional test, verifying the post-deploy task.

```bash
./vendor/bin/codecept run Acceptance PostDeployCest

```

--------------------------------

### Start Docker Environment

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/deploy/production-mode.md

Builds files into containers and runs them in the background.

```bash
docker compose up -d
```

--------------------------------

### Add ece-tools and Cloud Docker Packages

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/setup/initialize-docker.md

Installs the `magento/ece-tools` and `magento/magento-cloud-docker` packages for an on-premises Adobe Commerce project. Use `--no-update` to defer package updates until after installation.

```bash
composer require --no-update --dev magento/ece-tools magento/magento-cloud-docker
```

--------------------------------

### Service Configuration Example

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/configuration-sources.md

Specifies the version and enabled status for a service like PHP. Ensure the version is compatible with your Adobe Commerce deployment.

```yaml
services:
  php:
    version: "8.2"
    enabled: true|false
```

--------------------------------

### Configure PECL Extension (gnupg)

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/extend-docker-configuration.md

Example configuration for adding the 'gnupg' extension using the PECL repository. Requires 'libgpgme11-dev' as an OS dependency.

```php
public static function getConfig(): array
...
            'gnupg' => [
                '>=7.0' => [
                    self::EXTENSION_TYPE => self::EXTENSION_TYPE_PECL,
                    self::EXTENSION_OS_DEPENDENCIES => ['libgpgme11-dev'],
                ],
            ],
...
```

--------------------------------

### Install Composer dependencies with Cloud Docker

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/setup/index.md

This command installs template dependencies and sets the PHP and Cloud Docker for Commerce image versions. It also adds the default hostname to your /etc/hosts file. Ensure MAGENTO_ROOT and PHP_VERSION/IMAGE_VERSION environment variables are set.

```bash
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
```

--------------------------------

### Redeploy Commerce Environment

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/test/application-testing.md

Redeploy the Commerce environment after starting the Docker containers.

```bash
./bin/magento-docker ece-redeploy
```

--------------------------------

### Run Composer Install with Docker

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/index.md

Execute Composer install within a Docker container, mounting the current directory and Composer cache. This is useful for CI/CD pipelines or initial setup. Ensure the PHP image tag matches your Adobe Commerce version.

```bash
docker run -it  -v $(pwd):/app/:delegated -v ~/.composer/:/root/.composer/:delegated magento/magento-cloud-docker-php:7.3-cli-1.1 bash -c "composer install&&chown www. /app/"
```

--------------------------------

### Restart Containers with Cloud Docker CLI

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/quick-reference.md

Execute the `restart` command to stop and then start all Docker containers.

```bash
./bin/magento-docker restart
```

--------------------------------

### Connect to Bash Shell with Cloud Docker CLI

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/quick-reference.md

Connect to the bash shell to start using the Cloud Docker CLI commands.

```bash
./bin/magento-docker bash
```

--------------------------------

### Add bcmath extension configuration

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/extend-docker-configuration.md

Specify the bcmath PHP core extension in the getConfig method of ExtensionResolver.php. This extension installs from docker-php-source images.

```php
public static function getConfig(): array
...

      'bcmath' => [
          '>=7.0' => [self::EXTENSION_TYPE => self::EXTENSION_TYPE_CORE],
       ],
       ...
```

--------------------------------

### Create Enterprise Edition Project with Composer

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/setup/initialize-docker.md

Installs the latest release of Adobe Commerce Enterprise Edition using Composer. To install a specific version, append the version number, e.g., `magento/project-enterprise-edition=2.4.6`.

```bash
composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition <install-directory-name>
```

--------------------------------

### Configure PHP Core Extension 'gd'

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/extend-docker-configuration.md

Example configuration for the PHP core extension 'gd' in ExtensionResolver.php. Specifies different configurations for PHP versions >=7.0 <=7.3 and >=7.4, including OS dependencies and configure options.

```php
public static function getConfig(): array
...
            'gd' => [
                '>=7.0 <=7.3' => [
                    self::EXTENSION_TYPE => self::EXTENSION_TYPE_CORE,
                    self::EXTENSION_OS_DEPENDENCIES => ['libjpeg62-turbo-dev', 'libpng-dev', 'libfreetype6-dev'],
                    self::EXTENSION_CONFIGURE_OPTIONS => [
                        '--with-freetype-dir=/usr/include/',
                        '--with-jpeg-dir=/usr/include/'
                    ],
                ],
                '>=7.4' => [
                    self::EXTENSION_TYPE => self::EXTENSION_TYPE_CORE,
                    self::EXTENSION_OS_DEPENDENCIES => ['libjpeg62-turbo-dev', 'libpng-dev', 'libfreetype6-dev'],
                    self::EXTENSION_CONFIGURE_OPTIONS => [
                        '--with-freetype=/usr/include/',
                        '--with-jpeg=/usr/include/'
                    ],
                ],

            ],
...
```

--------------------------------

### Set GitHub Token Environment Variable

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/test/code-testing.md

Set the GITHUB_TOKEN environment variable for package installations requiring GitHub authentication.

```bash
`export GITHUB_TOKEN=your_github_token

```

--------------------------------

### Build Docker Compose File with Developer Mode and PHP 8.1

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/containers/index.md

Use this command to start the Docker configuration generator in developer mode and specify a PHP version. This command generates the `docker-compose.yml` file.

```bash
./vendor/bin/ece-docker build:compose --mode="developer" --php 8.1
```

--------------------------------

### Configure InnoDB buffer pool size for DB container

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/containers/service.md

Set environment variables directly in the docker-compose.override.yml file to configure the database container. This example sets the innodb_buffer_pool_size.

```yaml
services:
  db:
    environment:
      - innodb-buffer-pool-size=134217728
```

--------------------------------

### Manage Docker Containers

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/deploy/index.md

These commands are used to manage the lifecycle of Docker containers. Use `stop` to suspend, `down` to stop and remove, and `start` to resume from a suspended state.

```bash
docker compose stop
```

```bash
docker compose down
```

```bash
docker compose start
```

--------------------------------

### Generated Docker Compose File

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/custom-docker-compose.md

This is an example of a `docker-compose.yaml` file generated by the `ece-docker build:custom:compose` command. It defines services, networks, and volumes for a Magento Cloud environment.

```yaml
version: '2.1'
services:
  db:
    hostname: db.magento2.test
    image: 'mariadb:10.2'
    environment:
      - MYSQL_ROOT_PASSWORD=magento2
      - MYSQL_DATABASE=magento2
      - MYSQL_USER=magento2
      - MYSQL_PASSWORD=magento2
    ports:
      - '3306'
    volumes:
      - '.docker/mnt:/mnt:rw,delegated'
      - 'magento-magento-db:/var/lib/mysql'
    healthcheck:
      test: 'mysqladmin ping -h localhost -pmagento2'
      interval: 30s
      timeout: 30s
      retries: 3
    command: '--auto_increment_increment=3 --auto_increment_offset=2'
    networks:
      magento:
        aliases:
          - db.magento2.test
  fpm:
    hostname: fpm.magento2.test
    image: 'magento/magento-cloud-docker-php:7.3-fpm-1.2.0'
    extends: generic
    volumes:
      - '.:/app:ro,delegated'
      - 'magento-vendor:/app/vendor:ro,delegated'
      - 'magento-generated:/app/generated:ro,delegated'
      - '.docker/mnt:/mnt:rw,delegated'
    networks:
      magento:
        aliases:
          - fpm.magento2.test
    depends_on:
      db:
        condition: service_healthy
  web:
    hostname: web.magento2.test
    image: 'magento/magento-cloud-docker-nginx:1.19-1.2.0'
    extends: generic
    volumes:
      - '.:/app:ro,delegated'
      - 'magento-vendor:/app/vendor:ro,delegated'
      - 'magento-generated:/app/generated:ro,delegated'
      - '.docker/mnt:/mnt:rw,delegated'
    environment:
      - WITH_XDEBUG=0
    networks:
      magento:
        aliases:
          - web.magento2.test
    depends_on:
      fpm:
        condition: service_started
  varnish:
    hostname: varnish.magento2.test
    image: 'magento/magento-cloud-docker-varnish:6.2-1.2.0'
    networks:
      magento:
        aliases:
          - varnish.magento2.test
    depends_on:
      web:
        condition: service_started
  tls:
    hostname: tls.magento2.test
    image: 'magento/magento-cloud-docker-nginx:1.19-1.2.0'
    extends: generic
    networks:
      magento:
        aliases:
          - magento2.test
    environment:
      UPSTREAM_HOST: varnish
    ports:
      - '8080:80'
      - '443:443'
    depends_on:
      varnish:
        condition: service_started
  generic:
    hostname: generic.magento2.test
    image: 'magento/magento-cloud-docker-php:7.3-cli-1.2.0'
    env_file: ./.docker/config.env
    environment:
      - 'PHP_EXTENSIONS=bcmath bz2 calendar exif gd gettext intl mysqli pcntl pdo_mysql soap sockets sysvmsg sysvsem sysvshm opcache zip xsl'
  build:
    hostname: build.magento2.test
    image: 'magento/magento-cloud-docker-php:7.3-cli-1.2.0'
    extends: generic
    volumes:
      - '.:/app:rw,delegated'
      - 'magento-vendor:/app/vendor:rw,delegated'
      - 'magento-generated:/app/generated:rw,delegated'
      - '~/.composer/cache:/root/.composer/cache:rw,delegated'
    networks:
      magento-build:
        aliases:
          - build.magento2.test
    depends_on:
      db:
        condition: service_healthy
  deploy:
    hostname: deploy.magento2.test
    image: 'magento/magento-cloud-docker-php:7.3-cli-1.2.0'
    extends: generic
    volumes:
      - '.:/app:ro,delegated'
      - 'magento-vendor:/app/vendor:ro,delegated'
      - 'magento-generated:/app/generated:ro,delegated'
      - '.docker/mnt:/mnt:rw,delegated'
    networks:
      magento:
        aliases:
          - deploy.magento2.test
    depends_on:
      db:
        condition: service_healthy
  mailhog:
    hostname: mailhog.magento2.test
    image: 'mailhog/mailhog:latest'
    ports:
      - '1026:1025'
      - '8026:8025'
    networks:
      magento:
        aliases:
          - mailhog.magento2.test
volumes:
  magento-vendor: {  }
  magento-generated: {  }
  magento-magento-db: {  }
networks:
  magento:
    driver: bridge
  magento-build:
    driver: bridge

```

--------------------------------

### Add Node Container to Docker Environment

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/containers/cli.md

Specify the Node version to install when adding the Node container to your Docker environment using the ece-docker build:compose command.

```bash
./vendor/bin/ece-docker build:compose --node <version>
```

--------------------------------

### Update Project Dependencies with Composer

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/setup/initialize-docker.md

Run this command to update your project's dependencies using Composer. Ensure Composer is installed and accessible in your environment.

```bash
composer update
```

--------------------------------

### Customizing Xdebug Configuration

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/test/configure-xdebug.md

Modify Xdebug configuration variables using the XDEBUG_CONFIG option. This example shows how to change the client host and port for Xdebug connections.

```bash
XDEBUG_CONFIG='client_host=host.docker.internal client_port=9002'
```

```bash
XDEBUG_CONFIG=client_host=host.docker.internal client_port=9002
```

--------------------------------

### Connect to CLI Container

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/manage-database.md

Use this command to connect to the CLI container within the Docker Compose setup. This is a prerequisite for executing database commands directly within the containerized environment.

```bash
docker compose run --rm deploy bash
```

--------------------------------

### Add Environment Variables to Docker Compose Override

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/manage-database.md

Customize the database container by setting environment variables directly in the `docker-compose.override.yml` file. This example sets the `innodb-buffer-pool-size`.

```yaml
db:
  environment:
    - innodb-buffer-pool-size=134217728
```

--------------------------------

### Rebuild Clean Docker Environment

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/containers/index.md

Use this command to remove all local Docker instance components, including containers, networks, and volumes, except for the persistent database and `magento-sync` volumes. This is useful for starting with a fresh environment.

```bash
bin/magento-docker down -v
```

--------------------------------

### Run init-docker.sh with default settings

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/setup/index.md

Execute the initialization script using default configurations for PHP and Cloud Docker image versions, and adding the default host to the hosts file.

```bash
bin/init-docker.sh
```

--------------------------------

### View All ece-docker build:compose Options

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/containers/index.md

Use this command to view all available options for the `ece-docker build:compose` command.

```bash
./vendor/bin/ece-docker build:compose --help
```

--------------------------------

### Connect to Valkey CLI

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/containers/service.md

Connect to the Valkey container and execute Valkey commands using `valkey-cli`. This command runs the client in a temporary container.

```bash
docker compose run --rm valkey valkey-cli -h valkey
```

--------------------------------

### Run init-docker.sh with custom PHP and hosts settings

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/setup/index.md

Use this command to specify a PHP version (e.g., 8.1) and to disable adding the default domain to the /etc/hosts file.

```bash
bin/init-docker.sh --php 8.1 --add-host no
```

--------------------------------

### View ece-docker build:compose Options

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/configuration-sources.md

Use this command to display all available configuration options for the ece-docker build:compose command. Refer to service configuration documentation for details on specific options.

```bash
php ./vendor/bin/ece-docker build:compose -h
```

--------------------------------

### Run Add Product Test

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/test/application-testing.md

Execute an MFTF test case for adding a product by SKU with an empty quantity.

```bash
docker compose run test mftf-command run:test AddProductBySkuWithEmptyQtyTest --debug=none
```

--------------------------------

### Require phpdotenv Composer Package

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/test/code-testing.md

Installs the vlucas/phpdotenv package, which is required to load environment variables from a .env file.

```bash
composer require "vlucas/phpdotenv": "^3.0"

```

--------------------------------

### Deploy Application with Cloud Docker CLI

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/quick-reference.md

Use the `ece-deploy` command to deploy the application after building.

```bash
./bin/magento-docker ece-deploy
```

--------------------------------

### View Cloud Docker CLI Help

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/quick-reference.md

Display the help message for the `magento-docker` CLI to see all available commands and options.

```bash
./bin/magento-docker -h
```

--------------------------------

### Run Post-Deploy Hooks with Cloud Docker CLI

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/quick-reference.md

Execute the `ece-post-deploy` command to run any necessary post-deployment scripts or hooks.

```bash
./bin/magento-docker ece-post-deploy
```

--------------------------------

### Access Database with Cloud Docker CLI

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/quick-reference.md

Use the `ece-db` command to access the project's database.

```bash
./bin/magento-docker ece-db
```

--------------------------------

### Run Tests for PHP 7.1

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/test/code-testing.md

Execute all tests for PHP 7.1 with steps enabled.

```bash
./vendor/bin/codecept run -g php71 --steps
```

--------------------------------

### Override Environment Variable in Docker Compose

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/extend-docker-configuration.md

Use a custom compose file to override default environment variables. This example sets ENABLE_SENDMAIL to false.

```yaml
version: '2'
services:
  deploy:
    environment:
      - ENABLE_SENDMAIL=false
```

--------------------------------

### Deploy Static Content with Build Container

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/containers/cli.md

Execute static content deployment commands manually from the build container. This allows for testing individual build process steps.

```bash
docker compose run --rm build magento-command setup:static-content:deploy
```

--------------------------------

### Run Ideal-State Wizard with Deploy Container

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/containers/cli.md

Use the deploy container to run the ideal-state wizard for checking project configuration. This command helps identify potential issues before deployment.

```bash
docker compose run --rm deploy ece-command wizard:ideal-state
```

--------------------------------

### Run Tests for PHP 7.2

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/test/code-testing.md

Execute all tests for PHP 7.2 with steps enabled.

```bash
./vendor/bin/codecept run -g php72 --steps
```

--------------------------------

### Run Tests for PHP 7.3

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/test/code-testing.md

Execute all tests for PHP 7.3 with steps enabled.

```bash
./vendor/bin/codecept run -g php73 --steps
```

--------------------------------

### Sample Test Execution Output

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/test/code-testing.md

Illustrates the typical output when running a Codeception functional test, including version information and test results.

```shell
Codeception PHP Testing Framework v2.5.6
Powered by PHPUnit 6.5.14 by Sebastian Bergmann and contributors.
Running with seed:
Acceptance Tests (1) -----------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------
-------------------------------------------------------------------------------
PostDeployCest: Test post deploy | {"ADMIN_EMAIL":"admin@example.com"}
 [Magento\MagentoCloud\Test\Functional\Robo\Tasks\GenerateDockerCompose] Running ./bin/ece-docker build:compose
 --mode=functional --php=7.2
...
...
✔ PostDeployCest: Test post deploy | {"ADMIN_EMAIL":"admin@example.com"} (210.41s)

```

--------------------------------

### Require Magento Cloud Docker Dependency

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/test/code-testing.md

Install the necessary Magento Cloud Docker package using Composer. This is a prerequisite for testing specific packages like magento/magento-cloud-patches and magento/magento-cloud-components.

```bash
composer require "magento/magento-cloud-docker:^1.0.0" --no-update
```

--------------------------------

### Resume Docker environment

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/quick-reference.md

Resumes a stopped Docker environment for Cloud Docker for Commerce.

```bash
docker compose start
```

--------------------------------

### Customize ActiveMQ Artemis Environment Variables

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/containers/service.md

Add custom environment variables to the `docker-compose.override.yml` file to configure the ActiveMQ Artemis container. This example sets the minimum and maximum memory allocation for the broker.

```yaml
services:
  activemq-artemis:
    environment:
      - ARTEMIS_MIN_MEMORY=512M
      - ARTEMIS_MAX_MEMORY=2048M
```

--------------------------------

### Build Application with Cloud Docker CLI

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/quick-reference.md

Execute the `ece-build` command to build the application within the Docker environment.

```bash
./bin/magento-docker ece-build
```

--------------------------------

### Recreate Docker Containers with Build

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/extend-docker-configuration.md

Force recreation of Docker containers with a build to update configurations and test changes iteratively.

```bash
docker compose up -d --force-recreate --build
```

--------------------------------

### Navigate to PHP directory

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/extend-docker-configuration.md

Change the current directory to the PHP source directory within the Cloud Docker for Commerce project.

```bash
cd magento-cloud-docker/src/Compose/Php
```

--------------------------------

### Skip Elasticsearch container configuration

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/containers/service.md

Generate the Docker Compose configuration file while skipping the Elasticsearch container setup. This is useful for older Adobe Commerce versions that use MySQL search instead of Elasticsearch.

```bash
ece-docker build:compose --no-es
```

--------------------------------

### Enable Varnish Cache

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/test/application-testing.md

Enable the Varnish cache for the Magento application and configure HTTP cache hosts.

```bash
docker compose run deploy magento-command config:set  system/full_page_cache/caching_application 2 --lock-env
```

```bash
docker compose run deploy magento-command setup:config:set  --http-cache-hosts=varnish
```

--------------------------------

### Run Post-Deploy Hooks

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/deploy/production-mode.md

Executes post-deployment hooks after Adobe Commerce has been deployed.

```bash
docker compose run --rm deploy cloud-post-deploy
```

--------------------------------

### Connect to Redis CLI

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/containers/service.md

Connect to the Redis container and execute Redis commands using `redis-cli`. This command runs the client in a temporary container.

```bash
docker compose run --rm redis redis-cli -h redis
```

--------------------------------

### Run Docker on Custom Host and Port

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/index.md

Configure Docker to run on a custom host and port by adding the --host and --port options to the ece-docker build:compose command. Update your /etc/hosts file to map the custom host to 127.0.0.1.

```bash
./vendor/bin/ece-docker build:compose --host=magento2.test --port=8080
```

--------------------------------

### Generate docker-compose.yml with Test Support

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/test/application-testing.md

Generate the docker-compose.yml file, ensuring to include options for Selenium and testing.

```bash
./vendor/bin/ece-docker build:compose --with-selenium --with-test
```

--------------------------------

### List Docker images

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/quick-reference.md

Lists the Docker images used by the Cloud Docker for Commerce environment.

```bash
docker compose images
```

--------------------------------

### Build MFTF Project

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/test/application-testing.md

Build the MFTF project within the test container to prepare for test generation.

```bash
docker compose run test mftf-command build:project
```

--------------------------------

### Run Tests for PHP 7.4

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/test/code-testing.md

Execute all tests for PHP 7.4 with steps enabled.

```bash
./vendor/bin/codecept run -g php74 --steps
```

--------------------------------

### Build and Deploy Hooks Configuration

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/configuration-sources.md

Defines custom commands to be executed during the build and deploy phases. Ensure commands are correctly formatted and paths are valid.

```yaml
hooks:
  build: |
    set -e
    php ./vendor/bin/ece-tools run scenario/build/generate.xml
    php ./vendor/bin/ece-tools run scenario/build/transfer.xml
  deploy: |
    php ./vendor/bin/ece-tools run scenario/deploy.xml
  post_deploy: |
    php ./vendor/bin/ece-tools run scenario/post-deploy.xml
```

--------------------------------

### Configure Varnish HTTP Cache Hosts

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/deploy/production-mode.md

Sets the HTTP cache hosts for Varnish using the magento-command.

```bash
docker compose run --rm deploy magento-command setup:config:set --http-cache-hosts=varnish
```

--------------------------------

### Write Repository Credentials to .env File

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/test/code-testing.md

Appends repository username and password to the .env file for environment configuration.

```bash
echo "REPO_USERNAME=your_public_key" >> ./.env

```

```bash
echo "REPO_PASSWORD=your_private_key" >> ./.env

```

--------------------------------

### Build Custom Docker Image

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/extend-docker-configuration.md

Build a custom Docker image with a specific tag and version using the Docker build command.

```bash
docker build -t test/<service-name>:<service-version>
```

--------------------------------

### Configure Varnish Cache Application

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/deploy/production-mode.md

Configures the Varnish cache application using the magento-command.

```bash
docker compose run --rm deploy magento-command config:set system/full_page_cache/caching_application 2 --lock-env
```

--------------------------------

### Execute ece-tools command

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/quick-reference.md

Use this command to execute an `ece-tools` command within the Cloud Docker for Commerce environment. Replace `<command>` with your desired command. The `--rm` option automatically removes containers when they stop.

```bash
docker compose run --rm deploy ece-command <command>
```

--------------------------------

### Define default PHP extensions

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/extend-docker-configuration.md

Add 'bcmath' to the DEFAULT_PHP_EXTENSIONS array in ExtensionResolver.php to enable the extension by default.

```php
/**
 * Extensions which should be installed by default
 */
public const DEFAULT_PHP_EXTENSIONS = [
    'bcmath',
    'bz2',
    'calendar',
    'exif',
    'gd',
    'gettext',
    'intl',
    'mysqli',
    'pcntl',
    'pdo_mysql',
    'soap',
    'sockets',
    'sysvmsg',
    'sysvsem',
    'sysvshm',
    'opcache',
    'zip',
];
```

--------------------------------

### Copy Custom PHP Configuration

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/deploy/production-mode.md

Optional: Copies the default PHP configuration DIST file to a custom configuration file for modifications.

```bash
cp .docker/config.php.dist .docker/config.php
```

--------------------------------

### Build custom Docker Compose with JSON configuration

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/custom-docker-compose.md

Use this command to generate a custom `docker-compose.yaml` file by providing environment settings as a JSON array. This is the quickest way to modify your environment.

```bash
ece-docker build:custom:compose --json-file=<path/to/your/json/configuration>
```

--------------------------------

### Run Admin Login Test

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/test/application-testing.md

Execute a specific MFTF test case, such as the AdminLoginTest.

```bash
docker compose run test mftf-command run:test AdminLoginTest --debug=none
```

--------------------------------

### Connect to Database via Docker CLI

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/manage-database.md

Connect to the database using the 'mysql' command with specified host, username, and password. This method is used when connected to the CLI container.

```bash
mysql --host=db --user=magento2 --password=magento2
```

```bash
mysql --host=db-quote --user=magento2 --password=magento2
```

```bash
mysql --host=db-sales --user=magento2 --password=magento2
```

--------------------------------

### Build Adobe Commerce in Docker

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/deploy/production-mode.md

Builds Adobe Commerce within the Docker container.

```bash
docker compose run --rm build cloud-build
```

--------------------------------

### Build Docker Compose File

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/deploy/production-mode.md

Generates the Docker compose file for the environment. Use service configuration options like --php to specify a version.

```bash
./vendor/bin/ece-docker build:compose
```

--------------------------------

### List Docker containers and ports

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/quick-reference.md

Lists the running Docker containers and their exposed ports for the Cloud Docker for Commerce environment. You can use either `docker compose ps` or `docker ps`.

```bash
docker compose ps
```

```bash
docker ps
```

--------------------------------

### Add Subdomains to /etc/hosts

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/multiple-sites.md

Add each subdomain you intend to use for your websites or stores to the `/etc/hosts` file. This maps the subdomains to the local Docker environment.

```conf
127.0.0.1 magento2.docker
127.0.0.1 second.magento2.docker
```

--------------------------------

### Verify vm.max_map_count setting

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/get-support.md

After updating the sysctl configuration file and rebooting, use this command to verify that the vm.max_map_count setting has been permanently updated.

```bash
sysctl vm.max_map_count
```

--------------------------------

### Navigate to PHP FPM image directory

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/extend-docker-configuration.md

Change the current directory to the PHP FPM image directory within the Cloud Docker for Commerce project.

```bash
cd ../../../images/php/fpm
```

--------------------------------

### Navigate to PHP CLI image directory

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/extend-docker-configuration.md

Change the current directory to the PHP CLI image directory within the Cloud Docker for Commerce project.

```bash
cd ../cli
```

--------------------------------

### Configure OpenSearch Container with Custom JVM Options

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/containers/service.md

Use the --os-env-var option to set JVM heap size and enable memory lock for the OpenSearch container when generating the Docker Compose file.

```bash
php vendor/bin/ece-docker build:compose --os-env-var=OPENSEARCH_JAVA_OPTS="-Xms512m -Xmx512m" --os-env-var=bootstrap.memory_lock=true
```

--------------------------------

### Run Docker Compose with Multiple Files

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/extend-docker-configuration.md

Execute Docker Compose commands by specifying multiple configuration files to merge their settings.

```bash
docker compose -f docker-compose.yml -f docker-compose-dev.yml run deploy bash
```

--------------------------------

### Build Custom Docker Compose

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/custom-docker-compose.md

Use this command to generate a custom docker-compose.yaml file. Provide a JSON object to specify image names, versions, and service configurations.

```bash
./vendor/bin/ece-docker build:custom:compose '{"name":"magento","system":{"mode":"production","host":"magento2.test","port":"8080","db":{"increment_increment":3,"increment_offset":2},"mailhog":{"smtp_port":"1026","http_port":"8026"}},"services":{"php":{"image":"php-v1","version":"7.4","enabled":true},"php-cli":{"image-pattern":"%s:%s-cli"},"php-fpm":{"image-pattern":"%s:%s-fpm"},"mysql":{"image":"mariadb-v1","version":"10.3","image-pattern":"%s:%s","enabled":true},"redis":{"image":"redis-v1","enabled":"true","version":"5"},"elasticsearch":{"image":"elasticsearch-v1","image-pattern":"%s:%s","enabled":true,"version":"7.6"},"varnish":{"image":"varnish-v1","image-pattern":"%s:%s","enabled":true,"version":"6.2"},"nginx":{"image":"nginx-v1","version":"1.19","image-pattern":"%s:%s","enabled":"true"},"test":{"enabled":true}},"mounts":{"var":{"path":"var"},"app-etc":{"path":"app\/etc"},"pub-media":{"path":"pub\/media"},"pub-static":{"path":"pub\/static"}}}'
```

--------------------------------

### Configure Codeception to Load Environment Variables

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/test/code-testing.md

Specifies parameters for Codeception to load environment variables from the .env file.

```yaml
params:
    - tests/functional/configuration.dist.yml
    - env
    - .env

```

--------------------------------

### Build custom Docker Compose with custom images and versions

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/custom-docker-compose.md

For Commerce Cloud Docker 1.2 and later, specify custom images and their versions using this command. Ensure your JSON configuration includes the image details.

```bash
ece-docker build:custom:compose --json-file=<path/to/your/json/configuration> --images-file=<path/to/your/images.json>
```

--------------------------------

### Configure HTTP Cache Hosts

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/test/blackfire.md

Set the HTTP cache hosts to Varnish. This command ensures that Varnish is recognized as the HTTP cache.

```bash
docker compose run --rm deploy magento-command setup:config:set  --http-cache-hosts=varnish
```

--------------------------------

### Mount custom my.cnf file to DB container

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/containers/service.md

Inject a custom MySQL configuration into the database container by mounting a my.cnf file. This is done within the 'services' section of the docker-compose.override.yml file.

```yaml
services:
  db:
    volumes:
      - path/to/custom.my.cnf:/etc/mysql/conf.d/custom.my.cnf
```

--------------------------------

### Connect to Database via Port

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/manage-database.md

Connect to the database using the 'mysql' command, specifying the host, port, username, and password. This method is used when connecting directly to the database port exposed by Docker.

```bash
mysql -h127.0.0.1 -P32769 -umagento2 -pmagento2
```

```bash
mysql -h127.0.0.1 -32873 -umagento2 -pmagento2
```

```bash
mysql -h127.0.0.1 -32874 -umagento2 -pmagento2
```

--------------------------------

### Deploy Adobe Commerce in Docker

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/deploy/production-mode.md

Deploys Adobe Commerce within the Docker container.

```bash
docker compose run --rm deploy cloud-deploy
```

--------------------------------

### Navigate to Service Version Directory

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/extend-docker-configuration.md

Change the current directory to the location of existing service version configurations within the magento-cloud-docker project.

```bash
cd magento-cloud-docker/images/<service-name>
```

--------------------------------

### Add all changes to Git staging

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/upgrade-docker-package.md

Stage all modified and new files for the next commit.

```bash
git add -A
```

--------------------------------

### Add Custom my.cnf to Docker Compose Override

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/manage-database.md

Configure the database container by mounting a custom `my.cnf` file into the `/etc/mysql/conf.d/` directory within the container. This allows for custom MySQL configurations.

```yaml
db:
  volumes:
    - path/to/custom.my.cnf:/etc/mysql/conf.d/custom.my.cnf
```

--------------------------------

### Generate updated PHP Dockerfile

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/extend-docker-configuration.md

Execute a command to generate an updated Dockerfile for all PHP image versions included in the Cloud Docker for Commerce package.

```bash
bin/ece-docker image:generate:php
```

--------------------------------

### Build Docker Compose with Zookeeper

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/containers/service.md

Build the Docker compose file including the Zookeeper container using the `ece-docker build:compose` command. Specify the PHP version with the `--php` flag.

```bash
./vendor/bin/ece-docker build:compose --php <version> --with-zookeeper
```

--------------------------------

### List Docker Compose Services

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/manage-database.md

Run this command to list all running services managed by Docker Compose and their associated ports. This is helpful for identifying the dynamic port mapping for the database service.

```bash
docker compose ps
```

--------------------------------

### Create External Docker Volume

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/containers/index.md

If the `magento-sync` volume is missing, you can create it manually using this Docker command. This volume is essential for file synchronization between the host and containers.

```bash
docker volume create --name=magento-sync
```

--------------------------------

### Clone Commerce Cloud Tools Repository

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/test/code-testing.md

Use this command to clone the GitHub repository for the specific Cloud Suite for Commerce package you intend to test. Ensure you have SSH access configured for GitHub.

```bash
git clone git@github.com:magento/<cloud-suite-package-repository>.git
```

```bash
git clone git@github.com:magento/ece-tools.git
```

--------------------------------

### Add Blackfire Configuration to .magento.app.yaml

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/test/blackfire.md

Add this configuration to the `runtime:extensions` section of your `.magento.app.yaml` file. Ensure you replace placeholder values with your actual Blackfire credentials.

```yaml
runtime:
  extensions:
    - random-extension-here
    - 
      name: blackfire
      configuration:
        server_id: SERVER_ID
        server_token: SERVER_TOKEN
        client_id: CLIENT_ID
        client_token: CLIENT_TOKEN
```

--------------------------------

### Unified Configuration Structure

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/configuration-sources.md

Defines the top-level sections for the unified configuration file. Use this to structure your Docker environment settings.

```conf
services: [] # List of services
variables: [] # List of environment variables
hooks: [] # List of available hooks
mounts: [] #l List of available mounts
```

--------------------------------

### Dump Database with Magento Cloud CLI

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/manage-database.md

Use this command to create a local copy of the remote database. It runs `mysqldump` with the `--single-transaction` flag for non-locking backups.

```bash
magento-cloud db:dump
```

--------------------------------

### Configure MFTF Environment Variables

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/test/application-testing.md

Set environment variables required for MFTF testing within the Docker environment. Adjust URLs and credentials for remote environments.

```bash
CONFIG="MAGENTO_BASE_URL=http://magento2.docker/
CREDENTIALS=\"magento/MAGENTO_ADMIN_PASSWORD=123123q\"
MAGENTO_BACKEND_NAME=admin
MAGENTO_ADMIN_USERNAME=admin
MAGENTO_ADMIN_PASSWORD=123123q
MODULE_ALLOWLIST=Magento_Framework,Magento_ConfigurableProductWishlist,Magento_ConfigurableProductCatalogSearch
SELENIUM_HOST=selenium"
```

--------------------------------

### Enable Detailed Output for Functional Tests

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/test/code-testing.md

Configures Codeception to display detailed output for functional tests by setting printOutput to true in the test configuration.

```yaml
modules:
  config:
    Magento\CloudDocker\Test\Functional\Codeception\TestInfrastructure:
      ...
      printOutput: true
      ...
    Magento\CloudDocker\Test\Functional\Codeception\Docker:
      ...
      printOutput: true
      ...

```

--------------------------------

### Add custom my.cnf file to MariaDB configuration directory

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/containers/service.md

Add a custom my.cnf file to the MariaDB configuration directory within the Docker environment. This method involves copying the custom configuration file to the specified directory.

```bash
cp custom.cnf .docker/mysql/mariadb.conf.d
```

--------------------------------

### Generate Custom Docker Compose

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/custom-docker-compose.md

Use this command to generate a custom `docker-compose.yaml` file. Provide a JSON object with desired configurations for services like database, PHP, and mailhog.

```bash
./vendor/bin/ece-docker build:custom:compose '{"name":"magento","system":{"mode":"production","host":"magento2.test","port":"8080","db":{"increment_increment":3,"increment_offset":2},"mailhog":{"smtp_port":"1026","http_port":"8026"}},"services":{"php":{"version":"7.3","enabled":true,"extensions":{"enabled":["xsl"]}},"mysql":{"version":"10.2","image":"mariadb","enabled":true}, "mailhog": {"enabled":true}}}'
```

--------------------------------

### Write Configuration to MFTF File

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/test/application-testing.md

Write the MFTF configuration to the .env file within the Docker deploy container.

```bash
docker compose run deploy bash -c "echo \"$CONFIG\" > /app/dev/tests/acceptance/.env"
```

--------------------------------

### Default Cloud Docker Configuration

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/setup/initialize-docker.md

This YAML configuration file sets up the minimum requirements for a Docker environment for Adobe Commerce on-premises projects. It defines services, extensions, and build/deploy hooks.

```yaml
name: magento
system:
    mode: 'production'
services:
    php:
        version: '8.2'
        extensions:
            enabled:
                - xsl
                - json
                - redis
    mysql:
        version: '10.6'
        image: 'mariadb'
    redis:
        version: '7.0'
        image: 'redis'
    opensearch:
        version: '2.4'
        image: 'magento/magento-cloud-docker-opensearch'
hooks:
    build: |
        set -e
        php ./vendor/bin/ece-tools run scenario/build/generate.xml
        php ./vendor/bin/ece-tools run scenario/build/transfer.xml
    deploy: 'php ./vendor/bin/ece-tools run scenario/deploy.xml'
    post_deploy: 'php ./vendor/bin/ece-tools run scenario/post-deploy.xml'
mounts:
    var:
        path: 'var'
    app-etc:
        path: 'app/etc'
    pub-media:
        path: 'pub/media'
    pub-static:
        path: 'pub/static'
```

--------------------------------

### Mount Custom NGINX Configuration

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/containers/service.md

Mount a custom NGINX configuration file to the Web container by adding volume configurations to the `docker-compose.override.yml` file.

```yaml
services:
  web:
    volumes:
      - ./.docker/nginx/etc/nginx.conf:/etc/nginx/nginx.conf
      - ./.docker/nginx/etc/vhost.conf:/etc/nginx/conf.d/default.conf
```

--------------------------------

### Configure PHP auto_prepend_file

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/multiple-sites.md

Ensure the `php.ini` file includes this configuration to apply `magento-vars.php` settings in the Docker environment. This should be placed in the root directory of your project.

```ini
auto_prepend_file = /app/magento-vars.php
```

--------------------------------

### Update /etc/hosts file

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/configure/index.md

Manually update the /etc/hosts file to include a custom host entry.

```conf
127.0.0.1 magento2.test
```

--------------------------------

### Write Credentials to MFTF File

Source: https://github.com/adobedocs/commerce-cloud-tools/blob/main/src/pages/docker/test/application-testing.md

Write the MFTF credentials to the .credentials file within the Docker deploy container.

```bash
docker compose run deploy bash -c "echo \"$CREDENTIALS\" > /app/dev/tests/acceptance/.credentials"
```