All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
- Unit test scripts PR #1263
This release introduces significant enhancements to the development environment, including a new PHP 8.4 Docker image for early adopters and developers wanting to test future compatibility. The MageOS support has been substantially improved, and a new RabbitMQ 3.13 image has been added. Several quality-of-life improvements have been implemented, such as better unit testing tools, enhanced SSL generation for multi-site setups, and comprehensive documentation updates. A notable breaking change is the shift in the download command syntax - it now expects the edition type before the version number (ex: bin/download community 2.4.7-p3
instead of the previous bin/download 2.4.7 community
). Additionally, all Docker images have been updated to maintain parity with current Magento version requirements.
- New PHP 8.4 Docker image for development purposes PR #1252
- New RabbitMQ 3.13 Docker image PR #1252
- Backend login credentials and 2FA setup instructions to README PR #1205
- PHP FTP extension to Docker setup PR #1210
- PhpMyAdmin credentials to README PR #1212
bin/test
helper scripts to execute unit tests PR #1157bin/ece-patches
command PR #1171- rsync to PHP images for Deployer support PR #1163
- PhpMyAdmin for Linux PR #1177
- Improved MageOS support PR #1246
- System requirements helper script overhauled for easier use and maintenance PR #1242
- Supported versions in
bin/check-dependencies
script PR #1175 - Docker images for Magento version parity PR #1252
- Bumped docker/build-push-action from 5 to 6 PR #1174
- GitHub Actions to use release/next branch PR #1254
- Speed improvement for
bin/xdebug
command PR #1245
- Code duplication PR #1141
- Empty directory check moved to top of scripts PR #1143
- Elasticsearch container issues PR #1166
- Multi-site SSL generation support PR #1200
- Various typos in files PR #1238
- "The current directory is not empty" message appearing on new install PR #1141.
- Check to ensure directory does not already exist in project directory PR #1127.
- Remove obsolete version directive from docker compose files PR #1125.
- Predefined version from 2.4.6-p4 to 2.4.7 PR #1128.
- Integration testing configuration to use OpenSearch PR #1131.
- SSL cert generation when domain has a port included PR #1136.
- OpenSearch container fails to start due to memory heap size configuration PR #1137.
- Xdebug 3.3.1 and Blackfire PHP extension incompatibility PR #1122.
- New
bin/blackfire
script to enable, disable, or check status of Blackfire extension PR #1115. - Swool PHP extension to all PHP Docker images to support Adobe Commerce GraphQL Application Layer PR #1114.
- Supported versions in the
bin/check-dependencies
script PR #1112.
- New
bin/check-dependencies
script which provides helpful recommendations for dependencies tailored to the chosen Magento version PR #1018. - New
nginx
Docker images for versions 1.22, 1.24 PR #1019. - New
php-fpm
8.3 Docker image for Magento 2.4.7 support PR #1019. - New
opensearch
2.12 Docker image for Magento 2.4.7 support PR #1019. - New
elasticsearch
7.16 and 8.11 Docker images for previous Magento versions support PR #1019. - New
elasticsearch
8.13 Docker image for Magento 2.4.7 support PR #1019. - New
rabbitmq
3.8 Docker image for previous Magento versions support PR #1019. - New
rabbitmq
3.12 Docker image for Magento 2.4.7 support PR #1019.
- Link
php-fpm
Docker images to officially compatible Composer versions PR #1019.
- New
bin/configure-linux
helper script to assist with easier Linux setup PR #1016. - Linux dependencies to README PR #1050.
- Added
bin/create-user
script to allow for easy creation of Magento admin user & customer PR #1040. - Descriptions for all missing helper scripts to README and Makefile PR #1096.
bin/docker-stats
to simplified output PR #1083.- Pinned Composer version for increased compatibility with latest Magento versions PR #1090.
- New PHP images based on bookworm, pegging pecl libraries for more predictability PR #1071.
- New PHP 8.3 image PR #1071.
- PHP SPX profiler to enhance performance monitoring capabilities PR #533.
- Support for the
strace
command, providing developers with powerful tools for diagnosing and troubleshooting PR #1033. - Ability for xdebug to listen to Magento CLI commands PR #846.
- Abstraction of setup script into two scripts PR #874.
- New Docker image for OpenSearch 2.4 PR #858.
- Mage-OS mirror support PR #835.
- New
bin/log
command to view Magento logs in real-time PR #1060. - New
bin/docker-stats
command for container monitoring PR #533. - New
bin/setup-pwa-studio-sampledata
command to install Magento PWA Studio sample data, facilitating easier PWA development setups #1045. - New
bin/deploy
script to deply Magento in pipeline PR #926. - New
bin/magento-version
script which outputs current Magento version PR #931. - New
bin/spx
script to enable or disable SPX PR #1074.
- Node.js to version 20.x LTS PR #1071.
- Support for Magento 2.4.6-p4, updating the default Magento version in the Docker setup to align with the latest Magento release PR #1063.
- Continuous integration and deployment processes were refined to include updates and to maintain dependencies through GitHub Actions and Dependabot, ensuring that the project's dependencies remain up to date and secure PR #1032.
- Rework docker compose script to allow future extensibility PR #1002.
- Replaced phpmyadmin Docker image with amd64-compatible image PR #939.
- Set default Magento 2.4.6 search engine to OpenSearch PR #937.
- Use
/usr/bin/env
to discover bash location PR #879.
- Execution rights in scripts PR #1039.
- Bug with Elasticsearch documentation PR #1014.
- Elasticsearch JAVA OPTS issue with containers not starting at startup PR #938.
- Unexpected Ubuntu 18.04 startup failure PR #310.
- Failing
npm install
of puppeteer due to missing Chromium PR #848.
- Allow more variables for the PhpStan analyse script PR #789.
- New bin/docker-compose script to abstract away calls to docker-compose PR #787.
- Support for Docker Compose V2 ("docker compose" and backwards-compatibility for "docker-compose") PR #787.
- New Docker Compose healthcheck PR #384.
- MageOS support 4591b68c.
- Documentation to recover from failed install #816.
- OpenSearch support PR #680.
- New build for Elasticsearch 7.17 c45f05c3.
- Rename docker-compose.yml to compose.yaml (preferred) PR #799.
- Readme file with new info on configuring Xdebug in WSL2 environments PR #810.
- Lowered RAM check on setup #720.
- Deprecated PHP 7.4 due to all versions < Magento 2.4.4 reaching EOL 3a64324e.
- Added phpmyadmin to docker-compose.dev.yml file PR #772.
- Support for Grunt + LiveReload #430.
- Fall back to PHP 7.4 for Magento versions older than 2.4.4 PR #685 PR #710.
- Checksum flag to rsync in
bin/update
PR #707. - New
bin/analyse
command to statically analyse code with PHPStan 8601c2f7. node
&npm
to PHP images #694.
- Magento download to default to 2.4.4 151dc09a
- Prevent domain duplication in
/etc/hosts
PR #693. - Replace buster images with bullseye to properly fix Apple M1 5-sec delay #636.
This release brings streamlined PHP Docker images (saving 300MB on previous images), a brand new PHP 8.1 image with full support for Magento 2.4.4, a proper Elasticsearch health check during setup, and ability to detect memory assigned to Docker on startup (which will prevent failed installations). Elasticsearch, Redis & RabbitMQ Docker images have also all been updated to their recently supported Magento versions.
- New Docker image for PHP 8.1 903f9867.
- New Docker image for Elasticsearch 7.16 f70a1565.
- New Docker image for RabbitMQ 3.9 7711365c.
- Elasticsearch health check timeout when installing Magento #675.
- Ability to detect if memory usage is too low #527.
- PHP 7.4 Docker image for parity with PHP 8.1 image 481097b3.
- ionCube support from PHP 7 image in order to retain Docker image parity between versions, to slim down image size, and because I no longer want to support encrypted or obfuscated code in my open source projects. Feel free to pull, fork or modify if you still need ionCube in your projects.
- Increased RabbitMQ sleep timeout to prevent errors on startup #426.
- RabbitMQ connection issues on Windows/WSL2 #426.
- Problem with elasticsearch & unexpected character #597.
- Issue with extra_hosts host.docker.internal for Xdebug on Linux #595.
- Reverted Xdebug/magerun code refactor which caused issues #595.
- Composer auth.json auth required message shows after authenticating #587.
- Failing shellchecks 08206e6d, 53d9b858.
- Firefox SSL cert fails on first-time install 2695fe2e.
- Some commands including bin/xdebug not working on Windows + Docker Desktop 4.4.3 #619.
- Redis 5.0 to 6.0 6653d787.
bin/setup
script so it can run completely automated PR #633.- PHP 8 image to 8.1.4, last version before tagging final release 86093b70.
bin/stopall
script to stop all running containers #599.- New PHP image to enable WebP support in GD PR #651.
- Ability to configure custom user/group ID in Nginx image PR #658.
- PHP 7.3 images have been deprecated due to 7.3's EOL.
- EXPOSE statement from PHP image (unneeded) 790e2fe0.
- Disable "Composer is slower because of Xdebug" message 1990d84.
- Updated verbiage in setup on how to start cron c3ba47d.
- Fixed "The input device is not a TTY" error during setup 8aada97.
- Expose port 9003 on PHP Docker image for Xdebug 263e40d.
- Disable Xdebug by default for PHP 7.3 263e40d.
- Updated PHP 8.1 image to use official GA version 263e40d.
- Fixed additional issue of waiting for Elasticsearch/RabbitMQ connection on Mac #442.
There has been an ongoing issue with Docker for Mac + M1 chips (Apple Silicon) which causes a 5-second delay in network requests (see #5626). A fix has been implemented in this release that works around this issue, adding extra_hosts
directives in the docker-compose.yml
file. This update should be backwards-compatible, but will break existing setups that use custom Docker networks (this is an uncommon scenario). See notes at the top of docker-compose.yml
for how to configure this project for custom Docker networks.
- Added Imagick PHP extension #530.
- Fixed issue with onelinesetup script failing on download 92b803c 67c76b4.
- Fix Shellcheck failures for bin/setup-ssl-ca #558.
- Fix wrong
sendmail_path
in php.ini #556. - Ensure .composer directory isn't created by root #562.
- Fixed
bin/devconsole
command not working 646f617. - Fixed
bin/setup-composer-auth
does not persist auth creds #567. - Fixed documentation around Xdebug port on Linux 90af7fa.
- Fixed waiting for Elasticsearch/RabbitMQ connection on Mac #442.
- Updated info about MySQL backups and existing projects in README 86faa70.
- Updated README for Xdebug + PhpStorm b1fe812.
- Fixed issues with onelinesetup script #564.
- Fixed Shellcheck failures for bin/setup-ssl-ca #558.
- Fixed php.ini possible wrong smtp-addr #556.
- Ensure files are created so Docker doesn't create them as root #562.
- Added additional time for Elasticsearch container to get initialized during setup.
- Fixed Selenium configuration for MFTF PR #554.
- Fixed PHP image
8.0-fpm-develop
for Magento 2.4.4 support (note: still has-develop
tag).
- Moved
~/.ssh
volume mount references todocker-compose.yml
to ease maintenance.
This is one of the biggest releases of docker-magento 💥! This major update includes support for Apple Silicon (M1/M1X) chips, as well as SSH support for fully native filesystem speed.
All the images are now multi-arch builds, meaning they can install on both AMD & ARM chipsets. Additionally, by setting up your IDE to connect to Docker over SSH/SFTP to avoid selective filesystem syncing.
The docker-compose configuration files have also been streamlined & simplified, with dedicated files for both SSH and Linux setups. Read more about these updates at https://github.com/markshust/docker-magento#ssh and https://github.com/markshust/docker-magento#linux respectively.
Many issues have been resolved, and long-standing pull requests have been merged. A special thanks to @drpayyne for multi-arch support, @rangerz for their massive contributions, as well as many others for their continued work & pull requests submitted to this project.
- Updated
onelinesetup
script to use version2.4.3-p1
by default. - Updated
bin/cache-clean
with improved logic PR #400. - Simplified
docker-compose.dev.yml
file to only contain volume mounting information.
- Added new
mailcatcher
image to replacemailhog
for multi-arch support #511. - Added
docker-compose.dev-ssh.xml
to streamline SSH setup. - Added
docker-compose.dev-linux.xml
to streamline Linux setup. - Added GitHub workflows for multi-arch build support #396.
- Added multi-arch support for Nginx PR #515.
- Added multi-arch support for PHP PR #516.
- Added new
bin/setup-domain
script PR #429. - Added Basic MFTP Setup information PR #269.
- Make uid & gid of app user configurable #520.
- Added Makefile with list of available commands #399.
- Xdebug 3 support for
bin/n98-magerun2
#545.
- Fixed SSL setup failing on Linux #222.
- Fixed locale code for
bin/setup-grunt
#484. - Fixed cron not working #540.
- Replace MailHog with Mailcatcher for multi-arch compatibility #511.
- Fixed placement of enabling developer mode within bin/setup.
- Connection to Redis fails without php-redis extension #474.
- New Elasticsearch Docker images
7.9
,7.9.3-0
#488.
- Replace Percona DB with MariaDB 10.4 #514.
- Updated RabbitMQ image to 3.8.
- Resolve cron install script not in bin/setup #420.
- Update Elasticsearch settings to fix catalog search index error #488.
- Composer 2 support #409.
- Composer
auth.json
not properly set after installation #42. bin/remove
not removing containers in newer versions of Docker Compose.- Invalid template error with Docker 3.5.1 #486.
- New
bin/setup-composer-auth
file to setup Composer auth creds.
- Fix onelinesetup script bug.
- Official support for Xdebug 3 #390. The new PHP images are
7.3-fpm-12
&7.4-fpm-5
. - If you need to still use Xdebug 2, update your docker-compose.yml files to instead look at PHP image
7.3-fpm-11
or7.4-fpm-4
. These images are exactly the same other than being pegged to Xdebug 2.
- Reverted Xdebug to version 2 for backwards-compatible support #390.
- Reverted DB image back to
percona:5.7
until issues with MySQL 8.0 image are resolved.
- New Elasticsearch Docker images
7.7
,7.7.1-0
#392. - SpellCheck GitHub Action for continuous integration checks of shell scripts #387, #388.
- Updated PHP images to NodeJS version 14 LTS 4a81f2b8.
- Changed
db
service to use MySQL 8.0 Docker image.
- Automatically purge caches for a better dev experience #380.
- Stop script execution on error #363.
- Make xdebug command understand partials #371.
- Extended functionality for
bin/xdebug
, including newstatus
andtoggle
commands #332. - Check Elasticsearch connection before setup:install #326.
- The onelinesetup now accepts a
community
orenterprise
param to pick version to install b2399ff1. - Fix bin/start for macOS Big Sur #355.
- Updated Composer to version
1.10.15
to avoid nag update messages in new PHP Docker images7.3-fpm-9
,7.4-fpm-2
.
- HTTP/2 added to Nginx image
1.18-4
bin/download
falls back to using Composer if archive download fails or is not found.
- New
bin/setup-integration-tests
script to setup integration tests 3c021ff. - Added
MYSQL_HOST
environment variable toenv/db.env
file. - New Nginx
1.18-3
Docker images uses Alpine as base image PR #306.
- Prevent containers from starting if volume mapping doesn't exist, validate volumes to avoid empty folder creation PR #256.
- Setup script uses MySQL
env/db.env
file for database connection credentials PR #302. - Increased MySQL's
max_allowed_packet
to64M
indocker-compose.yml
file PR #303. docker-compose.yml
now uses Alpine images for Redis and RabbitMQ #305.docker-compose.yml
file now uses new Alpine images for Redis, RabbitMQ & Nginx.bin/setup
script updated to use Redis for cache and session directly in installer script PR #304.bin/setup
script sets Admin URL to/admin
PR #304.- Enabling/disabling Xdebug now only restarts
phpfpm
container rather than all containers PR #314. bin/setup
script moves.vscode
directory tosrc
after install 846d02c.
- Exception while running integration tests #292.
- Nested files not copying in copytocontainer script #295 #296.
- Ubuntu unable to start because of missing volumes #309.
- The
php:7.4-fpm
Docker image has been setup with full support for Magento 2.4 (see images/php/7.4). - Added easy way to mount an SSH key to the container (see #89).
- The
bin/download
script now falls back to Hypernode's Magento Download mirror in the event the archive doesn't exist or fails to download from Nexcess.
- All Docker volumes now use
:cached
rather than:delegated
. Thedelegated
volume functionality is changing in a future version of Docker for Mac to use Mutagen volumes, and the implementation is very buggy & awkward. Using thecached
flag retains the current functionality we've been using indelegated
without any changes (confirmed in docker/for-mac#1592). - Updated
bin/setup-ssl-ca
so SSL generation works on Linux (#222) - Updated
php
Docker images to use most recent version of Composer (1.10.9). - The
bin/setup
script now runscomposer update
rather thancomposer install
. There was an error happening withcomposer install
, and with the start of the project it's best to just get the most recent Composer packages anyway. - The
bin/setup
script now sets Elasticsearch 7 as the default catalog search engine directly when executingbin/magento setup:install
.
- All
latest
tags have been removed on all Docker images. It is bad practice to not use a specific version. Thelatest
tag will no longer be recompiled when new images are released. - The
php:7.2
Docker images have been deprecated, as that version is no longer supported in Magento. - The
elasticsearch:6
Docker images have been deprecated, as those versions are no longer supported in Magento. - Removed invalid checksum hack fix in
bin/setup
forgoogle-shopping-api
package, as that is only applicable to older versions of Magento.
- Backed out last Elasticsearch update with elasticsearch.yml, caused issues with startup.
- Updated
bin/dev-urn-catalog-generate
to account for new versions of PHPStorm (simplified). - Indexing error with possible ElasticSearch modules (#262).
- Updated ElasticSearch 6 to version 6.8.
- Fixed typo in last build image, new version is
magento-nginx:1.18-2
.
- Reverted old SSL cert, it needs to exist as default cert until new certs are generated.
- New
magento-nginx:1.18
Docker image. - New
magento-elasticsearch:7.6
Docker image. - Documentation to install Magento directly with sample data (using
with-samples-
prefix (thanks Nexcess!).
- The
bin/setup
helper script to enable Elasticsearch 7 and automatically reindex during installation. - The
docker-compose.yml
file now references themagento-nginx:1.18-0
andmagento-elasticsearch:7.6.2-0
Docker images. - The
docker-compose.yml
adds the new environment variable"discovery.type=single-node"
for compatibility with Elasticsearch 7. - The new
nginx:1.18
Docker image setsfastcgi_buffer_size 64k;
andfastcgi_buffers 8 128k;
directives for Magento 2.3.5 compatibility.
- Old SSL cert being generated directly on Nginx image (deprecated).
- References to Nginx 1.13 images (deprecated).
- Reverted disabling Temando_Shipping module in bin/magento for sample data installation. #250
- The
Temando_Shipping
module conflicts with sample data installation. Added fix tobin/magento
helper script to disable this module, install sample data, then re-enable it.
- Added a
--remove-orphans
flag tobin/start
script to remove orphaned containers (applicable to cron service).
- Increased php.ini
memory_limit
to4G
to get PHPUnit tests to pass - Increased php.ini
upload_max_filesize
andpost_max_size
to100M
just to prevent issues from being filed in the future
- New PHP image tags
7.2-fpm-9
,7.3-fpm-6
- Added new CLI to connect to MySQL
- Updated readme with new bin/mysql documentation
- n98-magerun2 to install on exec of
bin/n98-magerun2
instead ofbin/setup
script - Increased
max_input_vars
to10000
to prevent Invalid Form Post submission errors
- Fixed PHP ioncube module missing ioncube.so file
- Disable TTY on
bin/setup-ssl-ca script
- Fixed
bin/copytocontainer
script not copying files to proper directory
- Fixed implementation of grunt. The grunt-cli is now installed globally on the image and doesn't depend on contents of the
vendor
directory.
- Upgraded NodeJS to 10.x, as 8.x was failing to install npm due to source repository updates #210
- Removed PHP 7.1 image from filesystem as it has been deprecated. If you need to reference the last version of these images, they are available at https://github.com/markshust/docker-magento/tree/27.2.0/images/php/7.1
- Support for RabbitMQ PR #212
- New
bin/setup-ssl
script to generate valid SSL certificates #211 - New
markoshust/magento-nginx:1.13-8
image containing mkcert script
- Updated
bin/setup
to use newbin/setup-ssl
script
Happy new year! 🎉
- Updated the PHP base images from Debian Stretch to Buster
- Updated PHP libsodium package to
1.0.17
to supportHASH_VERSION_ARGON2ID13
#193
- Built-in support for Blackfire.io
- New PHP image tags
7.2-fpm-5
,7.3-fpm-2
- Ability for
src
directory to be a symlink
- Fixed Magento2 setup script with n98-magerun2.phar
- Fixed dev-urn-catalog-generate script
- All Windows-specific setup and helper scripts. This involved changing directory structure of
compose
folder, there is no longer specificmagento-2
andmagento-2-windows
specific folders. Windows support works on Docker with WSL. - Support for PHP 7.1 (EOL)
- Full parity with Magento Cloud PHP extensions
- Optimized Dockerfile install order and layer usage for all PHP images (7.1, 7.2 & 7.3)
- Updated few lib dependencies in Dockerfiles with new versions
- Pegged Composer to version 1.9.0 for predictability, moved to lower layer so updating version doesn't require full rebuild of all layers
- Fixed logic of
bin/copyfromcontainer
andbin/copytocontainer
so subdirectories are now properly copied from and to the container
- The
bin/fixowns
script now includes the ability to fix ownerships at the subdirectory level - The
bin/copyfromcontainer
andbin/copytocontainer
scripts now fixes permissions and ownerships of just the subdirectories that are copied
- Fixed
bin/copyfromcontainer
andbin/copytocontainer
referencing incorrect destination file locations
- Added missing
bin/pwa-studio
andbin/setup-pwa-studio
bash scripts
- Documented in README how to retrieve
bin/update
file for previous versions that did not include it - Added
hirak/prestissimo
composer package tobin/setup
helper script for much faster composer installs - Downloaded archive installs are now cached on the user's machine, so subsequent installs of Magento will no longer re-download the archive if previously downloaded. Downloaded archives are stored in the
~/.docker-magento
folder.
- There is an invalid checksum reference in the Nexcess archive of 2.3.3, replaced checksum reference in
bin/setup
to resolve the error
- The previous CHANGELOG for
24.0.0
referencedvertex/module-tax
being removed but for some reason it was not removed, now it is
- New PHP docker image version
7.3-fpm-0
for Magento 2.3.3 support - New Elasticsearch docker image
markoshust/magento-elasticsearch:6.5.4-0
which comes bundled with icu and phonetic plugins. The initial6.5
version is for parity with Magento Cloud. - New
bin/update
helper script that updates your docker-magento setup to the latest version - Added
.gitignore
file to project root to ignoresrc
directory. 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. - Install n98-magerun2 when setup is executed, and added related
bin/n98-magerun
andbin/devconsole
helper scripts. - Added
bin/setup-pwa-studio
(BETA) helper script to easily install PWA Studio, usage accepts a single parameter being the site URL you wish PWA Studio to connect to (ex.bin/setup-pwa-studio magento2.test
) - Added
bin/pwa-studio
(BETA) helper script to easily run the PWA Studio NodeJS web server
- The
bin/dev-urn-catalog-generate
helper script has been updated for compatibility with more recent versions of PHPStorm
-
The
vertex/module-tax
Composer package installs correctly as of 2.3.0, so the line within thebin/setup
script which prevented it from being installed was removed. If one is having issues installing an older version of Magento 2, add the following line to yourcomposer.json
file to prevent this package from being installed:{"replace": { "vertex/module-tax": "*" }}
- The
php
base Docker image changed from Debian Stretch to Buster and broke a lot of packages, which caused a failed build for7.1-fpm-12
&7.2-fpm-3
tags. This update pegs thephp
Docker image to Debian Stretch.
- Xdebug breakpoints not triggering
- New PHP docker image versions
7.1-fpm-12
,7.2-fpm-3
- Mailhog container doesn't stop when running bin/stop
- View emails sent locally through Mailhog by visiting http://{yourdomain}:8025
- Make Dockerfile consistent between versions
- Move Docker layers to bottom for smaller downloads, useful for those using previous versions
- Same Docker version tag, so just remove Docker image locally and re-pull to use
libsodium-dev
package andsodium
PHP extension for Magento 2.3.2 support.- New PHP docker versions
7.1-fpm-10
,7.2-fpm-1
- Allow setup without SSH credentials.
- Documentation for connecting to MySQL.
bin/status
to check container status.
- Readme for existing installs.
bin/dev-urn-catalog-generate
to look atsrc
folder as project root.
- Readme usage of pasting command into non-standard terminal.
- Host bind mount
var/log
folder indocker-compose.dev.yml
for debugging purposes. - Redis is now the default storage engine for cache and session. Massively improved performance for local dev! 🚀
- Added commented-out line in
docker-compose.dev.yml
file to easily mountauth.json
file, with updated usage in README
- Cron not working correctly
- Helper script
bin/fixowns
now fixes permissions on/var/www
instead of/var/www/html
folder. - Removed superfluous mounting of
~/.composer
directory indocker-compose.dev.yml
file.
- Helper script
bin/copytocontainer
now callsbin/fixowns
afterwards to ensure correct file ownerships are set.
- Helper script
bin/removevolumes
to remove docker volumes easily. - Added removal of
vendor
folder and force of composer install tobin/setup
script. When installed from zip, it's possible Magento isn't installing all deps properly and assigning wrong permissions in Docker. Forcing a reinstall fixes this issue. - Force deploy of static content when running
bin/setup
to speed up initial requests.
- Fixed helper script
bin/dev-urn-catalog-generate
to copy file to host.
🎅 Santa Shust wishes you a very Merry Christmas!
- 💯 performance improvements (14 second load times now take 7 seconds!)
- The
bin/start
helper script no longer copies docker volumes introduced in version 18.0.0. Thedocker-compose.yml
setup has been updated to only reference native Docker volumes. A newdocker-compose.dev.yml
file has been added to reference development-specific settings, including host bind mounts. Only.composer
,app/code
,app/design
,app/etc
,composer.json
,composer.lock
, andnginx.conf
filesystem locations are host bind mounted. Being very specific in which files and folders are being mounted leads to drastically faster response times. The main culprit in performance penalties before was mountinggenerated
andvar
folders as host bind mounts. These directories are considered "caching" folders and should never be host bind mounted. - If you need access to specific files that are created within the container and are not host bind mounted, you can use
bin/cli
orbin/bash
commands to go into the container to access the files. You can also use the newbin/copyfromcontainer
andbin/copytocontainer
bin helper scripts to copy files & folders from or to containers. - If you need to host bind mount files or folders, feel free to do so within the
docker-compose.dev.yml
file! Just be aware there is a performance penalty for doing so.
- The
- Updated
nginx
Docker image to look fornginx.conf
file instead ofnginx.conf.sample
file. This will now require copying thenginx.conf.sample
file tonginx.conf
, or using a host bind mount. This location allows overrides that aren't overridden when you upgrade Magento, and allow customizations for projects. Tagged new image asmarkoshust/magento-nginx:1.13-7
. - The
bin/setup
helper script uses only thedocker-compose.yml
file, with only native docker volume mounts. - The
bin/start
helper script uses bothdocker-compose.yml
anddocker-compose.dev.yml
files. Development-only specifications should now be placed withindocker-compose.dev.yml
, such as host bind volume mounts. - The
docker-compose.yml
file now uses asockdata
volume mount to mount the/sock
directory. You may need to delete theappdata
volume mount (docker volume rm NAME
) and rebuild it withbin/copytocontainer --all
. - Removed call to
bin/fixperms
withinbin/setup
to speed up initial installation.
- Added
bin/copyfromcontainer
andbin/copytocontainer
helper scripts to copy folders or files from or to containers. Specify the--all
option to copy entire web directory structure. - Added
bin/rootnotty
to run root commands with no TTY (needed for unassisted one-line setup with new volume setup). - Added
bin/fixowns
to fix filesystem ownerships within the Docker container. - Added
docker-compose.dev.yml
file for development-only specifications.
- 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.
- The PHP 5.6 and 7.0 images have been deprecated, as both of these versions have reached end-of-life. These versions have been removed from the README and are no longer maintained. If you still wish to use these images, please reference the README on tag 20.1.1, but please be aware these images are no longer maintained.
- Removed
bin/copydir
andbin/copydirall
helper scripts.
- Fixed typo in docker-compose.yml for linux
- Official support for Elasticsearch. Go to Admin > Stores > Configuration > Catalog > Catalog > Catalog Search, and select "Elasticsarch 5.0+" from the list of options. Keep all defaults the same, but set Elasticsearch Server Hostname to
elasticsearch
. Save, clear the cache, and runbin/magento indexer:reindex
to enable.
- Official support for Magento 2.3 & PHP 7.2. Officially tagging
7.2-fpm-0
php image.
- Various updates to README, including references now being made to Magento 2.3.
- Added comments to docker-compose for fixes needed on Linux machines (volume mounts and host.docker.internal fix).
- Volume mount issues on linux. Updated
bin/start
to ignore call tobin/copydirall
when ran on Linux.
- Added SSL support and made it enabled by default in the nginx config. All http requests will also be forwarded to https.
- Magento 2 nginx configuration now includes
nginx.conf.sample
file from root installation directory for configuration, instead of having standalone configuration.
- Reverted old
bin/cli
usage and createdbin/clinotty
for non-tty sessions. Updated calls inbin/setup
and other scripts where appropriate tobin/clinotty
.
- Changed the way bind mounts work with Docker compose and Magento 2.
- Note that
bin/start
now includes a call tobin/copydirall
after the containers start. This helper script runs adocker cp
command of all Magento directories from the container to the host. There is still a bind mount setup to./src
root directory. - There is a condition/bug within Docker that when named volumes overlap with bind mounts, the named volumes automatically sync back to the host once a
docker cp
command runs, while retaining their named volume status within the Docker container. - We're tapping into this very odd bug and taking advantage of this as long as we can. Since data is still fetched from within the Docker container as a named volume, this should also allow not-so-performant computers to now run this Docker setup, as it provides near or truly native filesystem performance, since requests to these directories are still fetched through the named volume as far as Docker is concerned.
- Note that
bin/start
now runs in daemon mode, as we also need to runbin/copydirall
immediately after starting containers so data syncs back to the host (and vice versa). This also eliminates the need to to have a terminal window open all the time for keeping containers running.
- Added back support for Magento 1 and PHP 5.6 containers. Magento 1 EOL will not be until 2020, so we should support these images and Docker Compose setup indefinitely for the time being.
- Added new
bin/restart
helper script to stop and start all containers. - Added new
bin/remove
helper script to remove all containers. - Added new
bin/copydir
which copies whichever folder you wish from the container to the host. - Added new
bin/copydirall
which copies all Magento folders from the container to the host. - Added
lib/template
andlib/onelinesetup
for much easier installation methods. - Added automatic Xdebug support for VS Code - no setup needed!
- Removed
bin/initloopback
along with any references to10.254.254.254
ip address. This may break existing Xdebug setups. Note that this ip address has been replaced withhost.docker.internal
, which should automatically resolve back to the host machine.
- Removed bind mount of vendor folder introduced in 16.2.0 due to inconsistency issues. Update coming soon that will implement new method of bind mounting.
- Removed idekey setting from php.ini config.
- Simplified Xdebug configuration for PHPStorm. This will require configuration updates for all users using Xdebug within PHPStorm.
- Added support for Xdebug and VS Code.
- Updated docker-compose.yml file to volume mount vendor folder for 50% performance increase
- Added php ssh2 extension
- The PHP 5.6 release will no longer be maintained, the last released version is 16.0.0
- Moved
dev/auth.json
todev/composer/auth.json
- Added
client_max_body_size 20M
to nginx.conf - Added
upload_max_filesize = 20M
andpost_max_size = 20M
to php.ini
- Bugs with npm permissions.
- NodeJS 8 and npm 5 added to the PHP images!
- New PHP 7.2 image. Be aware that this hasn't yet been fully tested.
- New helper scripts bin/grunt, bin/node, bin/npm and bin/stop.
- All bin helper script calls from ./bin/name to bin/name.
- Updated bin scripts for Windows, possible breaking updates.
- Magento 2.2.5 requires username and password to be different values. Updated to dummy "John Smith" user persona with username
john.smith
and passwordpassword123
.
- New
dev/auth.json
file used instead of~/.composer/auth.json
file, so each project can have different auth credentials.
- The
cron
service is now disabled by default. This services uses higher CPU and should probably only be enabled when working on cron-related tasks (or on production).