Vagrant project for Magento 2 developers (optimized for Mac, Windows and *nix hosts)

⚠️ Current project is not supported anymore. Please check out https://github.com/magento/magento2-kubernetes-devbox which is under development and may become an official devbox for Magento 2 in the future.

• What You get
• How to install
  • Requirements
  • Installation steps
  • Default credentials and settings
  • Getting updates and fixes
• Day-to-day development scenarios
  • Reinstall Magento
  • Clear Magento cache
  • Switch between CE and EE
  • Sample data installation
  • Basic data generation
  • Use Magento CLI (bin/magento)
  • Debugging with XDebug
  • Connecting to MySQL DB
  • View emails sent by Magento
  • Accessing PHP and other config files
  • Upgrading Magento
  • Multiple Magento instances
  • Update Composer dependencies
  • Running Magento tests
• Environment configuration
  • Switch between PHP versions
  • Activating Varnish
  • Activating ElasticSearch
  • Redis for caching
  • Reset environment
  • Switch NodeJS Versions
• FAQ

What You get

It's expected that the Magento 2 project source code will be located and managed on the host to allow quick indexing of project files by IDE. All other infrastructure is deployed on the guest machine.

Current Vagrant configuration aims to solve performance issues of Magento installed on Virtual Box for development. A custom solution is implemented for Windows hosts. See explanation of the proposed solution.

The environment for Magento EE development is also configured.

It is easy to install multiple Magento instances based on different codebases simultaneously.

The project initialization script configures a complete development environment:

1. Adds some missing software on the host
2. Configures all software necessary for Magento 2 using a custom Ubuntu vagrant box (Apache 2.4, PHP 7.0 or 5.6, MySQL 5.6, Git, Composer, XDebug, Rabbit MQ, Varnish)
3. Installs Magento 2 from Git repositories or Composer packages (can be configured via checkout_source_from option in etc/config.yaml)
4. Configures PHP Storm project (partially at the moment)
5. Installs NodeJS, NPM, Grunt and Gulp for front end development

ℹ️ This box uses the n package manager to provide the latest NodeJS LTS version.

How to install

If you never used Vagrant before, read the Vagrant Docs first.

Requirements

The software listed below should be available in PATH (except for PHP Storm).

• Vagrant 1.8+

• VirtualBox

• Git - Ensure that SSH keys are generated and associated with your Github account. See how to check and how to configure, if not configured.
  ℹ️ To obtain the codebase without cloning, just use the Magento 2 codebase instead of vagrant-magento/magento2ce. Either method will produce a successful installation.
  

  ℹ️ On Windows hosts Git must be v2.7+. Also make sure to set the following options to avoid issues with incorrect line separators:

  git config --global core.autocrlf false
  git config --global core.eol LF
  git config --global diff.renamelimit 5000
  

• PHP (any version) to allow Magento dependency management with Composer

• PHP Storm, optional but recommended

• NFS server must be installed and running on *nix and OSX hosts; usually available, follow installation steps first

Installation steps

ℹ️ In case of any issues during installation, please read FAQ section

1. Open terminal and change your directory to the one you want to contain Magento project. On Windows use Git Bash, which is available after Git installation.

2. Download or clone the project with Vagrant configuration:

   ⚠️ Do not open it in PhpStorm until init_project.sh has completed PhpStorm configuration in the initialize project step below.

   git clone git@github.com:paliarush/magento2-vagrant-for-developers.git vagrant-magento
   

   Optionally, if you use private repositories on GitHub or download packages from the Magento Marketplace using Composer

   1. Copy etc/composer/auth.json.dist to etc/composer/auth.json.
   2. Specify your GitHub token by adding "github.com": "your-github-token" to the github-oauth section for GitHub authorization.
   3. Add the Magento Marketplace keys for Marketplace authorization to the repo.magento.com section.
   4. Copy (optional) etc/config.yaml.dist as etc/config.yaml and make the necessary customizations.

