2020-10-16 13:08:20 +02:00
# Installing Xdebug
The default Docker stack is shipped without a Xdebug stage.
It's easy though to add [Xdebug ](https://xdebug.org/ ) to your project, for development purposes such as debugging tests or API requests remotely.
## Add a Debug Stage to the Dockerfile
To avoid deploying Symfony Docker to production with an active Xdebug extension,
it's recommended to add a custom stage to the end of the `Dockerfile` .
```Dockerfile
# Dockerfile
FROM symfony_php as symfony_php_debug
2021-05-07 10:44:45 +02:00
ARG XDEBUG_VERSION=3.0.4
2020-10-16 13:08:20 +02:00
RUN set -eux; \
apk add --no-cache --virtual .build-deps $PHPIZE_DEPS; \
pecl install xdebug-$XDEBUG_VERSION; \
docker-php-ext-enable xdebug; \
apk del .build-deps
```
## Configure Xdebug with Docker Compose Override
2021-06-18 18:47:07 +02:00
Using an [override ](https://docs.docker.com/compose/reference/overview/#specifying-multiple-compose-files ) file named `docker-compose.debug.yml` ensures that the production
2020-10-16 13:08:20 +02:00
configuration remains untouched.
As example, an override could look like this:
```yaml
2021-06-18 18:47:07 +02:00
# docker-compose.debug.yml
2020-10-16 13:08:20 +02:00
version: "3.4"
services:
php:
build:
context: .
target: symfony_php_debug
environment:
# See https://docs.docker.com/docker-for-mac/networking/#i -want-to-connect-from-a-container-to-a-service-on-the-host
# See https://github.com/docker/for-linux/issues/264
2020-12-18 11:16:37 +00:00
# The `client_host` below may optionally be replaced with `discover_client_host=yes`
2020-12-21 17:42:57 +00:00
# Add `start_with_request=yes` to start debug session on each request
2020-10-16 13:08:20 +02:00
XDEBUG_CONFIG: >-
2020-12-18 11:16:37 +00:00
client_host=host.docker.internal
XDEBUG_MODE: debug
2020-10-16 13:08:20 +02:00
# This should correspond to the server declared in PHPStorm `Preferences | Languages & Frameworks | PHP | Servers`
# Then PHPStorm will use the corresponding path mappings
PHP_IDE_CONFIG: serverName=symfony
```
2021-06-18 18:47:46 +02:00
Build your image with your fresh new xdebug configuration:
```console
docker-compose -f docker-compose.yml -f docker-compose.debug.yml build
```
2020-10-16 13:08:20 +02:00
Then run:
2021-06-14 15:12:18 +02:00
```console
docker-compose -f docker-compose.yml -f docker-compose.debug.yml up -d
```
2020-10-16 13:08:20 +02:00
2021-06-18 18:47:46 +02:00
## Debug with Xdebug with PHPStorm
You can use the [xdebug extension ](https://chrome.google.com/webstore/detail/xdebug-helper/eadndfjplgieldjbigjakmdgkmoaaaoc ) if you want to debug on the browser (don't forget to configure it).
If you don't want to use it, just add on your request this query param: `XDEBUG_SESSION=PHPSTORM` .
On PHPStorm, you just have to click on the button `Start Listening for PHP Debug Connections` on the `Run` menu.
You can now use the debugger.
2020-10-16 13:08:20 +02:00
## Troubleshooting
Inspect the installation with the following command. The requested Xdebug version should be displayed in the output.
2021-06-14 15:12:18 +02:00
```console
$ docker-compose exec php php --version
PHP ...
with Xdebug v3.0.4 ...
```