❗ Important: admin password has changed! Check you password with bellow documentation if you can't login to the Admin Panel after installation.
magento/project-community-edition is used to deploy a Magento 2 project from packages.
See Alan Kent's post REDUCING MAGENTO 2 INSTALL PAIN THROUGH VIRTUALIZATION, where he describes two different strategies of using Magento 2 code:
... there are two different ways that developers are likely to interact with the Magento 2 code base now with the public GitHub repository now accepting pull requests.
- Developers wishing to contribute to the Magento 2 code base (e.g. to submit a pull request with a bug fix) will clone the Magento 2 repository.
- Developers building a customer production site should not clone the Magento 2 repository – they should instead use the officially released Composer packages (with version numbers), downloaded via Composer. They are also likely to make a number of local customizations that they would manage for that specific site.
In his post, Alan touches on the first scenario while this Vagrant configuration covers the second one. I'd also add a third scenario: developers creating their own extensions. I believe that in this scenario, the Magento code base should also be deployed from packages (covered by this configuration).
The current Vagrant configuration performs the following:
- Runs Ubunty box
- Installs and configures all software necessary for Magento 2
- Downloads Magento 2 code from Composer packages
- Installs all necessary libraries
- Installs the Magento 2 application
If you never used Vagrant before, read Vagrant Docs
You need to install:
- Vagrant
- VirtualBox (used by the current configuration)
To install, configure, and run the Magento VM, you need to launch virtualbox and then execute the following via command line:
cd magento2-product # empty folder for the Magento 2 product
git clone https://github.com/buskamuza/magento2-product-vagrant.git .
vagrant up
The hostname of the Magento application is derived from hostname of the VM defined in the Vagrantfile:
config.vm.hostname = "magento2.product.dev"
Change this value in the Vagrantfile if you want to use different hostname.
If Vagrant can't determine hostname of the VM for some reason, it will use its IP address (also specified in Vagrantfile).
Also make sure you update your system hosts file with a record that links the IP address and hostname of the VM.
For the following Vagrantfile
...
config.vm.network :private_network, ip: '192.168.10.11'
config.vm.hostname = "magento2.product.dev"
...
Specify the following in your hosts file:
192.168.10.11 magento2.dev
There are several options that allow customize installation process of the Magento application.
The options are declared in Vagrant file as following:
s.args = [
#"reinstall",
"with_sample_data",
"deploy_static_view_files",
]
# (comment sign) disables the option. If you want to enable a particular option, remove this sign.
And vice versa, uncomment the option to enable it.
List of currently supported arguments:
| Argument | Description | Default |
|---|---|---|
reinstall |
Reinstall application if vagrant provision is used on already installed instance |
disabled |
with_sample_data |
Install Sample Data | enabled |
deploy_static_view_files |
Deploy static view files for better performance | enabled |
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. You should see the following message in the Vagrant log:
Installing GitHub OAuth token from /vagrant/local.config/github.oauth.token
Upon a successful installation, you'll see the location and URL of the newly-installed Magento 2 application:
Installed Magento application in /var/www/magento2
Access front-end at http://192.168.10.11/
Access back-end at http://192.168.10.11/admin/
/var/www/magento2 is a path to your Magento installation on the VM.
db host: localhost (not accessible remotely)
db user/password: magento/magento
db name: magento
also available db user/password: root/password
Magento admin user/password: admin/1amtheadmin
If the installation terminates at any time, you can run it again using the following command:
vagrant provision
If or you want to get rid of the VM, you can use
vagrant destroy
from inside the Magento 2 product folder.
Vagrant for magento/magento2:
- https://github.com/alankent/vagrant-magento2-apache-base
- https://github.com/ryanstreet/magento2-vagrant
- https://github.com/rgranadino/mage2_vagrant
Additionally, I'd like to thank the authors of the above repositories as they provided me with some ideas for a better implementation of the Vagrant configuration.