Merge pull request #2457 from tarlepp/feat-xdebug-configuration

Feat - Better Xdebug configuration

Author: tarlepp

doc/XDEBUG.md

@@ -15,7 +15,6 @@ have all basic configuration ready.
     * [PhpStorm basic configuration](#phpstorm-basic-configuration-table-of-contents)
     * [First connection](#first-connection-table-of-contents)
     * [Configuring debugging server](#configuring-debugging-server-table-of-contents)
-  * [Mac users](#mac-users-table-of-contents)
   * [Debug CLI commands](#debug-cli-commands-table-of-contents)
   * [Debug Postman requests](#debug-postman-requests-table-of-contents)
   * [External links / resources](#external-links--resources-table-of-contents)
@@ -27,9 +26,6 @@ These instructions relies heavily to screenshots, so you might need to use
 your own brains for some parts of these instructions - but I bet you can get
 this working in couple of minutes.
 
-Note that if you're using Mac, read [Mac users](#mac-users-table-of-contents)
-section first.
-
 ### PhpStorm basic configuration [ᐞ](#table-of-contents)
 
 1) Make sure that Xdebug port is `9003`
@@ -71,25 +67,6 @@ local paths. See the image below:
 
 ![Path mappings](images/xdebug_05.png)
 
-## Mac users [ᐞ](#table-of-contents)
-
-Mac users need to create a `docker-compose.override.yml` file with following
-content:
-
-```yaml
-version: '3'
-services:
-  php:
-    environment:
-      - DOCKER_WITH_MAC=1
-```
-
-And if you're reading this you might want to read [Speed problems with docker-compose?](SPEED_UP_DOCKER_COMPOSE.md)
-document, which will tell you how to speed your Mac environment quite lot.
-
-You just need to combine those both configurations to your local
-`docker-compose.override.yml` file
-
 ## Debug CLI commands [ᐞ](#table-of-contents)
 
 By default this application assumes that you're using `app.localhost` as your

docker-compose.yml

@@ -19,6 +19,8 @@ services:
             - /app/var/:uid=$HOST_UID,gid=$HOST_GID
         environment:
             PHP_IDE_CONFIG: "serverName=app.localhost"
+        extra_hosts:
+            - "host.docker.internal:host-gateway"
 
     nginx:
         container_name: symfony-backend-nginx

docker-entrypoint-dev.sh

@@ -4,12 +4,8 @@ set -e
 #
 # If we're starting web-server we need to do following:
 #   0) Basic linting of current JSON configuration file
-#   1) Determine docker container IP address, so that we can use it within
-#      XDebug configuration. Copy php.ini file to correct location and modify
-#      it to contain correct remote host value. With this we don't need to
-#      build container each time we want to change something in php.ini file.
-#      Also we want to export host IP so that we can use that within
-#      `check.php` to check that current environment is compatible with Symfony
+#   1) Copy updated php configuration file, with this we can change php
+#      configuration without rebuilding image
 #   2) Install all dependencies
 #   3) Generate JWT encryption keys
 #   4) Create database if it not exists yet
@@ -21,16 +17,7 @@ set -e
 make lint-configuration
 
 # Step 1
-if [[ -z "${DOCKER_WITH_MAC}" ]]; then
-    # Not Mac, so determine actual docker container IP address
-    HOST=$(/sbin/ip route|awk '/default/ { print $3 }')
-else
-    # Otherwise use special value, which works with Mac
-    HOST="docker.for.mac.localhost"
-fi
-
 cp /app/docker/php/php-dev.ini /usr/local/etc/php/php.ini
-sed -i "s/xdebug\.client_host \=.*/xdebug\.client_host\ = $HOST/g" /usr/local/etc/php/php.ini
 
 DOCKER_IP=$(/sbin/ip route|awk '/default/ { print $3 }')
 

docker/php/php-dev.ini

@@ -30,4 +30,4 @@ apc.serializer=igbinary
 ; Xdebug settings
 xdebug.mode = coverage,debug
 xdebug.start_with_request = yes
-xdebug.client_host = 127.0.0.1
+xdebug.client_host = host.docker.internal