Allow new project to be created by one command, add Xdebug switcher, fix some permission issues

Author: ironex

.gitignore

@@ -1,4 +1,4 @@
 magento
-auth.json
+docker/php-fpm/auth.json
 .idea
 .DS_Store

README.md

@@ -1,8 +1,8 @@
-# Docker Magento 
+# Docker Magento 2
 
 ```Rootless containers```,
 ```Docker```,
-```Magento```,
+```Magento 2```,
 ```Nginx```,
 ```MySQL```,
 ```PHP-FPM```,
@@ -13,36 +13,68 @@
 ```Elastic Search```,
 ```Kibana```
 
+## Currently supported versions of Magento
+
+- 2.4.x
+
 ## Setup
 
-__1) Add following to etc/hosts__
+__Add following to etc/hosts__
 - 127.0.0.1	magento.local
 - 127.0.0.1	kibana.magento.local
 - 127.0.0.1	redis.magento.local
 - 127.0.0.1	rabbitmq.magento.local
 - 127.0.0.1	adminer.magento.local
 
-__2) Start Docker__
-
-- ```sh bin/start.sh```
-	- Accepts additional arguments (--build <container>)
-
-__3) Create new or add existing Magento project__
-
-- Create new project
-	- ```sh bin/new-project.sh```
-		- Keys can be found in https://marketplace.magento.com/customer/accessKeys/
-
-- Add existing project
+__A) Create brand new Magento project__
+
+1) Run ```sh bin/new-project.sh <version>```
+	- Requires Magento version as an argument
+	- Make sure "magento" folder exists and is owned by current user before you bind it to the container by running the script above, otherwise it will be created by Docker and owned by root.
+	- Keys can be found in https://marketplace.magento.com/customer/accessKeys/ and you can opt-in to store your keys (login and password) to /home/docker/.composer/auth.json, which is bind mounted to docker/php-fpm/auth.json
+	- Magento default settings - these can be edited in bin/new-project.sh
+		- base-url=http://magento.local
+		- db-host=mysql
+		- db-name=magento
+		- db-user=magento
+		- db-password=magento
+		- admin-firstname=admin
+		- admin-lastname=admin
+		- [email protected]
+		- admin-user=admin
+		- admin-password=admin123
+		- language=en_US
+		- currency=USD
+		- timezone=America/Chicago
+		- use-rewrites=1
+		- elasticsearch-host=elasticsearch
+		- session-save=redis
+		- session-save-redis-host=redis
+		- session-save-redis-db=0 --session-save-redis-password=""
+		- cache-backend=redis
+		- cache-backend-redis-server=redis
+		- cache-backend-redis-db=1
+		- page-cache=redis
+		- page-cache-redis-server=redis
+		- page-cache-redis-db=2
+		- amqp-host="rabbitmq"
+		- amqp-port="5672"
+		- amqp-user="guest"
+		- amqp-password="guest"
+		- amqp-virtualhost="/"
+
+__B) Run already existing Magento project__
+
+1) Run ```sh bin/start.sh```
+
+2) Add existing project
 	- Paste your existing Magento project to magento folder  
 
-__4) Install Magento__
-
-- ```sh bin/install.sh```
-
-__5) Setup Xdebug in IDE__
+__Setup Xdebug in IDE__
 
-- PhpStorm should offer you automatic setup after you add breakpoint and make http request (open magento.local in a browser) and correct settings should be similar to this:
+1) Run ```sh bin/xdebug.sh debug```
+	- You can turn off Xdebug by running ```sh bin/xdebug.sh off``` and turn it on again with ```sh bin/xdebug.sh debug```, you can also use this command to set all other Xdebug modes (https://xdebug.org/docs/all_settings#mode)  
+2) PhpStorm should offer you automatic setup after you add breakpoint and make http request (open magento.local in a browser) and correct settings should be similar to this:
 
 Preferences - PHP - Debug
 