3. Initialize the project (this will configure the environment, install Magento, and configure the PHPStorm project):

   cd vagrant-magento
   bash init_project.sh
   

4. Use the vagrant-magento directory as the project root in PHP Storm (not vagrant-magento/magento2ce). This is important, because in this case PHP Storm will be configured automatically by init_project.sh. If NFS files sync is disabled in config and on Windows hosts verify the deployment configuration in PHP Storm.

   Use the URL for accessing your Magento storefront in the browser as your Web server root URL. Typically this is the localhost, which refers to your development machine. Depending on how you've set up your VM you may also need a port number, like http://localhost:8080.

5. Configure the remote PHP interpreter in PHP Storm. Go to Preferences, then Languages and Frameworks. Click PHP and add a new remote interpreter. Select Deployment configuration as a source for connection details.

Default credentials and settings

Some of default settings are available for override. These settings can be found in the file etc/config.yaml.dist.

To override settings create a copy of the file under the name 'config.yaml' and add your custom settings.

When using init_project.sh, if not specified manually, random IP address is generated and is used as suffix for host name to prevent collisions, in case when two or more instances are running at the same time.

Upon a successful installation, you'll see the location and URL of the newly-installed Magento 2 application in console.

Web access:

• Access storefront at http://magento2.vagrant<random_suffix>
• Access admin panel at http://magento2.vagrant<random_suffix>/admin/
• Magento admin user/password: admin/123123q
• Rabbit MQ control panel: http://magento2.vagrant<random_suffix>:15672, credentials guest/guest

ℹ️ Your admin URL, storefront URL, and admin user and password are located in etc/config.yaml.dist.

Codebase and DB access:

• Path to your Magento installation on the VM:
  • Can be retrieved from environment variable: echo ${MAGENTO_ROOT}
  • On Windows hosts: /var/www/magento2ce
  • On Mac and *nix hosts: the same as on host
• MySQL DB host: localhost (not accessible remotely)
• MySQL DB name: magento, magento_integration_tests
• MySQL DB user/password: root:<no password>. In CLI just use mysql with no user and password (root:<no password> will be used by default)

Codebase on host

• CE codebase: vagrant_project_root/magento2ce
• EE codebase will be available if path to EE repository is specified in etc/config.yaml: vagrant_project_root/magento2ce/magento2ee

Getting updates and fixes

Current vagrant project follows semantic versioning so feel free to pull the latest features and fixes, they will not break your project. For example your current branch is 2.0, then it will be safe to pull any changes from origin/2.0. However branch 3.0 will contain changes backward incompatible with 2.0. Note, that semantic versioning is only used for x.0 branches (not for develop).

ℹ️ To apply changes run vagrant reload.

Day-to-day development scenarios

Reinstall Magento

Use commands described in Switch between CE and EE section with -f flag. Before doing actual re-installation, these commands update linking of EE codebase, clear cache, update composer dependencies.

If no composer update and relinking of EE codebase is necessary, use the following command. It will clear Magento DB, Magento caches and reinstall Magento instance.

Go to the root of vagrant project in command line and execute:

bash m-reinstall

Clear Magento cache

Go to the root of vagrant project in command line and execute:

bash m-clear-cache

Switch between CE and EE

Assume, that EE codebase is available in vagrant_project_root/magento2ce/magento2ee. The following commands will link/unlink EE codebase, clear cache, update composer dependencies and reinstall Magento. Go to 'vagrant-magento' created earlier and run in command line:

bash m-switch-to-ce
OR
bash m-switch-to-ee

Force switch can be done using -f flag even if already switched to the target edition. May be helpful to relink EE modules after switching between branches.

Upgrade can be performed instead of re-installation using -u flag.

ℹ️ On Windows hosts (or when NFS mode is disabled in config.yaml explicitly) you will be asked to wait until code is uploaded to guest machine by PhpStorm (PhpStorm must be launched). To continue the process press any key.

Sample data installation

