Implemented simplified installation flow for *nix hosts

Author: paliarush

README.md

@@ -1,15 +1,17 @@
-# Vagrant for Magento, optimized for Windows hosts
+# Vagrant project for Magento 2 developers (optimized for Mac, Windows and \*nix hosts)
 
 ## What You get
 
-The current Vagrant configuration aims to solve performance issues of Magento installed on Virtual Box, when the host is Windows. 
-See [explanation of the proposed solution](docs/performance-issue-on-windows-hosts.md).
+It is expected that Magento 2 project source code will be located on the host and managed using [Composer](https://getcomposer.org/doc/00-intro.md). 
+This is necessary to allow IDE index project files quickly. All other infrastructure 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](docs/performance-issue-on-windows-hosts.md).
 
 With current configuration Vagrant will:
 
  1. Run Ubuntu box
  1. Install and configure all software necessary for Magento 2
- 1. Install all necessary libraries
  1. Install the Magento 2 application
 
 ## Environment set up workflow
@@ -38,7 +40,7 @@ If you never used Vagrant before, read [Vagrant Docs](https://docs.vagrantup.com
         cd ..
         ```
     
-     1. Download project with Vagrant configuration and install Magento (~ 5 minutes):
+     1. Download project with Vagrant configuration and install Magento (may take some time to download Ubuntu box for the first time, then ~ 5 minutes):
      
         ```
         git clone git@github.com:paliarush/vagrant-magento.git vagrant-magento
@@ -50,7 +52,7 @@ If you never used Vagrant before, read [Vagrant Docs](https://docs.vagrantup.com
     ```
     192.168.10.11 magento2.vagrant
     ```
- 1. After the installation is complete, [set up synchronization with PHP Storm](docs/phpstorm-configuration.md)
+ 1. For **Windows hosts only**: after the installation is complete, [set up synchronization with PHP Storm](docs/phpstorm-configuration-windows-hosts.md)
 
 ### After installation
 
@@ -83,7 +85,7 @@ For the Vagrant configuration you may specify your token in `local.config/github
 Installing GitHub OAuth token from /vagrant/local.config/github.oauth.token
 ```
 
-## Magento development workflow
+## 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.

Vagrantfile

@@ -1,30 +1,44 @@
 # -*- mode: ruby -*-
 # vi: set ft=ruby :
 
+module OS
+    def OS.is_windows
+        (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM) != nil
+    end
+end
+
 # All Vagrant configuration is done below. The "2" in Vagrant.configure
 # configures the configuration version (we support older styles for
 # backwards compatibility). Please don't change it unless you know what
 # you're doing.
 Vagrant.configure(2) do |config|
-  config.vm.box = "ubuntu/trusty64"
+    config.vm.box = "ubuntu/trusty64"
 
-  config.vm.provider "virtualbox" do |vb|
-     vb.memory = 2048
-  end
-  config.vm.network :private_network, ip: '192.168.10.11'
-  config.vm.hostname = "magento2.vagrant"
+    config.vm.provider "virtualbox" do |vb|
+        vb.memory = 2048
+    end
+    config.vm.network :private_network, ip: '192.168.10.11'
+    config.vm.hostname = "magento2.vagrant"
 
-  config.vm.synced_folder '.', '/vagrant'
-  config.vm.synced_folder '../magento2ce/var/generation', '/var/www/magento2ce/var/generation'
-  config.vm.synced_folder '../magento2ce/app/etc', '/var/www/magento2ce/app/etc'
+    config.vm.synced_folder '.', '/vagrant'
+    if OS.is_windows
+        config.vm.synced_folder '../magento2ce/var/generation', '/var/www/magento2ce/var/generation'
+        config.vm.synced_folder '../magento2ce/app/etc', '/var/www/magento2ce/app/etc'
+    else
+        config.vm.synced_folder '../magento2ce', '/var/www/magento2ce', type: "nfs"
+    end
 
-  config.vm.provision "install_environment", type: "shell" do |s|
-      s.path = "install_environment.sh"
-  end
+    config.vm.provision "install_environment", type: "shell" do |s|
+        s.path = "install_environment.sh"
+        s.args = [OS.is_windows ? "1" : "0"]
+    end
 
-  config.vm.provision "deploy_magento_code", type: "file", source: '../magento2ce', destination: '/var/www'
+    if OS.is_windows
+        config.vm.provision "deploy_magento_code", type: "file", source: '../magento2ce', destination: '/var/www'
+    end
 
-  config.vm.provision "install_magento", type: "shell" do |s|
-      s.path = "install_magento.sh"
-  end
+    config.vm.provision "install_magento", type: "shell" do |s|
+        s.path = "install_magento.sh"
+        s.args = [OS.is_windows ? "1" : "0"]
+    end
 end

docs/developer-use-cases.md

@@ -41,3 +41,11 @@ This solution is applicable to any Vagrant configuration for Magento instance, s
      1. Go to Tools -> Deployment -> Options... and enable automatic upload to default server and check "Upload external changes"
 
         ![](images/automatic-upload.png)
+
+
+Day-to-day development scenarios
+-----------------
+
+ 1. You can upload full Magento code base to the virtual machine from the host machine using context menu on the root of the project in PhpStorm. 
+ 
+     ![](images/upload-magento-codebase.png)

docs/phpstorm-configuration.md docs/phpstorm-configuration-windows-hosts.md

@@ -3,6 +3,8 @@
 # Enable trace printing and exit on the first error
 set -ex
 
+is_windows_host=$1
+
 apt-get update
 
 # Determine external IP address
@@ -73,10 +75,12 @@ if [ ! -f /usr/local/bin/composer ]; then
     mv composer.phar /usr/local/bin/composer
 fi
 
-# Set permissions to allow Magento codebase upload by Vagrant provision script
-chown -R vagrant:vagrant /var/www
-chmod -R 755 /var/www
-
 # Declare path to scripts supplied with vagrant and Magento
 magento_dir="/var/www/magento2ce"
 echo "export PATH=\$PATH:/vagrant/bin:${magento_dir}/bin" >> /etc/profile
+
+# Set permissions to allow Magento codebase upload by Vagrant provision script
+if [ ${is_windows_host} -eq 1 ]; then
+    chown -R vagrant:vagrant /var/www
+    chmod -R 755 /var/www
+fi

install_environment.sh

@@ -5,6 +5,8 @@
 # Enable trace printing and exit on the first error
 set -ex
 
+is_windows_host=$1
+
 # Determine external IP address
 set +x
 IP=`ifconfig eth1 | grep inet | awk '{print $2}' | sed 's/addr://'`
@@ -70,22 +72,27 @@ install_cmd="./bin/magento setup:install \
 chmod +x bin/magento
 php ${install_cmd}
 
-chown -R vagrant:vagrant ${magento_dir}
-
 # Enable Magento cron jobs
 echo "* * * * * php ${magento_dir}/bin/magento cron:run &" | crontab -u vagrant -
 
+if [ ${is_windows_host} -eq 1 ]; then
+    chown -R vagrant:vagrant ${magento_dir}
+fi
+
 set +x
 echo "
 Magento application was deployed in ${magento_dir} and installed successfully
 Access storefront at http://${HOST}/
 Access admin panel at http://${HOST}/${admin_frontame}/
 
-Don't forget to update your 'hosts' file with '${IP} ${HOST}'
+Don't forget to update your 'hosts' file with '${IP} ${HOST}'"
 
-[Optional] To finish developer environment set up:
-    1. Please create new PhpStorm project using 'magento2ce' directory on your host
-    (this directory should already contain Magento repository cloned earlier)
+if [ ${is_windows_host} -eq 1 ]; then
+    echo "
+    [Optional] To finish developer environment set up:
+        1. Please create new PhpStorm project using 'magento2ce' directory on your host
+        (this directory should already contain Magento repository cloned earlier)
 
-    2. Use instructions provided here https://github.com/paliarush/vagrant-magento/blob/master/docs/phpstorm-configuration.md
-    to set up synchronization in PhpStorm (or using rsync) with ${magento_dir} directory"
+        2. Use instructions provided here https://github.com/paliarush/vagrant-magento/blob/master/docs/phpstorm-configuration-windows-hosts.md
+        to set up synchronization in PhpStorm (or using rsync) with ${magento_dir} directory"
+fi