- Added support of EE linked to CE using symlinks on *nix hosts

- Added ${MAGENTO_ROOT} environment variable, which stores installation path on the guest

Author: Alexander Paliarush

README.md

@@ -67,7 +67,10 @@ Web access:
 - Magento admin user/password: `admin/123123q`
 
 Codebase and DB access:
-- Path to your Magento installation on the VM: `/var/www/magento2ce`
+- 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)
@@ -112,7 +115,3 @@ XDebug is already configured to connect to the host machine automatically. So ju
  1. Set XDEBUG_SESSION=1 cookie (e.g. using 'easy Xdebug' extension for Firefox). See [XDebug documentation](http://xdebug.org/docs/remote) for more details
  1. Start listening for PHP Debug connections in PhpStorm. See how to [integrate XDebug with PhpStorm](https://www.jetbrains.com/phpstorm/help/configuring-xdebug.html#integrationWithProduct)
  1. Set beakpoint or set option in PhpStorm menu 'Run -> Break at first line in PHP scripts'
-
-## Related Repositories
-
-- https://github.com/buskamuza/magento2-product-vagrant

Vagrantfile

@@ -7,6 +7,9 @@ module OS
     end
 end
 
+require 'pathname.rb'
+host_magento_dir = Pathname.new(Dir.pwd + '/../magento2ce').realpath.to_s
+
 # 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
@@ -22,23 +25,31 @@ Vagrant.configure(2) do |config|
 
     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'
+        guest_magento_dir = '/var/www/magento2ce'
+        config.vm.synced_folder host_magento_dir + '/var/generation', guest_magento_dir + '/var/generation'
+        config.vm.synced_folder host_magento_dir + '/app/etc', guest_magento_dir + '/app/etc'
     else
-        config.vm.synced_folder '../magento2ce', '/var/www/magento2ce', type: "nfs"
+        guest_magento_dir = host_magento_dir
+        config.vm.synced_folder host_magento_dir, guest_magento_dir, type: "nfs"
     end
 
     config.vm.provision "install_environment", type: "shell" do |s|
         s.path = "install_environment.sh"
-        s.args = [OS.is_windows ? "1" : "0"]
+        s.args = [
+            OS.is_windows ? "1" : "0",
+            guest_magento_dir
+        ]
     end
 
     if OS.is_windows
-        config.vm.provision "deploy_magento_code", type: "file", source: '../magento2ce', destination: '/var/www'
+        config.vm.provision "deploy_magento_code", type: "file", source: host_magento_dir, destination: '/var/www'
     end
 
     config.vm.provision "install_magento", type: "shell" do |s|
         s.path = "install_magento.sh"
-        s.args = [OS.is_windows ? "1" : "0"]
+        s.args = [
+            OS.is_windows ? "1" : "0",
+            guest_magento_dir
+        ]
     end
 end

bin/magento_clear_cache

@@ -2,18 +2,16 @@
 
 echo "Clearing Magento cache..."
 
-magento_path=/var/www/magento2ce
-
-rm -f ${magento_path}/app/etc/paths.php
+rm -f ${MAGENTO_ROOT}/app/etc/paths.php
 #clear var
-for dir in `ls ${magento_path}/var` ; do
-    rm -rf ${magento_path}/var/${dir}/* ;
+for dir in `ls ${MAGENTO_ROOT}/var` ; do
+    rm -rf ${MAGENTO_ROOT}/var/${dir}/* ;
 done
 #clear pub/statics
-cd ${magento_path}/pub && mv static/.htaccess static_htaccess.back && rm -rf static/* && mv static_htaccess.back static/.htaccess
+cd ${MAGENTO_ROOT}/pub && mv static/.htaccess static_htaccess.back && rm -rf static/* && mv static_htaccess.back static/.htaccess
 #clear integration tests tmp
-cd ${magento_path}/dev/tests/integration && mv tmp/.gitignore tmp_gitignore.back && rm -rf tmp/* && mv tmp_gitignore.back tmp/.gitignore
+cd ${MAGENTO_ROOT}/dev/tests/integration && mv tmp/.gitignore tmp_gitignore.back && rm -rf tmp/* && mv tmp_gitignore.back tmp/.gitignore
 #clear unit tests tmp
-cd ${magento_path}/dev/tests/unit && rm -rf tmp/*
+cd ${MAGENTO_ROOT}/dev/tests/unit && rm -rf tmp/*
 
 echo "Magento cache cleared."

install_environment.sh

@@ -4,22 +4,23 @@
 set -ex
 
 is_windows_host=$1
+guest_magento_dir=$2
 
 apt-get update
 
 # Determine external IP address
 set +x
-IP=`ifconfig eth1 | grep inet | awk '{print $2}' | sed 's/addr://'`
-echo "IP address is '${IP}'"
+ip=`ifconfig eth1 | grep inet | awk '{print $2}' | sed 's/addr://'`
+echo "IP address is '${ip}'"
 set -x
 
 # Determine hostname for Magento web-site
-HOST=`hostname -f`
-if [ -z ${HOST} ]; then
+host=`hostname -f`
+if [ -z ${host} ]; then
     # Use external IP address as hostname
     set +x
-    HOST=${IP}
-    echo "Use IP address '${HOST}' as hostname"
+    host=${ip}
+    echo "Use IP address '${host}' as hostname"
     set -x
 fi
 
@@ -28,12 +29,13 @@ apt-get install -y apache2
 a2enmod rewrite
 
 # Make suer Apache is run from 'vagrant' user to avoid permission issues
-sed -i 's/www-data/vagrant/g' /etc/apache2/envvars
+sed -i 's|www-data|vagrant|g' /etc/apache2/envvars
 
 # Enable Magento virtual host
 apache_config="/etc/apache2/sites-available/magento2.conf"
 cp /vagrant/magento2.vhost.conf  ${apache_config}
-sed -i "s/<host>/${HOST}/g" ${apache_config}
+sed -i "s|<host>|${host}|g" ${apache_config}
+sed -i "s|<guest_magento_dir>|${guest_magento_dir}|g" ${apache_config}
 a2ensite magento2.conf
 
 # Disable default virtual host
@@ -91,8 +93,8 @@ if [ -f ${composer_auth_json} ]; then
 fi
 
 # 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
+echo "export PATH=\$PATH:/vagrant/bin:${guest_magento_dir}/bin" >> /etc/profile
+echo "export MAGENTO_ROOT=${guest_magento_dir}" >> /etc/profile
 
 # Set permissions to allow Magento codebase upload by Vagrant provision script
 if [ ${is_windows_host} -eq 1 ]; then

install_magento.sh

@@ -6,32 +6,32 @@
 set -ex
 
 is_windows_host=$1
+guest_magento_dir=$2
 
 # Determine external IP address
 set +x
-IP=`ifconfig eth1 | grep inet | awk '{print $2}' | sed 's/addr://'`
-echo "IP address is '${IP}'"
+ip=`ifconfig eth1 | grep inet | awk '{print $2}' | sed 's/addr://'`
+echo "IP address is '${ip}'"
 set -x
 
 # Determine hostname for Magento web-site
-HOST=`hostname -f`
-if [ -z ${HOST} ]; then
+host=`hostname -f`
+if [ -z ${host} ]; then
     # Use external IP address as hostname
     set +x
-    HOST=${IP}
-    echo "Use IP address '${HOST}' as hostname"
+    host=${ip}
+    echo "Use IP address '${host}' as hostname"
     set -x
 fi
 
-magento_dir="/var/www/magento2ce"
-cd ${magento_dir}
+cd ${guest_magento_dir}
 
 # Clear cache
 magento_clear_cache
 
 # Remove configuration files
-rm -f "${magento_dir}/app/etc/config.php"
-rm -f "${magento_dir}/app/etc/env.php"
+rm -f "${guest_magento_dir}/app/etc/config.php"
+rm -f "${guest_magento_dir}/app/etc/env.php"
 
 # Create DB
 db_names=("magento" "magento_integration_tests")
@@ -40,15 +40,15 @@ for db_name in "${db_names[@]}"; do
 done
 
 # Install Magento application
-cd ${magento_dir}
+cd ${guest_magento_dir}
 
 admin_frontame="admin"
 install_cmd="./bin/magento setup:install \
     --db-host=localhost \
     --db-name=magento \
     --db-user=root \
     --backend-frontname=${admin_frontame} \
-    --base-url=http://${HOST}/ \
+    --base-url=http://${host}/ \
     --language=en_US \
     --timezone=America/Chicago \
     --currency=USD \
@@ -61,7 +61,7 @@ install_cmd="./bin/magento setup:install \
     --use-rewrites=1"
 
 # Configure Rabbit MQ
-if [ -f "${magento_dir}/app/code/Magento/Amqp/registration.php" ]; then
+if [ -f "${guest_magento_dir}/app/code/Magento/Amqp/registration.php" ]; then
     install_cmd="${install_cmd} \
     --amqp-host=localhost \
     --amqp-port=5672 \
@@ -73,19 +73,19 @@ chmod +x bin/magento
 php ${install_cmd}
 
 # Enable Magento cron jobs
-echo "* * * * * php ${magento_dir}/bin/magento cron:run &" | crontab -u vagrant -
+echo "* * * * * php ${guest_magento_dir}/bin/magento cron:run &" | crontab -u vagrant -
 
 if [ ${is_windows_host} -eq 1 ]; then
-    chown -R vagrant:vagrant ${magento_dir}
+    chown -R vagrant:vagrant ${guest_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}/
+Magento application was deployed to ${guest_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}'"
 
 if [ ${is_windows_host} -eq 1 ]; then
     echo "
@@ -94,5 +94,5 @@ if [ ${is_windows_host} -eq 1 ]; then
         (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-windows-hosts.md
-        to set up synchronization in PhpStorm (or using rsync) with ${magento_dir} directory"
+        to set up synchronization in PhpStorm (or using rsync) with ${guest_magento_dir} directory"
 fi

magento2.vhost.conf

@@ -1,7 +1,7 @@
 <VirtualHost *:80>
-    DocumentRoot "/var/www/magento2ce"
+    DocumentRoot <guest_magento_dir>
     ServerName magento2.vagrant
-    <Directory /var/www/magento2ce>
+    <Directory <guest_magento_dir>>
         Options Indexes FollowSymLinks
         AllowOverride All
         Require all granted