Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
peresypkin committed May 30, 2022
1 parent 66c8b46 commit cfa7421
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions docs/07-deploy-file/02-deploy.file.reference.v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
11 changes: 11 additions & 0 deletions docs/09-troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit cfa7421

Please sign in to comment.