2019-03-02 16:57:21 +00:00
:orphan:
.. include :: /_includes/all.rst
2019-03-07 15:35:54 +00:00
.. include :: /_includes/snippets/__ANNOUNCEMENTS__.rst
2019-03-02 16:57:21 +00:00
.. _configure_php_xdebug_win_sublime:
***** ***** ***** ***** ***** ***** ***** ***** *** *
Docker on Windows: Xdebug for Sublime Text 3
***** ***** ***** ***** ***** ***** ***** ***** *** *
Docker for Windows requires a well known IP address in order to connect to the host operating
system.
**Table of Contents**
.. contents :: :local:
Prerequisites
=============
General
-------
Ensure you know how to customize `` php.ini `` values for the Devilbox and have a rough understanding
about common Xdebug options.
.. seealso ::
* :ref: `php_ini`
* :ref: `configure_php_xdebug_options`
2019-03-09 11:10:27 +00:00
Gather Host IP address
----------------------
2019-03-02 16:57:21 +00:00
On Windows you will have to manually retrieve the IP address to which Xdebug should connect to
via `` xdebug.remote_host `` .
2019-03-23 19:03:53 +00:00
When you have done no custom configuration in your Virtual Switch manager, Docker for Windows will
use the `` Default Switch `` automatically.
2019-03-09 11:10:27 +00:00
.. include :: /_includes/figures/xdebug/windows/virtual-switch-manager.rst
1. Open command line
2. Enter `` ipconfig ``
2019-03-23 19:03:53 +00:00
3. Look for the IP4 address in `` Default Switch `` (e.g.: `` 192.168.0.12 `` )
2019-03-09 11:10:27 +00:00
.. include :: /_includes/figures/xdebug/windows/ipconfig.rst
2019-03-02 16:57:21 +00:00
.. important ::
2019-03-09 11:10:27 +00:00
`` 192.168.0.12 `` is meant as an example and will eventually differ on your system.
2019-03-02 16:57:21 +00:00
Ensure you substitute it with the correct IP address.
2019-03-09 11:10:27 +00:00
.. seealso :: :ref: `howto_open_terminal_on_win`
2019-03-02 16:57:21 +00:00
Assumption
==========
For the sake of this example, we will assume the following settings and file system paths:
+------------------------------+------------------------------------------+
| Directory | Path |
+==============================+==========================================+
| Devilbox git directory | `` /home/cytopia/repo/devilbox `` |
+------------------------------+------------------------------------------+
| :ref: `env_httpd_datadir` | `` ./data/www `` |
+------------------------------+------------------------------------------+
| Resulting local project path | `` /home/cytopia/repo/devilbox/data/www `` |
+------------------------------+------------------------------------------+
| Selected PHP version | `` 5.6 `` |
+------------------------------+------------------------------------------+
2019-03-09 11:10:27 +00:00
| DockerNAT IP address | `` 192.168.0.12 `` |
+------------------------------+------------------------------------------+
| Virtual Switch IP address | `` 192.168.0.12 `` |
2019-03-02 16:57:21 +00:00
+------------------------------+------------------------------------------+
The **Resulting local project path** is the path where all projects are stored locally on your
host operating system. No matter what this path is, the equivalent remote path (inside the Docker
container) is always `` /shared/httpd `` .
.. important :: Remember this, when it comes to path mapping in your IDE/editor configuration.
Configuration
=============
Install Xdebug Client for Sublime
---------------------------------
Use Sublime's Package Control to search for and install `` Xdebug Client `` .
.. seealso :: |ext_lnk_xdebug_ide_sublime_xdebug_client|
Configure Sublime
-----------------
* Navigate to `` Tools `` -> `` Xdebug `` -> `` Settings - User `` in the menu
* This will open the configuration file in Sublime
.. code-block :: json
:caption: Xdebug-sublime-settings
:emphasize-lines: 3,6
{
"path_mapping": {
"/shared/httpd" : "/home/cytopia/repo/devilbox/data/www"
},
"url": "",
"ide_key": "sublime.xdebug",
"host": "0.0.0.0",
"port": 9000
}
.. important ::
Recall the path settings from the *Assumption* section and adjust if your configuration differs!
Configure php.ini
-----------------
.. note :: The following example show how to configure PHP Xdebug for PHP 5.6:
Create an `` xdebug.ini `` file (must end by `` .ini `` ):
.. code-block :: bash
# Navigate to the Devilbox git directory
host> cd path/to/devilbox
# Navigate to PHP 5.6 ini configuration directory
host> cd cfg/php-ini-5.6/
# Create and open debug.ini file
host> vi xdebug.ini
Copy/paste all of the following lines into the above created `` xdebug.ini `` file:
.. code-block :: ini
:caption: xdebug.ini
:emphasize-lines: 7,8,11
; Defaults
xdebug.default_enable=1
xdebug.remote_enable=1
xdebug.remote_port=9000
; The Windows way
xdebug.remote_connect_back=0
2019-03-09 11:10:27 +00:00
xdebug.remote_host=192.168.0.12
2019-03-02 16:57:21 +00:00
; idekey value is specific to Sublime
xdebug.idekey=sublime.xdebug
; Optional: Set to true to always auto-start xdebug
xdebug.remote_autostart=false
.. important :: Ensure you have retrieved the correct `` DockerNAT `` IP address as stated in the prerequisites section above!
.. note :: Host os and editor specific settings are highlighted in yellow and are worth googling to get a better understanding of the tools you use and to be more efficient at troubleshooting.
Restart the Devilbox
--------------------
Restarting the Devilbox is important in order for it to read the new PHP settings.
Note that the following example only starts up PHP, HTTPD and Bind.
.. code-block :: bash
# Navigate to the Devilbox git directory
host> cd path/to/devilbox
# Stop, remove stopped container and start
host> docker-compose stop
host> docker-compose rm
host> docker-compose up php httpd bind
.. seealso :: :ref: `start_the_devilbox_stop_and_restart` (Why do `` docker-compose rm `` ?)