Add Xdebug support to php-fpm service.

Author: jpcaparas

.env.example

@@ -0,0 +1,5 @@
+### This root .env file is intended to be by both your PHP application and Docker Compose
+### This consolidates all application environment variables into an easy-to-find .env file
+
+XDEBUG_ON=false
+XDEBUG_REMOTE_HOST=127.0.0.1

README.md

@@ -76,6 +76,15 @@ To install npm packages, run:
 
 # How-to (advanced)
 
+To enable the Xdebug module:
+
+1. Copy the `.env.example` to an `.env` file and:
+    1. Change the value of `XDEBUG_ON` to `true`
+    1. Change the value of `XDEBUG_REMOTE_HOST` to your host machine's IP address.
+1.  Run `docker-compose up -d --build --remove-orphans` to re-build the service.
+
+---
+
 If you want to extend the functionality of a service (e.g. php-fpm), you have to re-build it.
 
 To accomplish this, modify the Dockerfile, then run:
@@ -90,7 +99,7 @@ If you want to use a different web server port (e.g. 80), modify the port on the
 and start the stack again.
 
 
-## Gotchas
+# Gotchas
 
 Ensure that the host machine ports `8080` (web server) and `3306` (database) are open on your host machine.
 

docker-compose.yml

@@ -11,6 +11,9 @@ services:
   php-fpm:
     build:
       context: ./services/php
+      args:
+        - "XDEBUG_ON=${XDEBUG_ON}"
+        - "XDEBUG_REMOTE_HOST=${XDEBUG_REMOTE_HOST}"
     ports:
       - 9000
     volumes_from:

services/php/Dockerfile

@@ -22,6 +22,21 @@ RUN docker-php-ext-install opcache && \
     docker-php-ext-install mysqli && \
     docker-php-ext-install pdo pdo_mysql
 
+# xdebug
+ARG XDEBUG_ON=false
+ARG XDEBUG_REMOTE_HOST=127.0.0.1
+RUN if [ ${XDEBUG_ON} = true ]; then \
+    pecl install xdebug && \
+    docker-php-ext-enable xdebug && \
+    echo "xdebug.default_enable = 0" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini && \
+    echo "xdebug.remote_enable = 1" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini && \
+    echo "xdebug.remote_autostart = 0" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini && \
+    echo "xdebug.remote_connect_back = 0" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini && \
+    echo "xdebug.profiler_enable = 0" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini && \
+    echo "xdebug.remote_host = ${XDEBUG_REMOTE_HOST}" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini && \
+    echo "xdebug.remote_port = 9000" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini \
+;fi
+
 # mark volume/s as externally mounted
 VOLUME ["/var/www"]