Enable xDebug usage for Symfony commands and remove unnecessary extra symfony service - use php container for Composer/Symfony commands

Author: danabrey

.gitignore

@@ -1,2 +1,2 @@
 .env
-symfony/composer_cache/**
+composer_cache/**

README.md

@@ -14,17 +14,33 @@
 
 ### Running commands
 
-Symfony commands can be run using the symfony container, e.g.
+Symfony commands can be run from the **php** container, e.g.
 
-`docker-compose run symfony bin/console debug:router`
+```
+docker-compose run php bin/console app:my_command
+```
 
-It will save time if you set up an alias within your shell for `docker-compose run symfony bin/console`.
+It will save time if you set up an alias within your shell for `docker-compose run php bin/console`.
+
+To enable xDebug step-debugging within commands, you need to set the *xdebug.remote_host* PHP directive - on the command line like so:
+
+```
+docker-compose run php php -dxdebug.remote_host=192.168.1.2 bin/console app:my_command
+```
+
+Replace *192.168.1.2* with your **host** machine's local network IP. I have a bash alias set up for running commands that does this automatically:
+
+```
+alias dcrs="docker-compose run php php -dxdebug.remote_host=$(ip route get 192.168.1.1 | awk '{print $NF; exit}') bin/console"
+```
+
+Replace *192.168.1.1* with your local network's gateway, or *8.8.8.8*.
 
 ### Using Composer
 
-Composer commands can be run within the symfony container:
+Composer commands can be run within the **php** container:
 
-`docker-compose run symfony composer *command*`
+`docker-compose run php composer *command*`
 
 ### Using other services
 

docker-compose.yml

@@ -7,16 +7,13 @@ services:
     volumes:
       - ${APP_PATH}:/var/www/symfony
     working_dir: /var/www/symfony
-  php-fpm:
+  php:
     build: php-fpm
     volumes:
       - ${APP_PATH}:/var/www/symfony
-  symfony:
-    build: symfony
-    user: "1000"
-    volumes:
-      - ${APP_PATH}:/var/www/symfony
-      - ./symfony/composer_cache:/var/www/.composer/cache
+      - ./composer_cache:/var/www/.composer/cache
+    environment:
+      - PHP_IDE_CONFIG=serverName=symfony.dev # Replace symfony.dev with the server name you've created in your IDE
   mariadb:
     image: mariadb:10.3
     environment:

nginx/Dockerfile

@@ -11,7 +11,7 @@ ADD symfony.conf /etc/nginx/sites-available/
 RUN ln -s /etc/nginx/sites-available/symfony.conf /etc/nginx/sites-enabled/symfony
 RUN rm /etc/nginx/sites-enabled/default
 
-RUN echo "upstream php-upstream { server php-fpm:9000; }" > /etc/nginx/conf.d/upstream.conf
+RUN echo "upstream php-upstream { server php:9000; }" > /etc/nginx/conf.d/upstream.conf
 
 RUN usermod -u 1000 www-data
 

php-fpm/Dockerfile

@@ -18,6 +18,10 @@ RUN echo "display_errors = On" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebu
 RUN echo "xdebug.remote_enable=1" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini
 RUN echo "xdebug.remote_connect_back=1" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini
 RUN echo "xdebug.remote_autostart=1" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini
-RUN echo "xdebug.remote_log='/var/log/xdebug_remote.log'" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini
+
+# install composer
+RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
 
 RUN usermod -u 1000 www-data
+USER 1000
+WORKDIR /var/www/symfony