auth.json

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+export USER_ID=$(id -u)
+export GROUP_ID=$(id -u)
+
+# Build images
+docker-compose build $@

bin/build.sh

@@ -1,15 +1,10 @@
 #!/bin/sh
 
-docker-compose down
+export USER_ID=$(id -u)
+export GROUP_ID=$(id -u)
 
-docker container rm $(docker container ls -aq)
+# Stop running containers, remove images and volumes
+sh bin/stop.sh -v --rmi all
 
-docker image rm $(docker image ls -aq) --force
-
-echo "###### docker container ls -a"
-
-docker container ls -a
-
-echo "###### docker image ls"
-
-docker image ls
+# Remove stopped containers
+docker-compose rm

bin/cleanup.sh

@@ -3,4 +3,5 @@
 export USER_ID=$(id -u)
 export GROUP_ID=$(id -u)
 
-docker-compose run --rm --workdir /magento php-fpm composer $@
+# Run Composer command
+docker-compose run --rm --workdir /home/dockeruser/magento php-fpm composer $@

bin/composer.sh

@@ -1,5 +1,67 @@
 #!/bin/sh
 
+export USER_ID=$(id -u)
+export GROUP_ID=$(id -u)
+
+if [ -z $1 ]
+  then echo "Please select Magento 2 version. Currently supported versions: 2.4.x";
+  exit;
+fi
+
+# Ask user before removing magento folder and then re-creating it
+while true; do
+    read -p "Running this command will remove magento folder including its contents and then re-create it. Do you wish to proceed Y/n?" yn
+    case $yn in
+        [Yy]* ) rm -rf magento; mkdir magento; break;;
+        [Nn]* ) exit;;
+        * ) echo "Please answer Y/n.";;
+    esac
+done
+
+# Create magento folder if it does not exist
+magento="magento"
+
+if [ ! -d $magento ]
+then
+    mkidr $magento
+fi
+
+# Build images and create and start containers
+sh bin/build.sh --no-cache
+sh bin/start.sh
+
+# Create new project
 rm magento/.placeholder
+sh bin/composer.sh create-project --ignore-platform-reqs --repository-url=https://repo.magento.com/ magento/project-community-edition=$1 .
 
-sh bin/composer.sh create-project --ignore-platform-reqs --repository-url=https://repo.magento.com/ magento/project-community-edition=2.4.2-p1 .
+# Install Magento
+docker-compose exec -T php-fpm /home/dockeruser/magento/bin/magento setup:install \
+--base-url=http://magento.local \
+--db-host=mysql \
+--db-name=magento \
+--db-user=magento \
+--db-password=magento \
+--admin-firstname=admin \
+--admin-lastname=admin \
+[email protected] \
+--admin-user=admin \
+--admin-password=admin123 \
+--language=en_US \
+--currency=USD \
+--timezone=America/Chicago \
+--use-rewrites=1 \
+--elasticsearch-host=elasticsearch \
+--session-save=redis \
+--session-save-redis-host=redis \
+--session-save-redis-db=0 --session-save-redis-password="" \
+--cache-backend=redis \
+--cache-backend-redis-server=redis \
+--cache-backend-redis-db=1 \
+--page-cache=redis \
+--page-cache-redis-server=redis \
+--page-cache-redis-db=2 \
+--amqp-host="rabbitmq" \
+--amqp-port="5672" \
+--amqp-user="guest" \
+--amqp-password="guest" \
+--amqp-virtualhost="/"

bin/install.sh

@@ -3,4 +3,5 @@
 export USER_ID=$(id -u)
 export GROUP_ID=$(id -u)
 
+# Build images if needed and create and start containers
 docker-compose up -d $@

bin/new-project.sh

@@ -1,3 +1,7 @@
 #!/bin/sh
 
-docker-compose down
+export USER_ID=$(id -u)
+export GROUP_ID=$(id -u)
+
+# Stop running containers
+docker-compose down $@