Make sure that ce_sample_data and ee_sample_data are defined in config.yaml and point CE and optionally EE sample data repositories. During initial project setup or during bash init_project.sh -fc (with -fc project will be re-created from scratch), sample data repositories willl be checked out to vagrant_project_root/magento2ce/magento2ce-sample-data and vagrant_project_root/magento2ce/magento2ee-sample-data.

To install Magento with sample data set install_sample_data in config.yaml to 1 and run bash m-switch-to-ce -f or bash m-switch-to-ee -f, depending on the edition to be installed. To disable sample data, set this option to 0 and force-switch to necessary edition (using the same commands).

Basic data generation

Several entities are generated for testing purposes by default using REST API after Magento installation:

• Customer with address (credentials customer@example.com:123123qQ)
• Category
• Couple simple products
• Configurable product

To disable this feature, set magento/generate_basic_data in config.yaml to 0 and run bash m-switch-to-ce -f or bash m-switch-to-ee -f, depending on the edition to be installed.

Use Magento CLI (bin/magento)

Go to 'vagrant-magento' created earlier and run in command line:

bash m-bin-magento <command_name>
e.g.
bash m-bin-magento list

Debugging with XDebug

XDebug is already configured to connect to the host machine automatically. So just:

1. Set XDEBUG_SESSION=1 cookie (e.g. using 'easy Xdebug' extension for Firefox). See XDebug documentation for more details
2. Start listening for PHP Debug connections in PhpStorm on default 9000 port. See how to integrate XDebug with PhpStorm
3. Set beakpoint or set option in PhpStorm menu 'Run -> Break at first line in PHP scripts'

To debug a CLI script:

1. Create remote debug configuration in PhpStorm, use phpstorm as IDE key
2. Run created remote debug configuration
3. Run CLI command on the guest as follows (xdebug.remote_host value might be different for you):

php -d xdebug.remote_autostart=1 <path_to_cli_script>

To debug Magento Setup script, go to Magento installation script and find php ${install_cmd}. Follow steps above for any CLI script

ℹ️ In addition to XDebug support, config.yaml has several options in debug section which allow storefront and admin UI debugging. Plus, desired Magento mode (developer/production/default) can be enabled using magento_mode option, default is developer mode.

Connecting to MySQL DB

Answer can be found here

View emails sent by Magento

All emails are saved to 'vagrant-magento/log/email' in HTML format.

Accessing PHP and other config files

It is possible to view/modify majority of guest machine config files directly from IDE on the host. They will be accessible in etc/guest directory only when guest machine is running. The list of accessible configs includes: PHP, Apache, Mysql, Varnish, RabbitMQ. Do not edit any symlinks using PhpStorm because it may break your installation.

After editing configs in IDE it is still required to restart related services manually.

Upgrading Magento

Sometimes it is necessary to test upgrade flow. This can be easily done as follows (assuming that you have installed instance):

• For git-based installation - check out codebase corresponding to the target Magento version. Or modify your composer.json in case of composer-based installation
• Use commands described in Switch between CE and EE section with -u flag

Multiple Magento instances

To install several Magento instances based on different code bases, just follow Installation steps to initialize project in another directory on the host. Unique IP address, SSH port and domain name will be generated for each new instance if not specified manually in etc/config.yaml

Update Composer dependencies

Go to 'vagrant-magento' created earlier and run in command line:

bash m-composer install
OR
bash m-composer update

Running Magento tests

See draft

Environment configuration

Switch between PHP versions

Switch between PHP versions using "php_version: " option in config.yaml. Supported versions are 5.6, 7.0, 7.1 and 7.2. PHP version will be applied after "vagrant reload".

Activating Varnish

Set use_varnish: 1 to use varnish along with apache in config.yaml. Changes will be applied on m-reinstall. It will use default file etc/magento2_default_varnish.vcl.dist generated from a Magento 2.1 instance. Magento 2.2+ supports additional Varnish features and you may need to provide custom version of VCL to enable them. Varnish Version: 4.1

Use the following commands to enable/disable varnish without reinstalling Magento: m-varnish disable or m-varnish enable.

