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

• What You get
• How to install
  • Requirements
  • Installation steps
    • Windows
    • OSX and *nix
  • Default credentials and settings
  • GitHub limitations
• Day-to-day development scenarios
  • Reinstall Magento
  • Clear magento cache
  • Debugging with XDebug

What You get

It is expected that Magento 2 project source code will be located on the host. This is necessary to allow IDE index project files quickly. 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. Custom solution is implemented for Windows hosts. See explanation of the proposed solution.

Project initialization script configures complete development environment (available for OSX and *nix hosts):

1. Adds some missing software on the host
2. Installs and configures all software necessary for Magento 2 on the Ubuntu vagrant box (Apache 2.4, PHP 7.0 (or 5.5.9), MySQL 5.6, git, Composer, XDebug, Rabbit MQ)
3. Installs Magento 2
4. Configures PHP Storm project (partially at the moment)

How to install

If you never used Vagrant before, read Vagrant Docs

Requirements

• Vagrant 1.8+ is installed and available globally in command line
• VirtualBox
• PHP (any version) to allow Magento dependency management with Composer
• Git. Make sure you have SSH keys generated and associated with your github account, see manual. :information_source: It is possible to use another way of getting codebase instead of cloning, it does not matter for successful installation.
• PHP Storm is optional but recommended.

Installation steps

Windows

1. Run in command line from the directory which contains your projects:

   1. Download project with Vagrant configuration:

      git config --global core.autocrlf false
      git config --global core.eol LF
      git config --global diff.renamelimit 5000
      git clone git@github.com:paliarush/magento2-vagrant-for-developers.git vagrant-magento
      

   2. Copy local.config/composer/auth.json.dist to local.config/composer/auth.json and specify your GitHub OAuth token there. See API rate limit and OAuth tokens for more information.

   3. Optionally, copy local.config/config.yaml.dist as local.config/config.yaml and make necessary customizations.

   4. Prepare Magento codebase. This step is optional, just ensure you have magento2ce directory with Magento code available.

      ℹ️ If composer install fails to fetch some dependencies, add --prefer-source option or follow the instructions provided in Gighub limitations section

      cd vagrant-magento
      git clone git@github.com:magento/magento2.git magento2ce
      cd magento2ce
      mkdir -p var/generation
      composer install --ignore-platform-reqs
      cd ..
      

   5. Deploy environment and install Magento (may take some time to download Ubuntu box for the first time, then ~ 5 minutes):

      vagrant plugin install vagrant-hostmanager
      vagrant plugin install vagrant-vbguest
      vagrant up
      

2. After the installation is complete, set up synchronization with PHP Storm

OSX and *nix

1. Run in command line from the directory which contains your projects:

   1. Download project with Vagrant configuration:

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

   1. Copy local.config/composer/auth.json.dist to local.config/composer/auth.json and specify your GitHub OAuth token there. See API rate limit and OAuth tokens for more information.

   2. Optionally, copy local.config/config.yaml.dist as local.config/config.yaml and make necessary customizations.

   3. Initialize project, configure environment, install Magento, configure PHPStorm project:

   ```
   cd vagrant-magento
   bash init_project.sh
   ```
   
   :information_source: 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](local.config/config.yaml.dist) to `0`
   

   1. Use vagrant-magento directory as 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

Default credentials and settings

Some of default settings are available for override. These settings can be found in the file local.config/config.yaml.dist. To override settings just create a copy of the file under the name 'config.yaml' and put there 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 2 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

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, *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: just use mysql with no user and password (root/password will be used by default)

GitHub limitations

Be aware that you may encounter GitHub limits on the number of downloads (used by Composer to download Magento dependencies).

These limits may significantly slow down the installation since all of the libraries will be cloned from GitHub repositories instead of downloaded as ZIP archives. In the worst case, these limitations may even terminate the installation.

If you have a GitHub account, you can bypass these limitations by using an OAuth token in the Composer configuration. See API rate limit and OAuth tokens for more information.

For the Vagrant configuration you may specify your token in local.config/github.oauth.token file after cloning the repository. The file is a basic text file and is ignored by Git, so you'll need to create it yourself. Simply write your OAuth token in this file making sure to avoid any empty spaces, and it will be read during deployment.

Day-to-day development scenarios

Reinstall Magento

To save some time and get clear Magento installation, you can skip installation of software like web server or php. The following command will clear Magento DB, Magento caches and reinstall Magento instance.

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

vagrant provision --provision-with install_magento

Clear magento cache

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

vagrant ssh -c 'magento_clear_cache'

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. See how to integrate XDebug with PhpStorm
3. Set beakpoint or set option in PhpStorm menu 'Run -> Break at first line in PHP scripts'