Merge pull request #4 from michaelperrin/feature/xdebug

Add Xdebug configuration

Author: michaelperrin

README.md

@@ -1,7 +1,36 @@
-Docker configuration to 
+Docker configuration to run a Symfony app.
 
 ## Run
 
     docker-compose up -d
 
 You can now visit http://localhost and see the default Symfony page.
+
+## Useful commands
+
+Symfony commands:
+
+    docker-compose exec php bin/console
+
+
+## Included stuff
+
+### Xdebug
+
+Making Xdebug working with Docker is quite tricky as there is currently a limitation to Docker for Mac
+that prevents a container to make a request to the the host, which is exactly what we would like to do with Xdebug.
+
+To make Xdebug debugging work, you will first need to run this command:
+
+    sudo ifconfig lo0 alias 10.200.10.1/24
+
+This IP address is configured in the environment variables of the PHP container (see `docker-compose.yml` file).
+
+No extra configuration is needed in your IDE (tested on Sublime Text, Visual Studio Code and Atom), apart the usual.
+
+Interesting resources:
+
+* https://docs.docker.com/docker-for-mac/networking/#/use-cases-and-workarounds
+* http://blog.arroyolabs.com/2016/10/docker-xdebug/
+* http://joenyland.me/blog/debug-a-php-app-in-a-docker-container-using-xdebug/
+

docker-compose.yml

@@ -4,8 +4,10 @@ services:
     build: ./docker/php/
     environment:
       TIMEZONE: Europe/Paris
+      XDEBUG_REMOTE_HOST: 10.200.10.1
     volumes:
       - ./docker/php/php.ini:/usr/local/etc/php/conf.d/php.ini:ro
+      - ./docker/php/xdebug.ini:/usr/local/etc/php/conf.d/xdebug.ini:ro
       - ./app:/var/www/app
     working_dir: /var/www/app
 

docker/php/Dockerfile

@@ -38,3 +38,7 @@ RUN mv composer.phar /usr/local/bin/composer
 RUN curl "https://phar.phpunit.de/phpunit.phar" -L -o "phpunit.phar"
 RUN chmod +x phpunit.phar
 RUN mv phpunit.phar /usr/local/bin/phpunit
+
+# Xdebug
+RUN pecl install xdebug \
+    && docker-php-ext-enable xdebug

docker/php/xdebug.ini

@@ -0,0 +1,5 @@
+xdebug.remote_enable = 1
+xdebug.remote_autostart = 1
+xdebug.remote_host = ${XDEBUG_REMOTE_HOST}
+xdebug.remote_port = 9000
+xdebug.remote_log=/var/log/xdebug/remote.log