View Dockerfiles:
This configuration is intended to be used as a Docker-based development environment for Magento 2.
Folders:
images
: Docker images for nginx and phpcompose
: sample setups with Docker Compose
The Magento 1 version of this development environment has been deprecated and is no longer supported. PHP 5 was used as it's base, and that version has reached end-of-life. If you still wish to use this setup, please reference compose/magento-1 on tag 20.1.1, but please be aware these images are no longer maintained.
This setup assumes you are running Docker on a computer with at least 4GB of allocated RAM, a dual-core, and an SSD hard drive. Download & Install Docker Community Edition.
This configuration has been tested on Mac & Linux.
Windows Configurations: The Windows configuration does not currently work and is in need of a contributor to get functional once again. Please see issue 100 to contribute.
macOS & Linux Only
Run this automated one-liner from the directory you want to install your project to:
curl -s https://github.com/raw/markshust/docker-magento/master/lib/onelinesetup | bash -s -- magento2.test 2.3.1
The magento2.test
above defines the hostname to use, and the 2.3.1
defines the Magento version to install. Note that since we need a write to /etc/hosts
for DNS resolution, you will be prompted for your system password during setup.
After the one-liner above completes running, you should be able to access your site at https://magento2.test
.
Same result as the one-liner above. Just replace magento2.test
references with the hostname that you wish to use.
# Download the Docker Compose template:
curl -s https://github.com/raw/markshust/docker-magento/master/lib/template | bash -s -- magento-2
# Download the version of Magento you want to use with:
bin/download 2.3.1
# or if you'd rather install with Composer, run:
#
# OPEN SOURCE:
#
# rm -rf src
# composer create-project --repository=https://repo.magento.com/ --ignore-platform-reqs magento/project-community-edition=2.3.1 src
#
# COMMERCE:
#
# rm -rf src
# composer create-project --repository=https://repo.magento.com/ --ignore-platform-reqs magento/project-enterprise-edition=2.3.1 src
# Create a DNS host entry for the site:
echo "127.0.0.1 magento2.test" | sudo tee -a /etc/hosts
# Run the setup installer for Magento:
bin/setup magento2.test
open https://magento2.test
# Download the Docker Compose template:
curl -s https://github.com/raw/markshust/docker-magento/master/lib/template | bash -s -- magento-2
# Replace the contents of /src with the source code of your existing Magento instance
# Example: git clone git@github.com:myrepo.git src
# Create a DNS host entry for the site:
echo "127.0.0.1 magento2.test" | sudo tee -a /etc/hosts
# Copy some files to the containers and install dependencies, then restart the containers:
docker-compose up -d
bin/copytocontainer --all
bin/composer install
bin/restart
open https://magento2.test
For more details on how everything works, see the extended setup readme.
bin/bash
: Drop into the bash prompt of your Docker container. Thephpfpm
container should be mainly used to access the filesystem within Docker.bin/dev-urn-catalog-generate
: Generate URN's for PHPStorm and remap paths to local host. Restart PHPStorm after running this command.bin/cli
: Run any CLI command without going into the bash prompt. Ex.bin/cli ls
bin/clinotty
: Run any CLI command with no TTY. Ex.bin/clinotty chmod u+x bin/magento
bin/composer
: Run the composer binary. Ex.bin/composer install
bin/copyfromcontainer
: Copy folders or files from container to host. Ex.bin/copyfromcontainer vendor
bin/copytocontainer
: Copy folders or files from host to container. Ex.bin/copytocontainer --all
bin/download
: Download & extract specific Magento version to thesrc
directory. Ex.bin/download 2.3.1
bin/fixowns
: This will fix filesystem ownerships within the container.bin/fixperms
: This will fix filesystem permissions within the container.bin/grunt
: Run the grunt binary. Note that this runs the version from the node_modules directory for project version parity. Ex.bin/grunt exec
bin/magento
: Run the Magento CLI. Ex:bin/magento cache:flush
bin/node
: Run the node binary. Ex.bin/node --version
bin/npm
: Run the npm binary. Ex.bin/npm install
bin/redis
: Run a command from the redis container. Exbin/redis redis-cli monitor
bin/remove
: Remove all containers.bin/removevolumes
: Remove all volumes.bin/restart
: Stop and then start all containers.bin/root
: Run any CLI command as root without going into the bash prompt. Exbin/root apt-get install nano
bin/rootnotty
: Run any CLI command as root with no TTY. Exbin/rootnotty chown -R app:app /var/www/html
bin/setup
: Run the Magento setup process to install Magento from the source code, with optional domain name. Defaults tomagento2.test
. Ex.bin/setup magento2.test
bin/start
: Start all containers, good practice to use this instead ofdocker-compose up -d
, as it may contain additional helpers.bin/status
: Check the container status.bin/stop
: Stop all containers.bin/varnish
: Run commands in the Varnish container. Exbin/varnish varnishlog -q 'ReqURL ~ "^/$"'
to monitor requests to homepage, orbin/vanirsh varnishlog -g request -q 'ReqMethod eq "PURGE"'
to monitor PURGE requestsbin/xdebug
: Disable or enable Xdebug. Accepts paramsdisable
(default) orenable
. Ex.bin/xdebug enable
The hostname of each service is the name of the service within the docker-compose.yml
file. So for example, MySQL's hostname is db
(not localhost
) when accessing it from within a Docker container. Elasticsearch's hostname is elasticsearch
.
Here's an example of how to connect to the MySQL cli tool of the Docker instance:
bin/cli mysql -h db -umagento -pmagento magento
You can use the bin/clinotty
helper script to import a database. This example uses the root MySQL user, and looks for the dbdump.sql
file in your local host directory:
bin/clinotty mysql -h db -u root -pmagento magento < dbdump.sql
First setup Magento Marketplace authentication (details in the DevDocs).
Copy src/auth.json.sample
to src/auth.json
. Then, update the username and password values with your Magento public and private keys, respectively. Finally, copy the file to the container by running bin/copytocontainer auth.json
.
Redis is now the default cache and session storage engine, and is automatically configured & enabled when running bin/setup
on new installs.
Use the following lines to enable Redis on existing installs:
Enable for Cache:
bin/magento setup:config:set --cache-backend=redis --cache-backend-redis-server=redis --cache-backend-redis-db=0
Enable for Session:
bin/magento setup:config:set --session-save=redis --session-save-redis-host=redis --session-save-redis-log-level=4 --session-save-redis-db=1
You may also monitor Redis by running: bin/redis redis-cli monitor
For more information about Redis usage with Magento, see the DevDocs.
Install and enable the PHP Debug extension from the Visual Studio Marketplace.
Otherwise, this project now automatically sets up Xdebug support with VS Code. If you wish to set this up manually, please see the .vscode/launch.json
file.
-
First, install the Chrome Xdebug helper. After installed, right click on the Chrome icon for it and go to Options. Under IDE Key, select PHPStorm from the list and click Save.
-
Next, enable Xdebug in the PHP-FPM container by running:
bin/xdebug enable
, the restart the docker containers (CTRL+C thenbin/start
). -
Then, open
PHPStorm > Preferences > Languages & Frameworks > PHP
and configure:-
CLI Interpreter
- Create a new interpreter and specify
From Docker
, and name itmarkoshust/magento-php:7-2-fpm
. - Choose
Docker
, then select themarkoshust/magento-php:7-2-fpm
image name, and set thePHP Executable
tophp
.
- Create a new interpreter and specify
-
Path mappings
- Don't do anything here as the next
Docker container
step will automatically setup a path mapping from/var/www/html
to./src
.
- Don't do anything here as the next
-
Docker container
- Remove any pre-existing volume bindings.
- Ensure a volume binding has been setup for Container path of
/var/www/html
mapped to the Host path of./src
.
-
-
Open
PHPStorm > Preferences > Languages & Frameworks > PHP > Debug
and set Debug Port to9001
. -
Open
PHPStorm > Preferences > Languages & Frameworks > PHP > DBGp Proxy
and set Port to9001
. -
Open
PHPStorm > Preferences > Languages & Frameworks > PHP > Servers
and create a new server:- Set Name and Host to your domain name (ex.
magento2.test
) - Keep port set to
80
- Check the Path Mappings box and map
src
to the absolute path of/var/www/html
- Set Name and Host to your domain name (ex.
-
Go to
Run > Edit Configurations
and create a newPHP Remote Debug
configuration by clicking the plus sign and selecting it. Set the Name to your domain (ex.magento2.test
). Check theFilter debug connection by IDE key
checkbox, select the server you just setup, and under IDE Key enterPHPSTORM
. This IDE Key should match the IDE Key set by the Chrome Xdebug Helper. Then click OK to finish setting up the remote debugger in PHPStorm. -
Open up
src/pub/index.php
, and set a breakpoint near the end of the file. Go toRun > Debug 'magento2.test'
, and open up a web browser. Ensure the Chrome Xdebug helper is enabled by clicking on it > Debug. Navigate to your Magento store URL, and Xdebug within PHPStorm should now trigger the debugger and pause at the toggled breakpoint.
I'm a Certified Magento Developer & Architect and Zend Certified Engineer, and available for consulting & development of your next project ๐ค. You can read technical articles on my blog at markshust.com or contact me directly at mark@shust.com.
A special thanks goes out to Nexcess for hosting public archives of every version of Magento ๐. I've used their Magento hosting services in the past also (both shared and enteprise offerings) and they're great, ...highly recommended!
Implemented Varnish support with https proxy Willem Wigman