Activating ElasticSearch

ℹ️ Available in Magento EE only.

Set search_engine: "elasticsearch" in config.yaml to use ElasticSearch as current search engine or search_engine: "mysql" to use MySQL. Changes will be applied on m-reinstall.

Use the following commands to switch between search engines without reinstalling Magento: m-search-engine elasticsearch or m-search-engine mysql.

Redis for caching

ℹ️ Available in Magento v2.0.6 and higher.

Redis is configured as cache backend by default. It is still possible to switch back to filesystem cache by changing environment_cache_backend to filesystem in config.yaml.

Reset environment

It is possible to reset project environment to default state, which you usually get just after project initialization. The following command will delete vagrant box and vagrant project settings. After that it will initialize project from scratch. Magento 2 code base (magento2ce directory) and etc/config.yaml and PhpStorm settings will stay untouched, but guest config files (located in etc/guest) will be cleared.

Go to 'vagrant-magento' created earlier and run in command line:

bash init_project.sh -f

It is possible to reset Magento 2 code base at the same time. Magento 2 code base will be deleted and then cloned from the repositories specified in etc/config.yaml

bash init_project.sh -fc

To reset PhpStorm project configuration, in addition to -f specify -p option:

bash init_project.sh -fp

Ultimate project reset can be achieved by combining all available flags:

bash init_project.sh -fcp

Switch NodeJS Versions

By default, the box will install the latest NodeJS LTS version using the n package manager. If you need another version of Node because of Magento's package.json requirements, simply run:

n <version>

Note: See Working with npm if after switching versions with n, npm is not working properly.

FAQ

1. To debug any CLI script in current Vagrant project, set debug:vagrant_project option in config.yaml to 1

2. Is Windows 10 supported? Yes, but you may face the same issue as described here or here. Also Virtual box may not work on Windows 10 in headless mode, see how to enable GUI mode

3. On OSX and *nix hosts NFS will be used by default to sync your project files with guest. On some hosts Vagrant cannot configure NFS properly, in this case it is possible to deploy project without NFS by setting use_nfs option in config.yaml to 0
   

4. On Windows hosts you might face Composer Install Error: ZipArchive::extractTo(): Full extraction path exceed MAXPATHLEN (260) exception during composer install. This can be fixed in 2 ways: decrease path length to the project directory or set composer_prefer_source option in config.yaml to 1

5. Make sure that you used vagrant-magento directory as project root in PHP Storm (not vagrant-magento/magento2ce)

6. If project opened in PhpStorm looks broken, close PhpStorm and remove vagrant-magento/.idea. Run bash vagrant-magento/scripts/host/configure_php_storm.sh. After opening project in PhpStorm again everything should look good

7. If code is not synchronized properly on Windows hosts (or when NFS mode is disabled in config.yaml explicitly), make sure that PhpStorm is running before making any changes in the code. This is important because otherwise PhpStorm will not be able to detect changes and upload them to the guest machine

8. Please make sure that currently installed software, specified in requirements section, meets minimum version requirement

9. Be careful if your OS is case-insensitive, NFS might break the symlinks if you cd into the wrong casing and you power the vagrant up. Just be sure to cd in to the casing the directory was originally created as.

10. Cannot run unit tests from PHPStorm on Magento 2.2, see possible solution here

11. Permission denied (publickey)

12. If during a vagrant reload, the following message appears:

    There was a problem while downloading the metadata for your box to check for updates. This is not an error, since it is usually due to temporary network problems. This is just a warning. The problem encountered was: The requested URL returned error: 404 Not Found

    It is likely that your vagrant cli is caching an old url. Perform the following cli commands:

    sed -i -- 's/atlas.hashicorp/vagrantcloud/g' ~/.vagrant.d/boxes/{name of your paliarush/ubuntu image}/metadata_url
    mv ~/.vagrant.d/boxes/{name of your paliarush/ubuntu image}/metadata_url2 ~/.vagrant.d/boxes/{name of your paliarush/ubuntu image}/metadata_url