It is expected that Magento 2 project source code will be located and managed on the host. This is necessary 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. Custom solution is implemented for Windows hosts. See explanation of the proposed solution.
Environment for Magento EE development is configured as well.
It is easy to install multiple Magento instances based on different codebases simultaneously.
Project initialization script configures complete development environment:
- Adds some missing software on the host
- Configures all software necessary for Magento 2 using custom Ubuntu vagrant box (Apache 2.4, PHP 7.0 (or 5.5.9), MySQL 5.6, Git, Composer, XDebug, Rabbit MQ)
- Installs Magento 2
- Configures PHP Storm project (partially at the moment)
If you never used Vagrant before, read Vagrant Docs
Software listed below should be available in PATH (except for PHP Storm).
-
Git. Make sure you have SSH keys generated and associated with your github account, see how to check and how to configure if not configured.
ℹ️ It is possible to use another way of getting codebase instead of cloning, it does not matter for successful installation. Just put Magento 2 codebase inside ofvagrant-magento/magento2ce.
ℹ️
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 is optional but recommended.
-
NFS server must be installed and running on *nix and OSX hosts. Is usually available, so just try to follow installation steps first.
-
Open terminal and change directory to the one which you want to contain Magento project.
On Windows use Git Bash, which is available after Git installation -
Download project with Vagrant configuration:
git clone git@github.com:paliarush/magento2-vagrant-for-developers.git vagrant-magento
-
Copy etc/composer/auth.json.dist to
etc/composer/auth.jsonand specify your GitHub OAuth token there. See API rate limit and OAuth tokens for more information -
Optionally, copy etc/config.yaml.dist as
etc/config.yamland make necessary customizations -
Initialize project, configure environment, install Magento, configure PHPStorm project:
cd vagrant-magento
bash init_project.sh
ℹ️ 
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
ℹ️ 
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
-
Use
vagrant-magentodirectory as project root in PHP Storm (notvagrant-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 deployment configuration in PHP Storm -
Configure remote PHP interpreter in PHP Storm. Go to
Settings => Languages & Frameworks => PHP, add new remote interpreter and select "Deployment configuration" as a source for connection details.
Some of default settings are available for override. These settings can be found in the file etc/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, credentialsguest/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 and *nix hosts: the same as on host
- Can be retrieved from environment variable:
- MySQL DB host:
localhost(not accessible remotely) - MySQL DB name:
magento,magento_integration_tests - MySQL DB user/password: just use
mysqlwith no user and password (root/passwordwill 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
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).
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 etc/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.
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:
bash m-reinstall
Go to 'vagrant-magento' created earlier and run in command line:
bash m-clear-cache
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
ℹ️ On OSX and *nix hosts without NFS
you will be asked to wait until uploading process in PhpStorm is finished(PhpStorm should be lunched). To continue the process you need to press any key.
process is finished. To continue the process you need to press any key.
:information_source: On Windows hosts you will be asked to wait until uploading
process in PhpStorm is finished(PhpStorm should be lunched). To continue the process you need to press any key.
Go to 'vagrant-magento' created earlier and run in command line:
bash m-composer install
OR
bash m-composer update
Go to 'vagrant-magento' created earlier and run in command line:
bash m-bin-magento <command_name>
e.g.
bash m-bin-magento list
XDebug is already configured to connect to the host machine automatically. So just:
- Set XDEBUG_SESSION=1 cookie (e.g. using 'easy Xdebug' extension for Firefox). See XDebug documentation for more details
- Start listening for PHP Debug connections in PhpStorm on default 9000 port. See how to integrate XDebug with PhpStorm
- Set beakpoint or set option in PhpStorm menu 'Run -> Break at first line in PHP scripts'
Answer can be found here
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