Removed container names from docker-compose.yml file so native composer

project naming works.
Updated sync scripts to automatically fetch binaries.
Simplified Gulp discussion in README file.

Author: Alan Kent

README.md

@@ -89,11 +89,6 @@ GitHub repository to the project directory.
 Review the `docker-compose.yml` file in a text editor, making necessary
 adjustments as described by comments in the file. This includes:
 
-* You MUST ensure the container names are different per project to avoid
-  conflicts. For example, the default web service container name is
-  "proj1-m2web" and the default db service container name is "proj1-m2db".
-  Change all occurrences of "proj1" to your project name.
-
 * To enable volume mounting for the Magento source code (e.g. for Linux
   laptops), uncomment the volume mount line for `/var/www` in the provided
   `docker-compose.yml` file. For Unison (e.g. for Mac and Windows), ensure the
@@ -311,33 +306,25 @@ If you are using Unison for file syncing, you also need to start up a Unison
 process (and keep it running). It is generally recommended to start this up
 after you have installed Magento above.
 
-On Windows, get a compatible version of the Unison binaries for Windows
-from inside the container using the following (adjust "proj1-m2web" to match
-your web service container name from the `docker-compose.yml` file).
-
-    docker cp proj1-m2web:/windows/unison.exe .
-    docker cp proj1-m2web:/windows/unison-fsmonitor.exe .
-
-Then run the supplied BAT file to launch Unison in a separate window using the
-START command or by double clicking the BAT file via Windows explorer. Close
-the window to kill Unison.
+On Windows, run the supplied BAT file to launch Unison in a separate window
+using the START command or by double clicking the BAT file via Windows
+explorer. This will automatically retrieve a copy of the `unison.exe` binary
+from the web container. Close the window to kill Unison.
 
     START m2devbox-unison-sync.bat
 
-Each time you log in, make sure you restart this process, but be careful to not
-have multiple copies running in parallel. It is not recommended to do
-significant work on the project without Unison running to avoid merge conflicts
-(rare).
-
-Mac binaries and a shell script are also provided:
+Mac binaries and a shell script are also provided. It is recommended to run the
+sync shell script in a separate Terminal window so you can look at its output
+if you ever need to do troubleshooting.
 
-    docker cp proj1-m2web:/macos/unison .
-    docker cp proj1-m2web:/macos/unison-fsmonitor .
-    chmod +x unison unison-fsmonitor
+    ./m2devbox-unison-sync.sh
 
-It is recommended to run the sync shell script in a separat Terminal window.
+This shell script cannot be used on Linux, only Mac OSX. Use volume mounting on
+Linux (not Unison).
 
-    ./m2devbox-unison-sync.sh
+Each time you log in, make sure you restart Unison, but be careful to not have
+multiple copies running in parallel. It is not recommended to do significant
+work on the project without Unison running to avoid merge conflicts (rare).
 
 ### 9. Cron
 
@@ -391,7 +378,8 @@ TODO
 
 Grunt and Gulp are both frontend tool chains to speed up frontend development.
 They can both auto-recompile CSS files as soon as a file is written to disk.
-NodeJS is preinstalled in the web service container for use by Grunt and Gulp.
+NodeJS is preinstalled in the web service container for use by Grunt and Gulp,
+along with grunt-cli, gulp-cli, and browsersync.
 
 To enable Grunt support, run the following commands
 
@@ -400,27 +388,18 @@ To enable Grunt support, run the following commands
     cp package.json.sample package.json
     npm install
     grunt refresh --force
+    grunt watch
 
 For further details, please refer to the Grunt section in the "Frontend
 Developer Guide" on http://devdocs.magento/com.
 
