Provide instructions for Linux users to replace xdebug hostname config w/correct IP

[carlos-reynosa]

General issue

Xdebug session does not start in Linux with given instructions.

Description:

Xdebug session does not start because host.docker.internal is not available on Linux. Docs should provide special instructions for Linux users to replace xdebug hostname configuration with a correct IP.

Possible solutions:

In order to configure xdebug correctly for Linux the remote hostname within the docker-compose.yml configuration should not use host.docker.internal and be replaced with the results of running the following command:

docker run --rm alpine ip route | awk 'NR==1 {print $3}'

Example xdebug configuration should result in:

  generic:
    image: alpine
    environment:
      - PHP_MEMORY_LIMIT=2048M
      - UPLOAD_MAX_FILESIZE=64M
      - MAGENTO_ROOT=/app
      - PHP_IDE_CONFIG=serverName=magento_cloud_docker
      - XDEBUG_CONFIG=remote_host=172.17.0.1

Additional information:

• https://stackoverflow.com/questions/24319662/from-inside-of-a-docker-container-how-do-i-connect-to-the-localhost-of-the-mach

[m2-assistant]

Hi @carlos-reynosa. Thank you for your report.
To help us process this issue please make sure that you provided sufficient information.

Please, add a comment to assign the issue: @magento I am working on this

---

• Join Magento Community Engineering Slack and ask your questions in #github channel.

[meker12]

@carlos-reynosa In the 2002.1.1 release Xdebug is automatically configured and enabled in a PHP container that's created when you specify the --with-xdebug option. See the draft Configure Xdebug topic in the Docker 1.1.0 integration branch.

And for details, see the PR description

Does the new Xdebug provisioning resolve your problem on Linux without requiring custom configuration?

[carlos-reynosa]

It does not solve the issue for Linux users and will require additional configuration and documentation guidance in order to set up xdebug within Linux successfully. The draft still assumes that the user is running docker for MacOs or Windows by not mentioning that the default configuration XDEBUG_CONFIG=remote_host=host.docker.internal uses the remote_host value host.docker.internal which is NOT available in Linux.

Ideally i think the xdebug container would take care of the issue automatically by setting the host.docker.internal value automatically if it's not available. If a solution is not provided automatically by the project, then I think it might be useful to mention the discrepancy for such a fundamental part of the xdebug configuration within the dev docs. Also providing a workaround would allow users to get started with the least amount of friction.

[shrielenee]

@carlos-reynosa You reopened this, but the PR that @meker12 mentioned is merged. And there is also a related issue #233 magento/magento-cloud-docker#233.

Should this issue remain open?