Merge branch 'master' of https://github.com/ModestCoders/magento2-dockergento

Author: jalogut

README.md

@@ -10,25 +10,15 @@
 
 ## Motivation
 
-This project aims to offer a good performance solution for MAC users that want to use docker on development.
-This is a docker setup optimised for Magento2 on Mac. It has same performance as Linux or local setups.
+This project aims to offer a good performance solution for Mac users that want to use docker on development.
+This is a docker setup optimised for Magento 2 on Mac. It has same performance as Linux or local setups.
 
 ## Main Features
 
-### Overcome Docker for Mac performance issues on Magento 2
-
-* Use docker volumens for following directories:
-
-	* vendor
-	* generated
-	* var
-	* pub/static
-	* pub/media
-
-* Sincronise `vendor` and `generated` using a specific `sync` container. See [Sync vendor & generated section](#sync)
+### Overcome Docker for Mac performance issue
 
 <details>
-<summary>Docker for Mac performance issues</summary>
+<summary>Open to read issue explanation</summary>
 
 From docker for mac documentation: https://docs.docker.com/docker-for-mac/troubleshoot/#known-issues
 
@@ -45,13 +35,55 @@ As a work-around for this behavior, you can put vendor or third-party library di
 
 </details>
 
+**Solution:**
+
+* Use docker volumes for following directories:
+
+	* vendor
+	* generated
+	* var
+	* pub/static
+	* pub/media
+
+* Synchronise `vendor` and `generated` volumes using a specific `unison` container. 
+
+	<details>
+	<summary>How to sync volumes between host and container</summary>
+	
+	See [dockergento workflow](#workflow) for a better understanding about whole development process with dockergento.
+	
+	There are 2 options to sync the volumes `vendor` and `generated`
+
+	**Option 1: One time sync**
+
+	This option must be used most of the times. You should only need to sync `vendor` and `generated` from time to time for debugging purposes
+
+	```
+	docker-compose run --rm unison sync -path vendor -path generated
+	```
+
+	NOTE: For faster and more specific syncs, you can specify a subfolder like `sync -path vendor/<company_name>`.
+
+	**Option 2: Watch**
+
+	This option is only recommended if you are implementing code in a vendor module.
+
+	```
+	docker-compose run --rm unison watch -path vendor/<company_name>/<module_name>`
+	```	
+	
+	</details>
+	
+
 ## Preconditions
 
 1. Configure your docker `File Sharing` settings
 
 	![File Sharing Configuration](docs/img/file_sharing.png)
+	
+	NOTE: You do not need to have `Composer` installed. You only need to create a `.composer` folder in your computer, so it can be used by containers to cache composer dependecies instead of downloading them everytime.
 
-2. Optionally apply these performance tweaks
+2. Optionally you can also apply these performance tweaks
 
 	* [http://markshust.com/2018/01/30/performance-tuning-docker-mac](http://markshust.com/2018/01/30/performance-tuning-docker-mac)
 
@@ -60,10 +92,91 @@ As a work-around for this behavior, you can put vendor or third-party library di
 1. Copy this docker configuration repository in your project
 
 	```
+	cd <path_to_your_project>
 	curl -L https://api.github.com/repos/ModestCoders/magento2-dockergento/tarball | tar xz --strip=1
 	```
 
-2. Edit your magento paths or nginx configuration if needed
+2. Edit binded paths or nginx configuration if needed
+
+	<details>
+	<summary>More info about custom configurations</summary>
+	
+	**Binded Paths:**
+	
+	If you install magento code in a different folder than your project root, you might need to replace `<magento_dir>` on the following files: 
+	
+	* `docker-compose.yml`
+	
+	```
+	app-volumes:
+		build: ./config/docker/image/app-volumes
+		volumes: &appvolumes
+  			- .:/var/www/html:delegated
+  			- ~/.composer:/var/www/.composer:delegated
+  			- sockdata:/sock
+  			- app-vendor:/var/www/html/<magento_dir>/vendor
+  			- app-generated:/var/www/html/<magento_dir>/generated
+  			- app-var:/var/www/html/<magento_dir>/var
+  			- pub-static:/var/www/html/<magento_dir>/pub/static
+  			- pub-media:/var/www/html/<magento_dir>/pub/media
+  			- integration-test-sandbox:/var/www/html/<magento_dir>/dev/tests/integration/tmp
+
+	unison:
+		image: modestcoders/unison:2.51.2
+		volumes:
+  			- app-vendor:/var/www/html/<magento_dir>/vendor
+  			- app-generated:/var/www/html/<magento_dir>/generated
+  			- ./vendor:/sync/vendor
+  			- ./generated:/sync/generated
+		environment:
+  			- SYNC_SOURCE_BASE_PATH=/sync
+  			- SYNC_DESTINATION_BASE_PATH=/var/www/html/<magento_dir>
+  			- SYNC_MAX_INOTIFY_WATCHES=60000
+	```
+	
+	* `config/docker/image/app-volumes/Dockerfile`
+	
+	```
+	RUN mkdir -p /var/www/html/<magento_dir>/vendor \
+		/var/www/html/<magento_dir>/generated \
+		/var/www/html/<magento_dir>/var \
+		/var/www/html/<magento_dir>/pub/static \
+		/var/www/html/<magento_dir>/pub/media \
+		/var/www/html/<magento_dir>/dev/tests/integration/tmp \
+		&& chown -R 1000:1000 /var/www/html/<magento_dir>
+	```	
+	
+	* `config/docker/image/nginx/conf/default.conf`
+	
+	```
+	server {
+		# ...
+		set $MAGE_ROOT /var/www/html/<magento_dir>;
+		# ...
+	```
+	
+	**Nginx Multi-store:**
+	
+	If you have a multi-store magento, you need to add your website codes to the ngnix configuration as follows:  
+	
+	* `config/docker/image/nginx/conf/default.conf`
+	
+	```
+	# WEBSITES MAPPING
+	map $http_host $MAGE_RUN_CODE {
+
+		default    base;
+		## For multi-store configuration add here your domain-website codes
+		dominio-es.lo    es;
+		dominio-ch.lo    ch;
+		dominio-de.lo    de;
+	}
+	```
+	</details>
+
+3. (Recommended) Install [magento2-dockergento-console](https://github.com/ModestCoders/magento2-dockergento-console)
+
+	It is recommended to use this bash script tool for easier development workflow. See [dockergento workflow](#workflow) 
 
 ## Usage
 
@@ -82,63 +195,35 @@ sudo vim /etc/hosts
 // Add -> 127.0.0.1 <your-domain>
 ```
 
-### Execute Magento commands
-
-Magento commands must be executed inside the `php` container
-
-```
-docker-compose exec phpfpm bash
-```
-
-### <a name="sync"></a> Sync vendor and generated
-
-There are 2 options to sync the volumes `vendor` and `generated`
+### <a name="workflow"></a> Workflow
 
-#### Option 1: One time sync
-
-This option must be used most of the times. You should only need to sync `vendor` and `generated` from time to time for debugging purposes
-
-```
-docker-compose run --rm unison sync -path <path_to_sync>
-```
+See detailed documentation about development workflow with dockergento
 
-**NOTE:** `<path_to_sync>` should be `vendor` or `generated`. For faster and more specific syncs, you can include the subfolder path inside `vendor` like `sync -path vendor/<company_name>`.
+* `magento2-dockergento-console` > [Development Workflow](https://github.com/ModestCoders/magento2-dockergento-console/blob/master/docs/workflow.md)
 
-#### Option 2: Watch
+## Xdebug
 
-This option is only recommended if you are implementing code in a vendor module.
+* [PHPStorm + Xdebug Setup](docs/xdebug_phpstorm.md)
 
-```
-docker-compose run --rm unison watch -path <path_to_sync>
-```
+## Grumphp
 
-Example: `docker-compose run --rm unison watch -path vendor/<company_name>/<module_name>`
+* [Grumphp Setup](docs/grumphp_setup.md)
 
-### Frontend
+## Docker Images
 
-1. NPM config setup (Only first time)
+* [Docker Images List](docs/docker_images.md)
 
-	```
-	docker-compose run --rm node sh -c "cp -n package.json.sample package.json \
-        && cp -n Gruntfile.js.sample Gruntfile.js \
-        && npm install"
-	```
+## Troubleshooting
 
-2. Grunt watch
+### Named volumes suddenly binded to host
 
-	```
-	docker-compose run --rm node sh -c "grunt exec:<theme>"
-	docker-compose run --rm node sh -c "grunt watch"
-	```
+There is bug in docker that causes volumes to stop working and start behabing like a binded mount. If you notice a performance decrease, try the following:
 
-## Xdebug
+* `dockergento volumes-check`
 
-* [Xdebug enable/disable](docs/xdebug.md)
-* [PHPStorm + Xdebug Setup](docs/xdebug_phpstorm.md)
+In case of confirmation that volumes are broken, restart dockergento
 
-## Grumphp
-
-* [Grumphp Setup](docs/grumphp_setup.md)
+* `dockergento restart`
 
 ## ChangeLog
 
@@ -163,4 +248,4 @@ This project has been possible thanks to the following resources:
 [GNU General Public License, version 3 (GPLv3)](http://opensource.org/licenses/gpl-3.0)
 
 ## Copyright
-(c) ModestCoders
+(c) ModestCoders

config/docker/image/nginx/conf/default.conf

@@ -2,7 +2,7 @@
 map $http_host $MAGE_RUN_CODE {
 
     default    base;
-    ## For multi-store configuration add here your "domains <> website codes"
+    ## For multi-store configuration add here your domain-website codes
     # dominio-es.lo    es;
     # dominio-ch.lo    ch;
     # dominio-de.lo    de;

config/docker/image/phpfpm/Dockerfile

@@ -23,7 +23,7 @@ services:
       - phpfpm
 
   phpfpm:
-    build: ./config/docker/image/phpfpm
+    image: modestcoders/php:7.1-fpm
     volumes: *appvolumes
     environment:
       PHP_IDE_CONFIG: serverName=localhost
@@ -61,8 +61,6 @@ services:
   node:
     image: modestcoders/node-php:node8-php7.1
     volumes: *appvolumes
-    environment:
-      - NPM_CONFIG_PREFIX=/home/app/.npm-global # To avoid permission error on npm install. It tries to save it at /var/www (root is the owner)
     depends_on:
       - app-volumes
 

docker-compose.yml

@@ -0,0 +1,17 @@
+# Docker images
+
+## Ngnix
+
+* [markoshust/magento-nginx](https://hub.docker.com/r/markoshust/magento-nginx/)
+
+## PHP-FPM
+
+* [modestcoders/php](https://hub.docker.com/r/modestcoders/unison/)
+
+## UNISON
+
+* [modestcoders/unison](https://hub.docker.com/r/modestcoders/unison/)
+
+## NODE-PHP
+
+* [modestcoders/node-php](https://hub.docker.com/r/modestcoders/node-php/)