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.
- N/A
- Allow setup without SSH credentials.
- Documentation for connecting to MySQL.
bin/statusto check container status
- Readme for existing installs
bin/dev-urn-catalog-generateto look atsrcfolder as project root.
- Readme usage of pasting command into non-standard terminal.
- Host bind mount
var/logfolder indocker-compose.dev.ymlfor 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.ymlfile to easily mountauth.jsonfile, with updated usage in README
- Cron not working correctly
- Helper script
bin/fixownsnow fixes permissions on/var/wwwinstead of/var/www/htmlfolder. - Removed superfluous mounting of
~/.composerdirectory indocker-compose.dev.ymlfile.
- Helper script
bin/copytocontainernow callsbin/fixownsafterwards to ensure correct file ownerships are set.
- Helper script
bin/removevolumesto remove docker volumes easily. - Added removal of
vendorfolder and force of composer install tobin/setupscript. 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/setupto speed up initial requests.
- Fixed helper script
bin/dev-urn-catalog-generateto copy file to host.
🎅 Santa Shust wishes you a very Merry Christmas!
- 💯 performance improvements (14 second load times now take 7 seconds!)
- The
bin/starthelper script no longer copies docker volumes introduced in version 18.0.0. Thedocker-compose.ymlsetup has been updated to only reference native Docker volumes. A newdocker-compose.dev.ymlfile 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.conffilesystem 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 mountinggeneratedandvarfolders 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/cliorbin/bashcommands to go into the container to access the files. You can also use the newbin/copyfromcontainerandbin/copytocontainerbin 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.ymlfile! Just be aware there is a performance penalty for doing so.
- The
- Updated
nginxDocker image to look fornginx.conffile instead ofnginx.conf.samplefile. This will now require copying thenginx.conf.samplefile 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/setuphelper script uses ohly thedocker-compose.ymlfile, with only native docker volume mounts. - The
bin/starthelper script uses bothdocker-compose.ymlanddocker-compose.dev.ymlfiles. Development-only specifications should now be placed withindocker-compose.dev.yml, such as host bind volume mounts. - The
docker-compose.ymlfile now uses asockdatavolume mount to mount the/sockdirectory. You may need to delete theappdatavolume mount (docker volume rm NAME) and rebuild it withbin/copytocontainer --all. - Removed call to
bin/fixpermswithinbin/setupto speed up initial installation.
- Added
bin/copyfromcontainerandbin/copytocontainerhelper scripts to copy folders or files from or to containers. Specify the--alloption to copy entire web directory structure. - Added
bin/rootnottyto run root commands with no TTY (needed for unassisted one-line setup with new volume setup). - Added
bin/fixownsto fix filesystem ownerships within the Docker container. - Added
docker-compose.dev.ymlfile 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/copydirandbin/copydirallhelper 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:reindexto enable.
- Official support for Magento 2.3 & PHP 7.2. Officially tagging
7.2-fpm-0php 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/startto ignore call tobin/copydirallwhen 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.samplefile from root installation directory for configuration, instead of having standalone configuration.
- Reverted old
bin/cliusage and createdbin/clinottyfor non-tty sessions. Updated calls inbin/setupand other scripts where appropriate tobin/clinotty.
- Changed the way bind mounts work with Docker compose and Magento 2.
- Note that
bin/startnow includes a call tobin/copydirallafter the containers start. This helper script runs adocker cpcommand of all Magento directories from the container to the host. There is still a bind mount setup to./srcroot 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 cpcommand 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/startnow runs in daemon mode, as we also need to runbin/copydirallimmediately 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/restarthelper script to stop and start all containers. - Added new
bin/removehelper script to remove all containers. - Added new
bin/copydirwhich copies whichever folder you wish from the container to the host. - Added new
bin/copydirallwhich copies all Magento folders from the container to the host. - Added
lib/templateandlib/onelinesetupfor much easier installation methods. - Added automatic Xdebug support for VS Code - no setup needed!
- Removed
bin/initloopbackalong with any references to10.254.254.254ip 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 cominmg 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.jsontodev/composer/auth.json - Added
client_max_body_size 20Mto nginx.conf - Added
upload_max_filesize = 20Mandpost_max_size = 20Mto 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.smithand passwordpassword123.
- New
dev/auth.jsonfile used instead of~/.composer/auth.jsonfile, so each project can have different auth credentials.
- The
cronservice 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).