devilbox/docs/intermediate/configure-php-xdebug.rst

2.5 KiB

Configure PHP Xdebug

This section explains in depth how to enable and use PHP Xdebug with the Devilbox.

Table of Contents

local

Introduction

In order to have a working Xdebug, you need to ensure two things:

  1. PHP Xdebug must be configured and enabled in PHP itself
  2. Your IDE/editor must be configured and requires a way talk to PHP

Configuring PHP Xdebug will slightly differ when configuring it for a dockerized environment. This is due to the fact that Docker versions on different host os have varying implementations of how they connect back to the host.

Most IDE or editors will also require different configurations for how they talk to PHP Xdebug. This is at least most likely the case for xdebug.idekey.

configure_php_xdebug_options

Configure Xdebug

Docker on Linux

Docker on Linux allows Xdebug to automatically connect back to the host system without the need of an explicit IP address.

/intermediate/configure-php-xdebug/linux/*

  • configure_php_xdebug_lin_atom
  • configure_php_xdebug_lin_phpstorm
  • configure_php_xdebug_lin_sublime
  • configure_php_xdebug_lin_vscode

Docker on MacOS

/intermediate/configure-php-xdebug/macos/*

  • configure_php_xdebug_mac_atom
  • configure_php_xdebug_mac_phpstorm
  • configure_php_xdebug_mac_sublime
  • configure_php_xdebug_mac_vscode

Docker on Windows

/intermediate/configure-php-xdebug/windows/*

  • configure_php_xdebug_win_atom
  • configure_php_xdebug_win_phpstorm
  • configure_php_xdebug_win_sublime
  • configure_php_xdebug_win_vscode

Docker Toolbox

Docker Toolbox configuration is equal, no matter if it is started on MacOS or Windows, as both use a Linux system inside VirtualBox.

/intermediate/configure-php-xdebug/toolbox/*

  • configure_php_xdebug_toolbox_atom
  • configure_php_xdebug_toolbox_phpstorm
  • configure_php_xdebug_toolbox_sublime
  • configure_php_xdebug_toolbox_vscode