better Xdebug support + services versions update (#46)

Author: Julien Neuhart

README.md

@@ -4,7 +4,7 @@
 <h3 align="center">kickoff-docker-php</h3>
 <p align="center">A complete stack for your PHP project powered by Docker</p>
 <p align="center">
-    <a href="https://github.com/thecodingmachine/kickoff-docker-php/tree/v2.1.1"><img src="https://img.shields.io/badge/stable-v2.1.1-green.svg" alt="Stable release: v2.1.1"></a>
+    <a href="https://github.com/thecodingmachine/kickoff-docker-php/tree/v2.2.0"><img src="https://img.shields.io/badge/stable-v2.2.0-green.svg" alt="Stable release: v2.2.0"></a>
     <a href="https://github.com/thecodingmachine/kickoff-docker-php/tree/master"><img src="https://img.shields.io/badge/unstable-master-orange.svg" alt="Unstable release: master"></a>
     <a href="https://travis-ci.org/thecodingmachine/kickoff-docker-php"><img src="https://img.shields.io/travis/thecodingmachine/kickoff-docker-php.svg?label=Travis+CI" alt="Travis CI"></a>
 </p>
@@ -36,7 +36,7 @@ following goals in mind:
 ## Features
 
 * **Cross-platform:** Windows, Mac, Linux
-* **A complete stack:** NGINX, PHP-FPM 7.1, MySQL 5.7, phpMyAdmin, Redis, RabbitMQ and more to come!
+* **A complete stack:** NGINX, PHP-FPM 7.1, MySQL 5.7, phpMyAdmin, Redis, RabbitMQ
 * **Centralized logging** with Graylog
 * Automatic **HTTPS** on your local environment
 * A powerful **reverse-proxy** ([Traefik](https://traefik.io/)) which can handle automatic HTTPS (via [Let's Encrypt](https://letsencrypt.org/))
@@ -244,6 +244,8 @@ NGINX is the web server of your PHP application.
 The NGINX configuration located at `modules/nginx/conf.d/php-fpm.conf` provides good security defaults. Still, you might 
 have to update it according to the PHP framework you wish to use.
 
+Example for a Symfony application: https://gist.github.com/gulien/64d8c94c5d0e294ac121ea810794757e.
+
 ### PHP-FPM
 
 The PHP-FPM container has many roles. First, it handles requests from the NGINX container to execute your PHP files.
@@ -259,6 +261,12 @@ zip and more!
 
 You are able to find all installed PHP extensions by running `php -m` inside your workspace.
 
+#### Xdebug
+
+Xdebug is a tool for easily debugging your PHP code. We provided simple variables in your `.env` file as described below.
+
+Example with PhpStorm: https://gist.github.com/gulien/d0933d8f90587a95cec5fd750da41b87.
+
 #### Available tools
 
 *Composer* - https://getcomposer.org/
@@ -284,10 +292,12 @@ as defined in the PSR-1 and PSR-2 documents and many more.
 
 #### Configuration
 
-| Variable             | Location      | Description                                                |
-|----------------------|---------------|------------------------------------------------------------|
-| PHP_MEMORY_LIMIT     | `config/.env` | Defines the PHP memory limit of the PHP-FPM container.     |
-| PHP_FPM_MEMORY_LIMIT | `config/.env` | Defines the PHP-FPM memory limit of the PHP-FPM container. |
+| Variable             | Location      | Description                                                         |
+|----------------------|---------------|---------------------------------------------------------------------|
+| PHP_MEMORY_LIMIT     | `config/.env` | Defines the PHP memory limit of the PHP-FPM container.              |
+| PHP_FPM_MEMORY_LIMIT | `config/.env` | Defines the PHP-FPM memory limit of the PHP-FPM container.          |
+| XDEBUG_ENABLED       | `config/.env` | If true, enables Xdebug.                                            |
+| XDEBUG_REMOTE_HOST   | `config/.env` | If Xdebug is enabled, set this variable with your local IP address. |
 
 ### MySQL
 
@@ -323,7 +333,7 @@ This should be used only in others environments.
 
 ### Redis
 
-Redis is the database cache of this stack and it has been configured as the default session handler for PHP.
+Redis is the cache store of this stack.
 
 The hostname of Redis in your PHP-FPM container is `redis`. To configure Redis to be the cache handler of 
 your PHP application, you should refer to the documentation provided by your PHP framework.

config/.app.env.blueprint

@@ -5,4 +5,7 @@
 # | You can add here variables which are useful to configure your PHP
 # | application. For example: credentials to access to a remote
 # | API.
+# |
+# | Of course, you should update the Orbit file located at
+# | 'config/orbit/orbit-build.yml' to add a command which uses those values.
 # |

config/.env.blueprint

@@ -117,6 +117,29 @@ PHP_MEMORY_LIMIT=-1
 
 PHP_FPM_MEMORY_LIMIT=128m
 
+# |--------------------------------------------------------------------------
+# | Xdebug enabled
+# |--------------------------------------------------------------------------
+# |
+# | If true, enables Xdebug.
+# |
+
+XDEBUG_ENABLED=false
+
+# |--------------------------------------------------------------------------
+# | Xdebug remote host
+# |--------------------------------------------------------------------------
+# |
+# | If Xdebug is enabled, set this variable with your local IP address.
+# |
+# | On MacOS, you should set it with "docker.for.mac.localhost".
+# | On Windows, run "ipconfig" and look for the IP4 address in "DockerNAT"
+# | entry.
+# |
+# |
+
+XDEBUG_REMOTE_HOST=172.18.0.1
+
 # |--------------------------------------------------------------------------
 # | MySQL password
 # |--------------------------------------------------------------------------

config/app.yml

@@ -4,4 +4,7 @@
 # |
 # | You can add here variables which are useful to configure your PHP
 # | application.
+# |
+# | Of course, you should update the Orbit file located at
+# | 'config/orbit/orbit-build.yml' to add a command which uses those values.
 # |

config/orbit/orbit-build.yml

@@ -86,7 +86,6 @@ commands:
       - orbit generate -t modules/php-fpm/conf.d/memory-limit.blueprint.ini -o modules/php-fpm/conf.d/memory-limit.ini -e Config,config/.env {{ if debug }}-d{{ end }}
       - orbit generate -t modules/php-fpm/php-fpm.d/memory-limit.blueprint.conf -o modules/php-fpm/php-fpm.d/memory-limit.conf -e Config,config/.env {{ if debug }}-d{{ end }}
       - orbit generate -t modules/php-fpm/php-fpm.d/security.blueprint.conf -o modules/php-fpm/php-fpm.d/security.conf -e Config,config/.env {{ if debug }}-d{{ end }}
-      - orbit generate -t modules/php-fpm/Dockerfile.blueprint -o modules/php-fpm/Dockerfile -v Modules,config/modules.yml -e Config,config/.env {{ if debug }}-d{{ end }}
       - docker-compose -p {{ .EnvFiles.Config.ENV }}{{ .Values.Project.name }} -f modules/php-fpm/docker-compose.yml build
 
   # |--------------------------------------------------------------------------

modules/graylog/docker-compose.blueprint.yml

@@ -33,7 +33,7 @@ services:
 
 
   graylog-server:
-    image: graylog2/server:2.3.1-1
+    image: graylog2/server:2.3.2-2
     container_name: {{ .EnvFiles.Config.ENV }}-{{ .Values.Project.name }}-graylog
     restart: "no"
     networks:

modules/mysql/docker-compose.blueprint.yml

@@ -6,7 +6,7 @@ services:
 
 
   mysql:
-    image: mysql:5.7
+    image: mysql:5.7.20
     container_name: {{ .EnvFiles.Config.ENV }}-{{ .Values.Project.name }}-mysql
     restart: {{ if and (ne "local" .EnvFiles.Config.ENV) (eq false .Values.Modules.graylog.enable) }}unless-stopped{{ else }}"no"{{ end }}
     networks:
@@ -36,7 +36,7 @@ services:
     {{ end }}
   {{ if eq "local" .EnvFiles.Config.ENV }}
   phpmyadmin:
-    image: phpmyadmin/phpmyadmin:4.7
+    image: phpmyadmin/phpmyadmin:4.7.4-1
     container_name: {{ .EnvFiles.Config.ENV }}-{{ .Values.Project.name }}-phpmyadmin
     restart: "no"
     networks:

modules/nginx/Dockerfile

@@ -1,4 +1,4 @@
-FROM nginx:1.12-alpine
+FROM nginx:1.12.1-alpine
 
 # |--------------------------------------------------------------------------
 # | Permissions issues workaround

modules/php-fpm/Dockerfile.blueprint

@@ -5,14 +5,18 @@ services:
 
 
   php-fpm:
-    build: .
+    image: gulnap/kickoff-docker-php-images:php-fpm-7.1.10-v2.2.0
     container_name: {{ .EnvFiles.Config.ENV }}-{{ .Values.Project.name }}-php-fpm
     restart: {{ if and (ne "local" .EnvFiles.Config.ENV) (eq false .Values.Modules.graylog.enable) }}unless-stopped{{ else }}"no"{{ end }}
     entrypoint: /usr/local/bin/docker-entrypoint.sh
     networks:
       - backend
     environment:
       - UID={{ if ne "windows" os }}${UID}{{ else }}82{{ end }}
+      - XDEBUG_ENABLED={{ .EnvFiles.Config.XDEBUG_ENABLED }}
+      {{- if eq "true" .EnvFiles.Config.XDEBUG_ENABLED }}
+      - XDEBUG_REMOTE_HOST={{ .EnvFiles.Config.XDEBUG_REMOTE_HOST }}
+      {{- end }}
     labels:
       - traefik.enable=false
     volumes: