docker-magento  by markshust

Docker config for Magento 2 development

created 9 years ago
2,747 stars

Top 17.7% on sourcepulse

GitHubView on GitHub
Project Summary

This repository provides a comprehensive Docker-based development environment for Magento 2, targeting Magento developers and agencies. It simplifies setting up complex Magento instances, enabling faster development cycles and consistent environments across teams.

How It Works

The project utilizes Docker Compose to orchestrate multiple services, including Nginx, PHP-FPM, MySQL, OpenSearch/Elasticsearch, and RabbitMQ. It offers pre-built Docker images for each service, ensuring compatibility and ease of use. A suite of helper scripts (bin/*) automates common development tasks like installation, configuration, code deployment, and debugging.

Quick Start & Requirements

  • Install: curl -s https://raw.githubusercontent.com/markshust/docker-magento/master/lib/onelinesetup | bash -s -- magento.test community 2.4.8
  • Prerequisites: Docker Desktop (6GB RAM allocated to Docker, dual-core CPU, SSD recommended). Tested on Mac & Linux; Windows via WSL.
  • Setup Time: Automated setup is typically under 10 minutes.
  • Docs: M.academy Free Course

Highlighted Details

  • Automated setup script for new projects.
  • Support for both OpenSearch (default) and Elasticsearch.
  • Integrated tools for code quality (PHPCS, PHPMD), debugging (Xdebug), and frontend development (Grunt, LiveReload).
  • SSH/SFTP support for IDE integration (PhpStorm, VSCode) without host volume mounts.

Maintenance & Community

  • Maintained by Mark Shust, a 6x Adobe Commerce Certified Developer.
  • M.academy sponsorship.
  • Active development and community support channels are not explicitly listed in the README.

Licensing & Compatibility

  • MIT License. Permissive for commercial use and integration with closed-source projects.

Limitations & Caveats

  • Magento 1 support is deprecated.
  • ARM64/Apple M-series chips require a workaround for OpenSearch compatibility by modifying env/opensearch.env.
  • Linux users need to manually configure host.docker.internal and potentially firewall rules for Xdebug.
Health Check
Last commit

1 month ago

Responsiveness

Inactive

Pull Requests (30d)
1
Issues (30d)
13
Star History
56 stars in the last 90 days

Explore Similar Projects

Feedback? Help us improve.