From cfa7421649495b45667e3811b1c6c0ea096e07c3 Mon Sep 17 00:00:00 2001 From: Oleksandr Peresypkin Date: Mon, 30 May 2022 06:18:17 +0200 Subject: [PATCH] Update documentation --- ...-installing-in-development-mode-on-windows.md | 16 ++++++++++------ .../02-deploy.file.reference.v1.md | 1 + docs/09-troubleshooting.md | 11 +++++++++++ 3 files changed, 22 insertions(+), 6 deletions(-) diff --git a/docs/06-installation/02-installation-guides/03-installing-in-development-mode-on-windows.md b/docs/06-installation/02-installation-guides/03-installing-in-development-mode-on-windows.md index 22fff4da2..062b56cc8 100644 --- a/docs/06-installation/02-installation-guides/03-installing-in-development-mode-on-windows.md +++ b/docs/06-installation/02-installation-guides/03-installing-in-development-mode-on-windows.md @@ -63,13 +63,17 @@ $ docker-compose --version ``` ::: -8. In `{shop_name}/docker/context/php/debug/etc/php/debug.conf.d/69-xdebug.ini`, set `xdebug.remote_host` and `xdebug.client_host` to `host.docker.internal`: +8. In `deploy.dev.yml`, set the debug configuration as follows: -```text -... -xdebug.remote_host=host.docker.internal -... -xdebug.client_host=host.docker.internal +```yaml +docker: + ... + debug: + enabled: true + xdebug: + enabled: true + custom_host_ip: host.docker.internal + ... ``` 9. Add your user to the `docker` group: diff --git a/docs/07-deploy-file/02-deploy.file.reference.v1.md b/docs/07-deploy-file/02-deploy.file.reference.v1.md index 6183d01c9..74d4cbba0 100644 --- a/docs/07-deploy-file/02-deploy.file.reference.v1.md +++ b/docs/07-deploy-file/02-deploy.file.reference.v1.md @@ -653,6 +653,7 @@ docker: ``` * `docker: debug: xdebug: enabled:` - defines if Xdebug is enabled. +* `docker: debug: xdebug: custom_host_ip:` - defines the custom host IP. It can be set as `host.docker.internal` when working in Windows environment with WSL2. *** ### docker: logs: diff --git a/docs/09-troubleshooting.md b/docs/09-troubleshooting.md index 326773b37..6bf396bc2 100644 --- a/docs/09-troubleshooting.md +++ b/docs/09-troubleshooting.md @@ -271,6 +271,17 @@ docker: xdebug: enabled: true ``` +When working on Windows with WSL2, ensure the debug configuration is set up as follows: +```yaml +docker: + ... + debug: + enabled: true + xdebug: + enabled: true + custom_host_ip: host.docker.internal + ... +``` 2. Ensure that IDE is listening to the port 9000. 3. Check if the host is accessible from the container: ```bash