Mark Shust's Magento 2 Docker Compose

Docker Hub

View Docker Hub images at https://hub.docker.com/u/markoshust/

Usage

This file is provided as an example environment using Mark Shust's Magento 2 Docker Images.

Composer Setup

Authentication

Uncomment the composer line from appdata to mount a .composer directory to the www-data user home directory. Please first setup Magento Marketplace authentication (details at http://devdocs.magento.com/guides/v2.0/install-gde/prereq/connect-auth.html).

Place your auth token at ~/.composer/auth.json with the following contents, like so:

{
    "http-basic": {
        "repo.magento.com": {
            "username": "MAGENTO_PUBLIC_KEY",
            "password": "MAGENTO_PRIVATE_KEY"
        }
    }
}

Then, just set M2SETUP_USE_ARCHIVE to false in your ./env/setup.env file.

Magento Enterprise

You can install Magento Enterprise via Composer by setting M2SETUP_USE_COMPOSER_ENTERPRISE=true in your ./env/setup.env file.

Composer-less, No-Auth Setup

If you don't want to use Composer or setup the auth keys above, no worries. The install script uses Nexcess' hosted Magento archives for a Composer-less install process. Just set the M2SETUP_USE_ARCHIVE environment variable to true when running setup.

Running Setup

Using the above docker-compose.yml file, all you need to do is run one line to install Magento 2:

docker-compose run --rm setup

You may modify any environment variables depending on your requirements.

Data Volumes

Your Magento source data is persistently stored within Docker data volumes. For local development, I advise copying the entire contents of the appdata data volume to your local machine (after setup is complete of course). Since you shouldn't be modifying any of these files, this is just to bring the fully copy of the site back to your host:

docker cp CONTAINERID:/var/www/html ./

Then, just uncomment the ./html/app/code:/var/www/html/app/code and ./html/app/design:/var/www/html/app/design lines within your docker-compose.override.yml file (appdata > volumes). This mounts your local app/code and app/design directories to the Docker data volume. Then, just restart your containers:

docker-compose up -d app

Any edits to these directories will correctly sync with your Docker volume.

Running Magento CLI tool

I've setup scripts to aid in the running of Magento CLI tool with the correct permissions. To run the command line tool, you would connect as any other Docker Compose application would:

docker-compose exec phpfpm ./bin/magento

or with straight Docker command:

docker exec NAME_OF_PHPFPM_CONTAINER ./bin/magento

You can easily set these up as aliases inside your ~/.bash_profile file (or a similar script) as so:

alias magento='docker-compose exec phpfpm ./bin/magento'

This will allow you to clear the cache by running the following command right in terminal:

magento cache:flush

Docker Compose Override

You can copy docker-compose.override.yml.dist to docker-compose.override.yml and adjust environment variables, volume mounts etc in the docker-compose.override.yml file to avoid losing local configuration changes when you pull changes to this repository.

Docker Compose will automatically read any of the values you define in the file. See this link for more information about the override file.

Troubleshooting

Setup Error

A common error when running setup is receiving this error:

SQLSTATE[HY000] [2002] Connection refused

  [InvalidArgumentException]
  Parameter validation failed

If you receive this error, it's because the database driver has not initialized before the setup script commences execution. The easy fix for this is to run the setup command again immediately after this error.