-Magento does not ship with default Gulp support, but there is the excellent
-"frontools" community project based on Gulp. Frontools can be found at
-https://github.com/SnowdogApps/magento2-frontools. Version 0.11.4 was the last
-version with Less support (as supported by Magento). Frontools provides Sass
-replacements for the blank theme that they now support.
-
-If frontools is not suitable, there are numerous other articles on the web
-explaining how to set up Gulp support such as
-https://alankent.me/2016/01/27/gulp-et-al-in-magento-2/. Magento provides a
-`magento dev:source-theme:deploy` command that resolves all of the Magento file
-fallback rules, allowing Gulp or other similar pipelines to be run on the
-resultant directory tree.
-
-If you wish to run BrowserSync with Gulp (https://www.browsersync.io/), you
-will also need to edit the `docker-compose.yml` file to add the BrowserSync
-port number to the "ports" list to expose. For this to take effect, you must
-rebuild the container which will wipe all the files in the container.
+Magento does not ship with Gulp support, but there are numerous articles on the
+web explaining how to use Gulp with Magento 2, such as
+https://alankent.me/2016/01/27/gulp-et-al-in-magento-2/. 
+
+If you wish to run BrowserSync (https://www.browsersync.io/), with Gulp you
+need to ensure the BrowserSync ports (3000 and 3001) are left uncommented in
+the `docker-compose.yml` file.
 
 # Tips and Tricks
 

docker-compose.yml

@@ -6,7 +6,6 @@
 version: '2'
 services:
     web:
-        container_name: proj1-m2web
         restart: always
         image: alankent/magento2devbox-web:latest
         volumes:
@@ -72,7 +71,6 @@ services:
           - 3001
 
     db:
-        container_name: proj1-m2db
         restart: always
         image: mysql:5.6
 
@@ -92,3 +90,19 @@ services:
           # container. (Not recommended.)
           #- "./shared/db:/var/lib/mysql"
 
+    # Uncomment the following lines to enable Redis support.
+    # (Make sure the service name indentation remains exactly aligned with
+    # the previous service names)
+    #redis:
+    #    restart: always
+    #    image: redis:3.0.7
+
+    # Uncomment the following to enable ElasticSearch support.
+    # (Make sure the service name indentation remains exactly aligned with
+    # the previous service names)
+    #elasticsearch:
+    #    restart: always
+    #    image: elasticsearch:2
+    #    ports:
+    #      - 9200
+

m2devbox-unison-sync.bat

@@ -1,11 +1,15 @@
 REM @ECHO OFF
 
+@SET PROJ=%COMPOSE_PROJECT_NAME%
+@IF [%PROJ%] == [] (
+    REM Get current directory name.
+    FOR %%a IN (.) DO SET PROJ=%%~nxa
+)
+
 IF NOT EXIST unison.exe (
-    @ECHO The unison.exe binary could not be found. You can retrieve a
-    @ECHO compatible version from the DevBox web container using:
-    @ECHO docker cp proj1-m2web:/windows/unison.exe .
-    @ECHO docker cp proj1-m2web:/windows/unison-fsmonitor.exe .
-    GOTO exit
+    REM **** Getting unison.exe binary from web container.
+    docker cp %PROJ%_web_1:/windows/unison.exe .
+    docker cp %PROJ%_web_1:/windows/unison-fsmonitor.exe .
 )
 
 REM Add Windows\system32 to start of path to find the right "timeout" command

m2devbox-unison-sync.sh

@@ -1,14 +1,15 @@
 #!/bin/bash
 
+PROJ=$COMPOSE_PROJECT_NAME
+if [[ -n $PROJ ]]; then
+    PROJ=$(basename $PWD)
+fi
+
 if [[ ! -f unison ]]; then
-    echo "The unison binary could not be found. You can retrieve a"
-    echo "compatible version from the DevBox web container using:"
-    echo ""
-    echo "   docker cp proj1-m2web:/mac-osx/unison ."
-    echo "   docker cp proj1-m2web:/mac-osx/unison-fsmonitor ."
-    echo "   chmod +x unison unison-fsmonitor"
-    echo ""
-    exit 1
+    echo "Fetching unison executable from web container."
+    docker cp ${PROJ}_web_1:/mac-osx/unison .
+    docker cp ${PROJ}_web_1:/mac-osx/unison-fsmonitor .
+    chmod +x unison unison-fsmonitor
 fi
 
 # Fetch the external Docker Unison port number