Magento 2 Docker

A collection of Docker images for running Magento 2 through nginx and on the command line.

Quick Start

cp composer.env.sample composer.env
# ..put the correct tokens into composer.env

mkdir magento

docker-compose run cli magento-installer
docker-compose up -d
docker-compose restart

Configuration

Configuration is driven through environment variables. A comprehensive list of the environment variables used can be found in each Dockerfile and the commands in each bin/ directory.

PHP_MEMORY_LIMIT - The memory limit to be set in the php.ini
MAGENTO_RUN_MODE - Valid values, as defined in Magento\Framework\App\State: developer, production, default.
MAGENTO_ROOT - The directory to which Magento should be installed (defaults to /var/www/magento)
COMPOSER_GITHUB_TOKEN - Your GitHub OAuth token, should it be needed
COMPOSER_MAGENTO_USERNAME - Your Magento Connect public authentication key (how to get)
COMPOSER_MAGENTO_PASSWORD - Your Magento Connect private authentication key
DEBUG - Toggles tracing in the bash commands when exectued; nothing to do with Magento`
PHP_ENABLE_XDEBUG - When set to true it will include the Xdebug ini file as part of the PHP configuration, turning it on. It's recommended to only switch this on when you need it as it will slow down the application.
UPDATE_UID_GID - If this is set to "true" then the uid and gid of www-data will be modified in the container to match the values on the mounted folders. This seems to be necessary to work around virtualbox issues on OSX.

A sample docker-compose.yml is provided in this repository.

CLI Usage

A number of commands are baked into the image and are available on the $PATH. These are:

magento-command - Provides a user-safe wrapper around the bin/magento command.
magento-installer - Installs and configures Magento into the directory defined in the $MAGENTO_ROOT environment variable.

It's recommended that you mount an external folder to /root/.composer/cache, otherwise you'll be waiting all day for Magento to download every time the container is booted.

CLI commands can be triggered by running:

docker-compose run cli magento-installer

Shell access to a CLI container can be triggered by running:

docker-compose run cli bash

Implementation Notes

In order to achieve a sane environment for executing commands in, a docker-environment script is included as the ENTRYPOINT in the container.

Credits