markshust/docker-magento

Mark Shust's Docker Configuration for Magento

Free Course
Docker Hub
Usage
Prerequisites
Setup
Updates
Custom CLI Commands
Misc Info
Credits
License

Free Course

This course is sponsored by M.academy. Level up your Magento 2 skills with a collection of resources including lessons, courses & more.

A free screencast course is available, which details the basic usage of this project:

Setup a Magento 2 Development Environment with Docker

Course Curriculm

Project Setup

Helper Scripts

Docker Filesystem & Volumes

Customize Server Configuration

PHPStorm & Xdebug

Manual Setup (Optional)

Docker Hub

View Dockerfiles:

Usage

This configuration is intended to be used as a Docker-based development environment for Magento 2.

Folders:

images: Docker images for nginx and php
compose: 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.

Prerequisites

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 Desktop.

This configuration has been tested on Mac & Linux. Windows is supported through the use of Docker on WSL.

Setup

Automated Setup (New Project)

Run this automated one-liner from the directory you want to install your project.

No sample data

curl -s https://raw.githubusercontent.com/markshust/docker-magento/master/lib/onelinesetup | bash -s -- magento2.test 2.4.0

With sample data

curl -s https://raw.githubusercontent.com/markshust/docker-magento/master/lib/onelinesetup | bash -s -- magento2.test with-samples-2.4.0

The magento2.test above defines the hostname to use, and the 2.4.0 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.

Prefix the version with with-samples- if you would like to automatically install sample data along with Magento.

After the one-liner above completes running, you should be able to access your site at https://magento2.test.

Manual Setup

Same result as the one-liner above. Just replace magento2.test references with the hostname that you wish to use.

New Projects

# Download the Docker Compose template:
curl -s https://raw.githubusercontent.com/markshust/docker-magento/master/lib/template | bash

# Download the version of Magento you want to use with:
bin/download 2.4.0

# 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.4.0 src
#
# COMMERCE:
#
# rm -rf src
# composer create-project --repository=https://repo.magento.com/ --ignore-platform-reqs magento/project-enterprise-edition=2.4.0 src

# Create a DNS host entry for the site:
echo "127.0.0.1 ::1 magento2.test" | sudo tee -a /etc/hosts

# Run the setup installer for Magento:
bin/setup magento2.test

open https://magento2.test

Existing Projects

# Download the Docker Compose template:
curl -s https://raw.githubusercontent.com/markshust/docker-magento/master/lib/template | bash

# Remove existing src directory:
rm -rf src

# Replace with existing source code of your existing Magento instance:
cp -R ~/Sites/existing src
# or: git clone git@github.com:myrepo.git src

# Create a DNS host entry for the site:
echo "127.0.0.1 ::1 yoursite.test" | sudo tee -a /etc/hosts

# Start some containers, copy files ot them and then restart the containers:
docker-compose up -d
rm -rf src/vendor
bin/copytocontainer --all ## Initial copy will take a few minutes...

# Install composer dependencies, then copy artifacts back to the host (for debugging purposes):
bin/composer install
bin/copyfromcontainer vendor

# Import existing database:
bin/mysql < backups/magento.sql

# Update database connection details to use the above Docker MySQL credentials:
# Also note: creds for the MySQL server are defined at startup from env/db.env
# vi src/app/etc/env.php

# Import app-specific environment settings:
bin/magento app:config:import

# Set base URLs to local environment URL (if not defined in env.php file):
bin/magento config:set web/secure/base_url https://yoursite.test/
bin/magento config:set web/unsecure/base_url https://yoursite.test/

bin/restart

open https://magento2.test

For more details on how everything works, see the extended setup readme.

Updates

To update your project to the latest version of docker-magento, run:

bin/update

We recommend keeping your docker config files in version control, so you can monitor the changes to files after updates. After reviewing the code updates and ensuring they updated as intended, run bin/restart to restart your containers to have the new configuration take effect.

It is recommended to keep your root docker config files in one repository, and your Magento code setup in another. This ensures the Magento base path lives at the top of one specific repository, which makes automated build pipelines and deployments easy to manage, and maintains compatibility with projects such as Magento Cloud.

Older Versions

Versions older than 24.0.0 did not include a bin/update helper script, and versions older than 26.0.0 had a different directory structure. For both of these situations, you can download the most recent file to your project by running:

(cd bin && curl -OL https://raw.githubusercontent.com/markshust/docker-magento/master/compose/bin/update && chmod +x update)

You'll now have an updated bin/update helper script, and can run it to update your project.

Custom CLI Commands

bin/bash: Drop into the bash prompt of your Docker container. The phpfpm container should be mainly used to access the filesystem within Docker.
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/dev-urn-catalog-generate: Generate URN's for PHPStorm and remap paths to local host. Restart PHPStorm after running this command.
bin/devconsole: Alias for bin/n98-magerun2 dev:console
bin/download: Download & extract specific Magento version to the src directory. Ex. bin/download 2.4.0
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. Ex. bin/grunt exec
bin/magento: Run the Magento CLI. Ex: bin/magento cache:flush
bin/mysql: Run the MySQL CLI with database config from env/db.env. Ex. bin/mysql -e "EXPLAIN core_config_data" orbin/mysql < backups/magento.sql
bin/mysqldump: Backup the Magento database. Ex. bin/mysqldump > backups/magento.sql
bin/n98-magerun2: Access the n98 magerun CLI. Ex: bin/n98-magerun2 dev:console
bin/node: Run the node binary. Ex. bin/node --version
bin/npm: Run the npm binary. Ex. bin/npm install
bin/pwa-studio: (BETA) Start the PWA Studio server. Note that Chrome will throw SSL cert errors and not allow you to view the site, but Firefox will.
bin/redis: Run a command from the redis container. Ex. bin/redis redis-cli monitor
bin/remove: Remove all containers.
bin/removeall: Remove all containers, networks, volumes, and images.
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. Ex bin/root apt-get install nano
bin/rootnotty: Run any CLI command as root with no TTY. Ex bin/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 to magento2.test. Ex. bin/setup magento2.test
bin/setup-grunt: Install and configure Grunt JavaScript task runner to compile .less files
bin/setup-pwa-studio: (BETA) Install PWA Studio (requires NodeJS and Yarn to be installed on the host machine). Pass in your base site domain, otherwise the default master-7rqtwti-mfwmkrjfqvbjk.us-4.magentosite.cloud will be used. Ex: bin/setup-pwa-studio magento2.test
bin/setup-ssl: Generate an SSL certificate for one or more domains. Ex. bin/setup-ssl magento2.test magento3.test
bin/setup-ssl-ca: Generate a certificate authority and copy it to the host.
bin/start: Start all containers, good practice to use this instead of docker-compose up -d, as it may contain additional helpers.
bin/status: Check the container status.
bin/stop: Stop all containers.
bin/update: Update your project to the most recent version of docker-magento.
bin/xdebug: Disable or enable Xdebug. Accepts params disable (default) or enable. Ex. bin/xdebug enable

Misc Info

Database

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.

To connect to the MySQL CLI tool of the Docker instance, run:

bin/mysql

You can use the bin/mysql script to import a database, for example a file stored in your local host directory at backups/magento.sql:

bin/mysql < backups/magento.sql

You also can use bin/mysqldump to export the database. The file will appear in your local host directory at backups/magento.sql:

bin/mysqldump > backups/magento.sql

Composer Authentication

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.

Email / Mailhog

View emails sent locally through Mailhog by visiting http://{yourdomain}:8025

Redis

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 Full Page Cache:

bin/magento setup:config:set --page-cache=redis --page-cache-redis-server=redis --page-cache-redis-db=1

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=2

You may also monitor Redis by running: bin/redis redis-cli monitor

For more information about Redis usage with Magento, see the DevDocs.

Xdebug & VS Code

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.

Xdebug & PHPStorm

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 then bin/start).
Then, open PHPStorm > Preferences > Languages & Frameworks > PHP and configure:
- CLI Interpreter
  - Create a new interpreter and specify From Docker, and name it markoshust/magento-php:7-2-fpm.
  - Choose Docker, then select the markoshust/magento-php:7-2-fpm image name, and set the PHP Executable to php.
- 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.
- 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 to 9001.
Open PHPStorm > Preferences > Languages & Frameworks > PHP > DBGp Proxy and set Port to 9001.
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
Go to Run > Edit Configurations and create a new PHP Remote Debug configuration by clicking the plus sign and selecting it. Set the Name to your domain (ex. magento2.test). Check the Filter debug connection by IDE key checkbox, select the server you just setup, and under IDE Key enter PHPSTORM. 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 to Run > 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.

Linux

Running Docker on Linux should be pretty straight-forward. Note that you need to run some post install commands as well as installing Docker Compose. These steps are taken care of automatically with Docker Desktop, but not on Linux.

You may have to increase a virtual memory map count on the host system. It is required by Elasticsearch.

Add following line to /etc/sysctl.conf:

vm.max_map_count=262144

Blackfire.io

These docker images have built-in support for Blackfire.io. To use it, first register your server ID and token with the Blackfire agent:

bin/root blackfire-agent --register --server-id={YOUR_SERVER_ID} --server-token={YOUR_SERVER_TOKEN}

Next, open up the bin/start helper script and uncomment the line:

#bin/root /etc/init.d/blackfire-agent start

Finally, restart the containers with bin/restart. After doing so, everything is now configured and you can use a browser extension to profile your Magento store with Blackfire.

Credits

M.academy

This course is sponsored by M.academy. Level up your Magento 2 skills.

Available Courses:

Setup a Magento 2 Development Environment with Docker (FREE!) - The easiest way to install, manage, configure & standardize Magento development environments across your team.
Magento 2 Coding Kickstart - Start to become productive in Magento 2 programming within one week with no prior experience.

Also available is the M.academy Library, a collection of resources including lessons, courses & more.

Mark Shust

I'm a Certified Magento Developer & Architect & Zend Certified Engineer, and available for consulting & development of your next project 🤓. You can read my blog at markshust.com or contact me directly at mark@shust.com.

Nexcess

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!

License

MIT

easeq/docker-magento