Skip to content
Mage2click Docker-based development environment for Magento with mutagen.io sync for files on macOS and native filesystem mounts on Linux
Shell Dockerfile VCL HTML
Branch: master
Clone or download
Latest commit afcc98d Oct 14, 2019

README.md

Mage2click Docker Magento
environment and toolset

Mage2click Docker Magento environment and toolset

Supported Magento Versions Docker Hub Pulls Mage2click in Slack

Mage2click toolset is a system-wide command-line tool for creating and managing simultaneously running docker Magento projects with insanely easy installation and configuration. It includes plenty of configurable services and useful commands for developing and project orchestration right out of the box. On macOS systems, mutagen.io tool will be bundled in the toolset for high-performance files sync between host and docker containers.

Table of contents

Prerequisites

This setup assumes you are running Docker on a computer with at least 6GB of allocated RAM, a dual-core, and an SSD hard drive.

This configuration has been tested on macOS. Linux based systems still require testing. Any testing are welcomed!

Installation

To install Mage2click toolset to your system, simply run command below.

curl -sL raw.githubusercontent.com/mage2click/m2c/master/get | bash

Or shortened version of above.

curl -sL get.m2c.run | bash

What is included

Global system-wide services

After toolset is installed, you will have the next tools available locally:

Toolset local homepage with links to all tools listed above - https://m2c.test

All docker images with services listed above must be active. These services are configured to start automatically and should not be stopped. Without active Traefik and Dnsmasq, m2c backed projects can't work properly.

Per-project services

Most of services are available with version on your choice.

All docker Magento projects initialized with:

  • Nginx
  • PHP-FPM
  • MariaDB
  • Redis
  • Xdebug

And optionally available:

  • Varnish
  • Elasticsearch
  • phpMyadmin
  • RabbitMQ

Usage

After toolset is installed on your system, you may use it to initialize new or existing magento projects.

To get a list of all commands and usage information, run m2c or m2c --help which is equivalent.

Interactive project initialization mode

To initialize project, open the desired directory with terminal and run

m2c init

This command will launch project initialization in interactive mode. Simply follow the steps to configure the desired Docker Magento development environment.

Commandline project initialization mode

If at least one command argument is defined, automated setup will be started. All undefined parameters will be set with default values.

m2c init [parameters...] [flags...]

To get a list of all available parameters and flags for project configuration, run

m2c init --help

License

MIT

You can’t perform that action at this time.