making xdebug easier to configure

Author: zaherg

.env.example

@@ -0,0 +1,9 @@
+PHP_XDEBUG_DEFAULT_ENABLE=0
+PHP_XDEBUG_REMOTE_ENABLE=0
+PHP_XDEBUG_REMOTE_HOST=127.0.0.1
+PHP_XDEBUG_REMOTE_PORT=9001
+PHP_XDEBUG_REMOTE_AUTO_START=0
+PHP_XDEBUG_REMOTE_CONNECT_BACK=0
+PHP_XDEBUG_IDEKEY=docker
+PHP_XDEBUG_PROFILER_ENABLE=0
+PHP_XDEBUG_PROFILER_OUTPUT_DIR=/tmp

Dockerfile

@@ -2,7 +2,17 @@ FROM php:7.1-fpm-alpine
 
 ARG BUILD_DATE
 ARG VCS_REF
+
 ENV COMPOSER_ALLOW_SUPERUSER 1
+ENV PHP_XDEBUG_DEFAULT_ENABLE ${PHP_XDEBUG_DEFAULT_ENABLE:-1}
+ENV PHP_XDEBUG_REMOTE_ENABLE ${PHP_XDEBUG_REMOTE_ENABLE:-1}
+ENV PHP_XDEBUG_REMOTE_HOST ${PHP_XDEBUG_REMOTE_HOST:-"127.0.0.1"}
+ENV PHP_XDEBUG_REMOTE_PORT ${PHP_XDEBUG_REMOTE_PORT:-9000}
+ENV PHP_XDEBUG_REMOTE_AUTO_START ${PHP_XDEBUG_REMOTE_AUTO_START:-1}
+ENV PHP_XDEBUG_REMOTE_CONNECT_BACK ${PHP_XDEBUG_REMOTE_CONNECT_BACK:-1}
+ENV PHP_XDEBUG_IDEKEY ${PHP_XDEBUG_IDEKEY:-docker}
+ENV PHP_XDEBUG_PROFILER_ENABLE ${PHP_XDEBUG_PROFILER_ENABLE:-0}
+ENV PHP_XDEBUG_PROFILER_OUTPUT_DIR ${PHP_XDEBUG_PROFILER_OUTPUT_DIR:-"/tmp"}
 
 LABEL Maintainer="Zaher Ghaibeh <z@zah.me>" \
  Description="Lightweight php 7.1 container based on alpine with xDebug enabled, SOPAP extensions enabled & composer installed." \
@@ -22,17 +32,12 @@ RUN apk update \
  && docker-php-ext-enable xdebug redis \
  && docker-php-source delete \
  && docker-php-ext-install mcrypt pdo_mysql soap intl zip \
- && echo "xdebug.remote_enable=on" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini \
- && echo "xdebug.remote_autostart=off" >> /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 \
- && echo "xdebug.remote_handler=dbgp" >> /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 \
  && curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer \
  && apk del build-dependencies \
  && apk del libmcrypt-dev \
  && rm -rf /tmp/*
 
-# COPY php.ini /usr/local/etc/php/
+COPY xdebug.ini /usr/local/etc/php/conf.d/xdebug-dev.ini
 
 USER www-data
 

README.md

@@ -4,6 +4,28 @@
 
 This image contain php-7.1 based on alpine with xDebug enabled and Composer installed
 
+## Run the image:
+
+By default xdebug is enabled, to disable it you need to create a `.env` file which should contain the following variables, but remember to change the value based one what you want to achieve:
+
+```
+PHP_XDEBUG_DEFAULT_ENABLE=0
+PHP_XDEBUG_REMOTE_ENABLE=0
+PHP_XDEBUG_REMOTE_HOST=127.0.0.1
+PHP_XDEBUG_REMOTE_PORT=9001
+PHP_XDEBUG_REMOTE_AUTO_START=0
+PHP_XDEBUG_REMOTE_CONNECT_BACK=0
+PHP_XDEBUG_IDEKEY=docker
+PHP_XDEBUG_PROFILER_ENABLE=0
+PHP_XDEBUG_PROFILER_OUTPUT_DIR=/tmp
+```
+
+Then run the docker and specify the env file that you have created like this
+
+```
+docker run --env-file .env -p 80:80 zaherg/php-7.1-xdebug-alpine
+```
+
 ## Installed modules information
 
 It has the following modules:

xdebug.ini

@@ -0,0 +1,13 @@
+[xdebug]
+xdebug.default_enable=${PHP_XDEBUG_DEFAULT_ENABLE}
+xdebug.remote_enable=${PHP_XDEBUG_REMOTE_ENABLE}
+xdebug.remote_handler=dbgp
+xdebug.remote_port=${PHP_XDEBUG_REMOTE_PORT}
+xdebug.remote_host=${PHP_XDEBUG_REMOTE_HOST}
+xdebug.remote_autostart=${PHP_XDEBUG_REMOTE_AUTO_START}
+xdebug.remote_connect_back=${PHP_XDEBUG_REMOTE_CONNECT_BACK}
+xdebug.idekey=${PHP_XDEBUG_IDEKEY}
+
+; profiler
+xdebug.profiler_enable = ${PHP_XDEBUG_PROFILER_ENABLE}
+xdebug.profiler_output_dir = ${PHP_XDEBUG_PROFILER_OUTPUT_DIR}