Skip to content

Commit

Permalink
Docs (readme): Update FAQ about disabling xdebug in development
Browse files Browse the repository at this point in the history
  • Loading branch information
leojonathanoh committed Feb 2, 2024
1 parent bbe1f35 commit 9059c96
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 2 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 9059c96

Please sign in to comment.