/magento-docker

Primary LanguagePHPMIT LicenseMIT

magento-docker

magento-docker is Docker environment for easy to setup, configure, debug Magento2 instance with varnish, elasticsearch, redis, rabbit and mftf tests.

Requirements

How to install

  1. Add magento.test to /etc/hosts: 127.0.0.1 magento.test.
  2. Create your project directory:
  • cd ~/
  • mkdir www
  • cd www
  • chown -R $USER:root .
  • chmod g+s .
  1. Clone magento-docker into you project directory: git clone git@github.com:duhon/magento-docker.git)
  2. Clone magento repository into your project directory under magento2ce directory name: git clone git@github.com:magento/magento2.git magento2ce Now your project directory ~/www has 2 folders: magento-docker & magento2ce.
  3. cp magento-docker/bundles/typical.yml magento-docker/docker-compose.yml In docker-compose.yml you can choose what containers and what extensions you really need.
  4. cp magento-docker/.env.dist magento-docker/.env In .env file environment variables are declared. Here you can change your MAGENTO_PATH into your project correct path or change your service containers ports together with COMPOSE_PROJECT_NAME.
  5. Enter your magento-docker repository: cd ~/www/magento-docker.
  6. Run docker-compose up. As a result all containers should be up. You can check if containers are up by running: docker-compose ps.
  7. Check in browser if your magento host is up and running. Enter http://magento.test:80 in browser. 80 is a default port but you can change it in .env file.
  8. Install magento: docker-compose exec app magento reinstall. If you want to install ee/b2b versions run docker-compose exec app magento reinstall <ee|b2b>.
  9. Magento installed.

Scenarios

1. Enter container

  • Run docker-compose exec app bash.

2. Relaunch container

  • Run docker-compose scale <container_name>=0 && docker-compose scale <container_name>=1. For example: docker-compose scale app=0 && docker-compose scale app=1.

3. Run tests

  1. docker-compose exec app magento prepare_tests
  2. docker-compose exec app bin/magento dev:tests:run (unit, integration)
  3. docker-compose exec app bash
  4. cd dev/tests/acceptance/ and vendor/bin/codecept run (mftf)
  5. cd dev/tests/functional/ and vendor/bin/phpunit run (mtf)
  6. vnc://localhost:5900 pass:secret (mftf or mtf)

4. Enable/disable Xdebug

  • To enable xdebug, uncomment xdebug.ini line of app container in docker-compose.yml and run docker-compose scale app=0 && docker-compose scale app=1. :warning: Enabled Xdebug may slow your environment.

5. Magento (Re)-Installation

  • docker-compose exec app magento reinstall (ee|b2b)

6. Optimization host

  1. Redis optimization 
    docker run -it --rm --privileged ubuntu /bin/bash
echo never | tee /sys/kernel/mm/transparent_hugepage/enabled
echo never | tee /sys/kernel/mm/transparent_hugepage/defrag
  2. Optimization for MacOS

FAQ

  1. If docker containers do not go up, check errors in console, run docker-compose down, fix issue and run docker-compose up again.
  2. If Overwrite the existing configuration for db-ssl-verify?[Y/n] prompts in console, type Y.
  3. If magento installation fails, run docker-compose exec app magento reinstall

TODO list

  1. To create a cross platform installer that will check for dependencies, create a folder with the project and download the Magento (see install.sh)
  2. The default creation of the project for phpstorm (see etc/phpstorm)
  3. A single point of running tests with the preparation (magento prepare_tests) of Magento