MediaWiki-Docker/Configuration recipes/Xdebug

From mediawiki.org
Jump to navigation Jump to search

XDebug[edit]

To use XDebug with MediaWiki running inside a docker container, you have to tell the PHP environment running inside the container to connect to the IDE on the host machine. To do this, set the XDEBUG_CONFIG variable in your .env file:

# Use idekey=VSCODE for VS Code
XDEBUG_CONFIG='mode=debug start_with_request=trigger client_host=192.168.1.1 client_port=9000 idekey=PHPSTORM' 
XDEBUG_MODE=debug
# Only needed for PHPStorm
PHP_IDE_CONFIG='serverName=docker'

Older versions of XDebug (< 3.0) use a different syntax for XDEBUG_CONFIG:

# Use idekey=VSCODE for VS Code
XDEBUG_CONFIG='remote_enable=1 remote_mode=req remote_host=192.168.1.1 remote_port=9000 idekey=PHPSTORM'

The following values may have to be adjusted for your system:

  • client_host or remote_host: this has to be the IP address of the host system (your laptop) as seen from inside the container. Generally, this will just the IP address assigned to the host in the local network. On Linux, you can use ifconfig or ip -o -4 addr list to list these addresses. Caveat: if you are running docker in a virtual machine, additional configuration may be necessary.
  • client_port or remote_port: adjust this to the port the IDE is listening on (or a port that is configured to forward to the IDE). This should rarely change from xdebug's default, which is 9000.
  • idekey: the key to use when connecting to the IDE. This has to match the key configured in the IDE. For PhpStorm, the default is PHPSTORM, for VS Code it's VSCODE
  • serverName : the server name to use by PhpStorm to apply path mappings when manually running command line scripts (see PhpStorm documentation ). Caveat: as of November 4 2020, PHP_IDE_CONFIG needs a patch for docker-compse.yaml . And it still didn't quite work for me .

IDE Integration[edit]

For integration with VS code, see the Xdebug config for VS Code recipe.

For integration with PhpStorm, see the blog post on Debugging MediaWiki with PhpStorm. If you use PhpStorm to run the code, you may not need the above configuration, since PhpStorm will set the appropriate environment variables automatically.