cytopia / cytopia/devilbox

[Docs]: Add XDebug configuration info for WSL2 Support

Open
#929 2 comments 0 reactions 1 assignee Claimed by @cytopia View on GitHub
Community help wanted documentation xdebug
Dominant language
PHP
Stars
4.5k
Forks
652
PR merge metrics
No merged PRs in 30d

Description

### What is wrong in the documentation?

Apparently there is only linux, mac, and windows tutorial for configuring XDebug to get that working properly. Long story short me and my team struggled how to configure xdebug.client_host based on linux/windows tutorial shown in the docs. VSCode running remote in WSL2 for example, it will use the hostname from the WSL2 instead of the localhost or docker.for.lin.internal host.

So i guess we should add more instruction to make sure people using WSL2 backend docker uses the hostname of the WSL instead for the xdebug.client_host configuration. You can get that information through command line:

`wsl> hostname -I`

### What is missing in the documentation?

Information, WSL2 backend for Docker users should use WSL2 hostname for the xdebug.client_host, and the hostname could be retrieved from:

`wsl> hostname -I`

### Are you willing to provide a PR to address this?

_No response_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.