Skip to content

Commit d296594

Browse files
author
Oleksandr Peresypkin
committed
Update documentation
1 parent 54aa9ad commit d296594

3 files changed

Lines changed: 22 additions & 6 deletions

File tree

docs/06-installation/02-installation-guides/03-installing-in-development-mode-on-windows.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,17 @@ $ docker-compose --version
6363
```
6464
:::
6565
66-
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`:
66+
8. In `deploy.dev.yml`, set the debug configuration as follows:
6767
68-
```text
69-
...
70-
xdebug.remote_host=host.docker.internal
71-
...
72-
xdebug.client_host=host.docker.internal
68+
```yaml
69+
docker:
70+
...
71+
debug:
72+
enabled: true
73+
xdebug:
74+
enabled: true
75+
custom_host_ip: host.docker.internal
76+
...
7377
```
7478
7579
9. Add your user to the `docker` group:

docs/07-deploy-file/02-deploy.file.reference.v1.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -673,6 +673,7 @@ docker:
673673
674674
```
675675
* `docker: debug: xdebug: enabled:` - defines if Xdebug is enabled.
676+
* `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.
676677

677678
***
678679
### docker: logs:

docs/09-troubleshooting.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,17 @@ docker:
271271
xdebug:
272272
enabled: true
273273
```
274+
When working on Windows with WSL2, ensure the debug configuration is set up as follows:
275+
```yaml
276+
docker:
277+
...
278+
debug:
279+
enabled: true
280+
xdebug:
281+
enabled: true
282+
custom_host_ip: host.docker.internal
283+
...
284+
```
274285
2. Ensure that IDE is listening to the port 9000.
275286
3. Check if the host is accessible from the container:
276287
```bash

0 commit comments

Comments
 (0)