Merge pull request #53 from leojonathanoh/docs/readme-update-faq-abou…

…t-disabling-xdebug-in-development

Docs (readme): Update FAQ about disabling `xdebug` in development

README.md

@@ -163,6 +163,6 @@ git commit -m "Chore: Release 1.2.3"
 
 ## FAQ
 
-### Q: `Xdebug: [Step Debug] Could not connect to debugging client. Tried: host.docker.internal:9000 (through xdebug.client_host/xdebug.client_port)` appears in the php logs
+### Q: `Xdebug: [Step Debug] Could not connect to debugging client. Tried: host.docker.internal:9000 (through xdebug.client_host/xdebug.client_port)` appears in PHP logs on `docker-compose up`
 
-A: The debugger is not running. Press `F5` in `vscode` to start the `php` `xdebug` debugger. If you stopped the debugger, it is safe to ignore this message.
+A: If you are seeing this in development, the PHP debugger is not running. Press `F5` in `vscode` to start the PHP debugger. If you don't need debugging, set `XDEBUG_MODE=off` in `docker-compose.yml` to disable XDebug.

docker-compose.yml

@@ -151,6 +151,7 @@ services:
       # - ./config/web/usr/local/etc/php/conf.d/php.ini:/usr/local/etc/php/conf.d/php.ini:ro
       # - ./config/web/usr/local/etc/php-fpm.d/php-fpm.conf:/usr/local/etc/php-fpm.d/php-fpm.conf:ro
     environment:
+      # - XDEBUG_MODE=off   # Uncomment to disable xdebug
       - DB_ADDR=db
       - DB_NAME=hlstatsxce
       - DB_USER=hlstatsxce
@@ -178,6 +179,7 @@ services:
       - ./src/heatmaps:/heatmaps
       - ./src/web:/web
     environment:
+      # - XDEBUG_MODE=off   # Uncomment to disable xdebug
       - DB_HOST=db
       - DB_NAME=hlstatsxce
       - DB_USER=hlstatsxce