Create a gist now

Instantly share code, notes, and snippets.

Embed
Debug PHP in Docker with PHPStorm and Xdebug

Debug your PHP in Docker with Intellij/PHPStorm and Xdebug

  1. For your local dev, create a Dockerfile that is based on your production image and simply install xdebug into it. Exemple:
FROM php:5

RUN yes | pecl install xdebug \
    && echo "zend_extension=$(find /usr/local/lib/php/extensions/ -name xdebug.so)" > /usr/local/etc/php/conf.d/xdebug.ini \
    && echo "xdebug.remote_enable=on" >> /usr/local/etc/php/conf.d/xdebug.ini \
    && echo "xdebug.remote_autostart=off" >> /usr/local/etc/php/conf.d/xdebug.ini
  1. Get you local IP address (ifconfig or such)
  2. Start your container with the following environment variable: XDEBUG_CONFIG="remote_host={{YOUR_IP_ADDRESS}}"
  • Simple docker run: docker run -e XDEBUG_CONFIG="remote_host={{YOUR_IP_ADDRESS}}" your-image

  • With docker-compose:

    # docker-compose.yml
    foo:
      build: path/to/Dockerfile
      environment:
        XDEBUG_CONFIG: remote_host={{YOUR_IP_ADDRESS}}
  1. In Intellij/PHPStorm go to: Languages & Frameworks > PHP > Debug > DBGp Proxy and set the following settings:
  • Host: your IP address
  • Port: 9000

Then you're all set and can start listening for PHP Debug connections from your IDE. On the first run it will ask you to map your local directoryies to the docker directories, but after that nothing will be required anymore!

Happy debugging!

@ScreamZ

This comment has been minimized.

Show comment
Hide comment
@ScreamZ

ScreamZ Nov 20, 2015

I must get My local ip (eth0), or my container IP ?

ScreamZ commented Nov 20, 2015

I must get My local ip (eth0), or my container IP ?

@sp0ng3w0rthy

This comment has been minimized.

Show comment
Hide comment
@sp0ng3w0rthy

sp0ng3w0rthy Dec 3, 2015

The IP of the machine running your IDE.

The IP of the machine running your IDE.

@atrigub

This comment has been minimized.

Show comment
Hide comment
@atrigub

atrigub Dec 11, 2015

Maybe should be use xdebug.remote_connect_back=1 ?

Do you have any idea how debug cli command in docker container?

atrigub commented Dec 11, 2015

Maybe should be use xdebug.remote_connect_back=1 ?

Do you have any idea how debug cli command in docker container?

@veloriba

This comment has been minimized.

Show comment
Hide comment
@veloriba

veloriba Jan 22, 2016

To atrigub
Type export XDEBUG_CONFIG="idekey=PHPSTORM" in terminal session

To atrigub
Type export XDEBUG_CONFIG="idekey=PHPSTORM" in terminal session

@boussou

This comment has been minimized.

Show comment
Hide comment
@boussou

boussou Feb 22, 2016

just to mention that you don't need to restart your docker to enable it
you can also add

[Xdebug]
xdebug.remote_enable=true
xdebug.remote_host=172.17.0.1
xdebug.remote_port=5902

here 172.17.0.1 is your host ip, you can find it with ifconfig in your host
then restart your webserver

boussou commented Feb 22, 2016

just to mention that you don't need to restart your docker to enable it
you can also add

[Xdebug]
xdebug.remote_enable=true
xdebug.remote_host=172.17.0.1
xdebug.remote_port=5902

here 172.17.0.1 is your host ip, you can find it with ifconfig in your host
then restart your webserver

@glumanda99

This comment has been minimized.

Show comment
Hide comment
@glumanda99

glumanda99 Apr 4, 2016

Don't you have to expose or map ports in your docker compose file? How can your IDE otherwise listen to?

Don't you have to expose or map ports in your docker compose file? How can your IDE otherwise listen to?

@jehaby

This comment has been minimized.

Show comment
Hide comment
@jehaby

jehaby Apr 29, 2016

@chadrien, thanks for your manual. Unfortunately, I couldn't make it work, so I changed it a little with descriptions of steps which worked for me: https://gist.github.com/jehaby/61a89b15571b4bceee2417106e80240d

jehaby commented Apr 29, 2016

@chadrien, thanks for your manual. Unfortunately, I couldn't make it work, so I changed it a little with descriptions of steps which worked for me: https://gist.github.com/jehaby/61a89b15571b4bceee2417106e80240d

@zeroleaf

This comment has been minimized.

Show comment
Hide comment
@zeroleaf

zeroleaf May 13, 2016

This work for me, thanks a lot.

This work for me, thanks a lot.

@martinbutt

This comment has been minimized.

Show comment
Hide comment
@martinbutt

martinbutt Jun 17, 2016

If you are using docker-machine with VirtualBox, you can skip step two and just use

XDEBUG_CONFIG: "remote_host=10.0.2.2"

If you are using docker-machine with VirtualBox, you can skip step two and just use

XDEBUG_CONFIG: "remote_host=10.0.2.2"
@jonniedarko

This comment has been minimized.

Show comment
Hide comment
@jonniedarko

jonniedarko Jul 7, 2016

I'm having issues with this using the new docker beta, if anyone can assist I would very much appreciate it, the details are posted on stackoverflow.com

I'm having issues with this using the new docker beta, if anyone can assist I would very much appreciate it, the details are posted on stackoverflow.com

@TuningGuide

This comment has been minimized.

Show comment
Hide comment
@TuningGuide

TuningGuide Jul 11, 2016

Can't I use 127.0.0.1 as remote_host?

Can't I use 127.0.0.1 as remote_host?

@patrick-mota

This comment has been minimized.

Show comment
Hide comment
@patrick-mota

patrick-mota Jul 15, 2016

@TuningGuide You can't since it will be used inside your container.

It will be like doing a query to the container itself.

That's why you have to use the ip of your host.

@TuningGuide You can't since it will be used inside your container.

It will be like doing a query to the container itself.

That's why you have to use the ip of your host.

@peric

This comment has been minimized.

Show comment
Hide comment
@peric

peric Jul 19, 2016

This still works for you?

I have Phpstorm 2016.2 and I went through all the steps of setting this up - but I get no signal from the xdebug. Docker sees my machine as 172.18.0.1 so this is what I set as remote_host on docker.

How do you setup remote debug in the last step? I have server named docker, where I have set host localhost and port to 9000. My ide key is PHPSTORM.

image

I think I have already tried all the possible options - nothing works :)

peric commented Jul 19, 2016

This still works for you?

I have Phpstorm 2016.2 and I went through all the steps of setting this up - but I get no signal from the xdebug. Docker sees my machine as 172.18.0.1 so this is what I set as remote_host on docker.

How do you setup remote debug in the last step? I have server named docker, where I have set host localhost and port to 9000. My ide key is PHPSTORM.

image

I think I have already tried all the possible options - nothing works :)

@hernandanielg

This comment has been minimized.

Show comment
Hide comment
@hernandanielg

hernandanielg Aug 2, 2016

I will name my first son in your honor bro! thanks!

I will name my first son in your honor bro! thanks!

@samlangdon

This comment has been minimized.

Show comment
Hide comment
@samlangdon

samlangdon Aug 19, 2016

I'm trying to get this to work using VSCode with the XCode extension, with the Docker configuration mentioned in this article, but not having much luck. I'm not seeing XDebug as being enabled in the phpinfo output running in my container; should it be mentioned in there? Note XDebug appears to install correctly when building from my Dockerfile, but I notice the above config doesn't add anything to php.ini.

I'm trying to get this to work using VSCode with the XCode extension, with the Docker configuration mentioned in this article, but not having much luck. I'm not seeing XDebug as being enabled in the phpinfo output running in my container; should it be mentioned in there? Note XDebug appears to install correctly when building from my Dockerfile, but I notice the above config doesn't add anything to php.ini.

@KIVagant

This comment has been minimized.

Show comment
Hide comment
@KIVagant

KIVagant Sep 7, 2016

Thank you, @chadrien

KIVagant commented Sep 7, 2016

Thank you, @chadrien

@damien-biasotto

This comment has been minimized.

Show comment
Hide comment
@damien-biasotto

damien-biasotto Sep 8, 2016

If you're using Docker for Mac (I don't know if this issue exists on Windows) you need to alias your local IP to something else : sudo ifconfig lo0 alias 10.254.254.254 in order to use XDebug properly (source https://forums.docker.com/t/ip-address-for-xdebug/10460/26).

Do not forget to add 10.254.254.254 in DBGp Proxy > Host setting.

damien-biasotto commented Sep 8, 2016

If you're using Docker for Mac (I don't know if this issue exists on Windows) you need to alias your local IP to something else : sudo ifconfig lo0 alias 10.254.254.254 in order to use XDebug properly (source https://forums.docker.com/t/ip-address-for-xdebug/10460/26).

Do not forget to add 10.254.254.254 in DBGp Proxy > Host setting.

@triadev

This comment has been minimized.

Show comment
Hide comment
@triadev

triadev Sep 12, 2016

@damien-biasotto: could you explain why i need to put the ip in the hosts file? What host name do I need to use?

triadev commented Sep 12, 2016

@damien-biasotto: could you explain why i need to put the ip in the hosts file? What host name do I need to use?

@digitalit

This comment has been minimized.

Show comment
Hide comment
@digitalit

digitalit Sep 24, 2016

FINALLY :)

This is how i solved this using Mac Sierra, Docker Native Version 1.12.1, PhpStorm 2016.3 EAP, https://github.com/shincoder/homestead-docker:

n provision.sh

# Enable Remote xdebug
echo "xdebug.idekey = PHPSTORM" >> /etc/php/7.0/fpm/conf.d/20-xdebug.ini
echo "xdebug.default_enable = 0" >> /etc/php/7.0/fpm/conf.d/20-xdebug.ini
echo "xdebug.remote_enable = 1" >> /etc/php/7.0/fpm/conf.d/20-xdebug.ini
echo "xdebug.remote_autostart = 0" >> /etc/php/7.0/fpm/conf.d/20-xdebug.ini
echo "xdebug.remote_connect_back = 0" >> /etc/php/7.0/fpm/conf.d/20-xdebug.ini
echo "xdebug.profiler_enable = 0" >> /etc/php/7.0/fpm/conf.d/20-xdebug.ini
echo "xdebug.remote_host = 10.254.254.254" >> /etc/php/7.0/fpm/conf.d/20-xdebug.ini

in docker-compose.yml

expose:
        - "9000"
    ports:
        - "8080:80" # web
        - "2222:22" # ssh
        - "35729:35729" # live reload
        - "9876:9876" # karma server
    environment:
        PHP_XDEBUG_ENABLED: 1 # Set 1 to enable.
        XDEBUG_CONFIG: remote_host=10.254.254.254

The IP i used everywhere is for my local mac, the one with phpStorm installed on. The IP is not 10.254.254.254 but since the IP could change i made an alias that points to 127.0.0.1.

For some reason i didn't work with 127.0.0.1 in all settings, i guess Docker container sees it at it self?

Anyway, to create the alias i did:

sudo ifconfig en0 alias 10.254.254.254 255.255.255.0

in phpStorm i used all default settings but added this:
skarmavbild 2016-09-24 kl 14 10 18

FINALLY :)

This is how i solved this using Mac Sierra, Docker Native Version 1.12.1, PhpStorm 2016.3 EAP, https://github.com/shincoder/homestead-docker:

n provision.sh

# Enable Remote xdebug
echo "xdebug.idekey = PHPSTORM" >> /etc/php/7.0/fpm/conf.d/20-xdebug.ini
echo "xdebug.default_enable = 0" >> /etc/php/7.0/fpm/conf.d/20-xdebug.ini
echo "xdebug.remote_enable = 1" >> /etc/php/7.0/fpm/conf.d/20-xdebug.ini
echo "xdebug.remote_autostart = 0" >> /etc/php/7.0/fpm/conf.d/20-xdebug.ini
echo "xdebug.remote_connect_back = 0" >> /etc/php/7.0/fpm/conf.d/20-xdebug.ini
echo "xdebug.profiler_enable = 0" >> /etc/php/7.0/fpm/conf.d/20-xdebug.ini
echo "xdebug.remote_host = 10.254.254.254" >> /etc/php/7.0/fpm/conf.d/20-xdebug.ini

in docker-compose.yml

expose:
        - "9000"
    ports:
        - "8080:80" # web
        - "2222:22" # ssh
        - "35729:35729" # live reload
        - "9876:9876" # karma server
    environment:
        PHP_XDEBUG_ENABLED: 1 # Set 1 to enable.
        XDEBUG_CONFIG: remote_host=10.254.254.254

The IP i used everywhere is for my local mac, the one with phpStorm installed on. The IP is not 10.254.254.254 but since the IP could change i made an alias that points to 127.0.0.1.

For some reason i didn't work with 127.0.0.1 in all settings, i guess Docker container sees it at it self?

Anyway, to create the alias i did:

sudo ifconfig en0 alias 10.254.254.254 255.255.255.0

in phpStorm i used all default settings but added this:
skarmavbild 2016-09-24 kl 14 10 18

@ericjeker

This comment has been minimized.

Show comment
Hide comment
@ericjeker

ericjeker Oct 2, 2016

@digitalit: Thank you ! Worked for me ! 👍

@digitalit: Thank you ! Worked for me ! 👍

@bscheshirwork

This comment has been minimized.

Show comment
Hide comment
@bscheshirwork

bscheshirwork Oct 16, 2016

for the CLI application use a similar way and set HOST to "localhost" (of course add PHP_IDE_CONFIG: "serverName=localhost" such as https://gist.github.com/jehaby/61a89b15571b4bceee2417106e80240d)

IDE setting like the https://gist.github.com/chadrien/c90927ec2d160ffea9c4#gistcomment-1829282

more info
https://sandro-keil.de/blog/2015/10/05/docker-php-xdebug-cli-debugging/

bscheshirwork commented Oct 16, 2016

for the CLI application use a similar way and set HOST to "localhost" (of course add PHP_IDE_CONFIG: "serverName=localhost" such as https://gist.github.com/jehaby/61a89b15571b4bceee2417106e80240d)

IDE setting like the https://gist.github.com/chadrien/c90927ec2d160ffea9c4#gistcomment-1829282

more info
https://sandro-keil.de/blog/2015/10/05/docker-php-xdebug-cli-debugging/

@silasb

This comment has been minimized.

Show comment
Hide comment
@silasb

silasb Oct 17, 2016

@digitalit worked for me as well.

One thing that helped me was setting a xdebug.remote_log="/tmp/xdebug.log and I kept seeing it trying to connect to 172.x.x.1, essentially I needed to turn off remote_connect_back and then do sudo ifconfig en0 alias 10.254.254.254 255.255.255.0 trick.

silasb commented Oct 17, 2016

@digitalit worked for me as well.

One thing that helped me was setting a xdebug.remote_log="/tmp/xdebug.log and I kept seeing it trying to connect to 172.x.x.1, essentially I needed to turn off remote_connect_back and then do sudo ifconfig en0 alias 10.254.254.254 255.255.255.0 trick.

@damien-biasotto

This comment has been minimized.

Show comment
Hide comment
@damien-biasotto

damien-biasotto Oct 20, 2016

@triadev My bad no need to put it in your /etc/hosts ….

@triadev My bad no need to put it in your /etc/hosts ….

@seblepers

This comment has been minimized.

Show comment
Hide comment
@seblepers

seblepers Nov 28, 2016

One more thing, if you are using Nginx + PHP-FPM containers, and having the following error message :
Cannot accept external Xdebug connection: Cannot evaluate expression '$_SERVER['SERVER_PORT']'

Make sure you have the following in your Nginx config:
fastcgi_param SERVER_PORT $server_port;

One more thing, if you are using Nginx + PHP-FPM containers, and having the following error message :
Cannot accept external Xdebug connection: Cannot evaluate expression '$_SERVER['SERVER_PORT']'

Make sure you have the following in your Nginx config:
fastcgi_param SERVER_PORT $server_port;

@vilewish

This comment has been minimized.

Show comment
Hide comment
@vilewish

vilewish Dec 1, 2016

@digitalit thanks for this tip with alias! Works for me.

vilewish commented Dec 1, 2016

@digitalit thanks for this tip with alias! Works for me.

@anaelChardan

This comment has been minimized.

Show comment
Hide comment
@anaelChardan

anaelChardan Dec 2, 2016

Some one tried to setup these tools together ?

  • PHPStorm 2016.3
  • XDebug
  • Docker
  • MacOS

I can't have my xdebug working :/

Here is my config :

RUN php5enmod xdebug &&
echo "xdebug.remote_enable=1" >> /etc/php5/apache2/conf.d/20-xdebug.ini &&
echo "xdebug.idekey=PHPSTORM" >> /etc/php5/apache2/conf.d/20-xdebug.ini &&
echo "xdebug.profiler_enable=0" >> /etc/php5/apache2/conf.d/20-xdebug.ini &&
echo "xdebug.max_nesting_level=700" >> /etc/php5/apache2/conf.d/20-xdebug.ini &&
echo "xdebug.remote_host=192.168.7.165" >> /etc/php5/apache2/conf.d/20-xdebug.ini

EDIT : I'll try the @digitalit answer

anaelChardan commented Dec 2, 2016

Some one tried to setup these tools together ?

  • PHPStorm 2016.3
  • XDebug
  • Docker
  • MacOS

I can't have my xdebug working :/

Here is my config :

RUN php5enmod xdebug &&
echo "xdebug.remote_enable=1" >> /etc/php5/apache2/conf.d/20-xdebug.ini &&
echo "xdebug.idekey=PHPSTORM" >> /etc/php5/apache2/conf.d/20-xdebug.ini &&
echo "xdebug.profiler_enable=0" >> /etc/php5/apache2/conf.d/20-xdebug.ini &&
echo "xdebug.max_nesting_level=700" >> /etc/php5/apache2/conf.d/20-xdebug.ini &&
echo "xdebug.remote_host=192.168.7.165" >> /etc/php5/apache2/conf.d/20-xdebug.ini

EDIT : I'll try the @digitalit answer

@jamescowie

This comment has been minimized.

Show comment
Hide comment
@jamescowie

jamescowie Jan 1, 2017

I had the same issues and eventually got it working with apache + PHP7 + PHPStorm 2016.3 + Xdebug My writeup incase it helps anyone. The networking command was key to getting it all working fine.

I had the same issues and eventually got it working with apache + PHP7 + PHPStorm 2016.3 + Xdebug My writeup incase it helps anyone. The networking command was key to getting it all working fine.

@jgutsche

This comment has been minimized.

Show comment
Hide comment
@jgutsche

jgutsche Jan 30, 2017

James got the point: use your host ip, no docker ip, nor localhost or 127.0.0.1 neither. I have 2 env up and running with php-5.6 and php-7.0, both with xdebug working in PHPSTORM.
Downside is: I may have different IPs at work or at home. I have not got connect_back working.

James got the point: use your host ip, no docker ip, nor localhost or 127.0.0.1 neither. I have 2 env up and running with php-5.6 and php-7.0, both with xdebug working in PHPSTORM.
Downside is: I may have different IPs at work or at home. I have not got connect_back working.

@georaldc

This comment has been minimized.

Show comment
Hide comment
@georaldc

georaldc Feb 1, 2017

@jgutsche @jamescowie Is the IP retrieved by running ifconfig inside the docker instance you want to run xdebug on? Because the IP value there did not work for me. The only way I have been able to get xdebug to trigger on my setup (which is a windows host by the way) is to use the IP assigned to my docker virtual ethernet adapter (DockerNAT, use ipconfig to easily find IP).

One unrelated question of mine though is why for some reason, xdebug always wants to attempt a connection despite having remote_autostart set to false.

georaldc commented Feb 1, 2017

@jgutsche @jamescowie Is the IP retrieved by running ifconfig inside the docker instance you want to run xdebug on? Because the IP value there did not work for me. The only way I have been able to get xdebug to trigger on my setup (which is a windows host by the way) is to use the IP assigned to my docker virtual ethernet adapter (DockerNAT, use ipconfig to easily find IP).

One unrelated question of mine though is why for some reason, xdebug always wants to attempt a connection despite having remote_autostart set to false.

@mrtuvn

This comment has been minimized.

Show comment
Hide comment
@mrtuvn

mrtuvn Feb 14, 2017

Anyone using docker in windows have same problem xdebug while run with phpstorm
Tried but can't connect to xdebug inside docker

mrtuvn commented Feb 14, 2017

Anyone using docker in windows have same problem xdebug while run with phpstorm
Tried but can't connect to xdebug inside docker

@jorge07

This comment has been minimized.

Show comment
Hide comment
@jorge07

jorge07 Feb 16, 2017

I added some doc in a personal project (used in my company too) about how to integrate with xdebug. Can be useful for someone maybe: https://github.com/jorge07/alpine-php/blob/master/doc/IDE.md

jorge07 commented Feb 16, 2017

I added some doc in a personal project (used in my company too) about how to integrate with xdebug. Can be useful for someone maybe: https://github.com/jorge07/alpine-php/blob/master/doc/IDE.md

@optimum-web

This comment has been minimized.

Show comment
Hide comment
@optimum-web

optimum-web Feb 22, 2017

You have also to mention to install phpize by sudo apt-get install php-dev.

Here is my version of dockerfile: ubuntu 14 + php5 + apache2 + xdebug

`
RUN apt-get update &&
DEBIAN_FRONTEND=noninteractive apt-get -yq install
curl
apache2
libapache2-mod-php5
php5-mysql
php5-mcrypt
php5-gd
php5-xdebug
php5-curl
php-pear
php5-memcache
php-apc &&
rm -rf /var/lib/apt/lists/*

RUN echo zend_extension="$(find / -name 'xdebug.so')"
RUN echo -e "zend_extension="$(find / -name 'xdebug.so')"\nxdebug.remote_enable=1\nxdebug.max_nesting_level=500\nxdebug.remote_connect_back=1\nxdebug.remote_port=9000" >> /etc/php5/apache2/conf.d/xdebug.ini
`

optimum-web commented Feb 22, 2017

You have also to mention to install phpize by sudo apt-get install php-dev.

Here is my version of dockerfile: ubuntu 14 + php5 + apache2 + xdebug

`
RUN apt-get update &&
DEBIAN_FRONTEND=noninteractive apt-get -yq install
curl
apache2
libapache2-mod-php5
php5-mysql
php5-mcrypt
php5-gd
php5-xdebug
php5-curl
php-pear
php5-memcache
php-apc &&
rm -rf /var/lib/apt/lists/*

RUN echo zend_extension="$(find / -name 'xdebug.so')"
RUN echo -e "zend_extension="$(find / -name 'xdebug.so')"\nxdebug.remote_enable=1\nxdebug.max_nesting_level=500\nxdebug.remote_connect_back=1\nxdebug.remote_port=9000" >> /etc/php5/apache2/conf.d/xdebug.ini
`

@aqwAntonio

This comment has been minimized.

Show comment
Hide comment
@aqwAntonio

aqwAntonio Mar 14, 2017

thank you very much for your comments!!! I finally set up my environment

thank you very much for your comments!!! I finally set up my environment

@leolandotan

This comment has been minimized.

Show comment
Hide comment
@leolandotan

leolandotan Apr 5, 2017

Hi guys, any idea why xdebug is looping in the index.php file on my end? It's like when I try to access my site, it triggers xdebug in the index.php file then I resume the debugger to go to my next breakpoint inside my site but it starts at index.php again.

Hi guys, any idea why xdebug is looping in the index.php file on my end? It's like when I try to access my site, it triggers xdebug in the index.php file then I resume the debugger to go to my next breakpoint inside my site but it starts at index.php again.

@Mwalima

This comment has been minimized.

Show comment
Hide comment
@Mwalima

Mwalima Apr 11, 2017

XDEBUG_CONFIG: "remote_host=192.168.45.432 idekey=PHPSTORM"

Mwalima commented Apr 11, 2017

XDEBUG_CONFIG: "remote_host=192.168.45.432 idekey=PHPSTORM"

@A----

This comment has been minimized.

Show comment
Hide comment
@A----

A---- Apr 12, 2017

Or yeah, you can just use xdebug.remote_connect_back=1 and it'll guess the IP address from the headers.

Beware though, and read carefully this: https://xdebug.org/docs/all_settings#remote_connect_back
Especially this:

Please note that there is no filter available, and anybody who can connect to the webserver will then be able to start a debugging session, even if their address does not match xdebug.remote_host.

A---- commented Apr 12, 2017

Or yeah, you can just use xdebug.remote_connect_back=1 and it'll guess the IP address from the headers.

Beware though, and read carefully this: https://xdebug.org/docs/all_settings#remote_connect_back
Especially this:

Please note that there is no filter available, and anybody who can connect to the webserver will then be able to start a debugging session, even if their address does not match xdebug.remote_host.

@georaldc

This comment has been minimized.

Show comment
Hide comment
@georaldc

georaldc Apr 19, 2017

@A---- xdebug.remote_connect_back won't work for Windows hosts because the IP returned would be 127.0.0.1.

@A---- xdebug.remote_connect_back won't work for Windows hosts because the IP returned would be 127.0.0.1.

@mikenk2010

This comment has been minimized.

Show comment
Hide comment
@mikenk2010

mikenk2010 May 30, 2017

Worked like a charm !!!, I still don't understand why !!!

  • Step 1: Create IP alias, run on your machine, not on docker container
    sudo ifconfig en0 alias 10.254.254.254 255.255.255.0
  • Step 2: Config xdebug.so as usually, depended on what is your server (Apache2, Nginx, etc.) and add xdebug.remote_log="/tmp/xdebug.log" to watch.
  • Step 3: xdebug.remote_host=10.254.254.254, I have tried with other IP (also change alias following my new IP) but it does not work...???
  • Step 4: Config your PHPStorm
    • Servers: Mapping your source files on docker
    • DBGp proxy: IDE key = based on your configuration, Host = 10.254.254.254, port = based on your configuration
  • Step 5: Edit configurations => Add PHP remote debug and select server as Step 4 and IDE key same as Step 4
  • Step 6: Click listening for PHP Debug Connections
  • Step 7: hold my beer !!!

Worked like a charm !!!, I still don't understand why !!!

  • Step 1: Create IP alias, run on your machine, not on docker container
    sudo ifconfig en0 alias 10.254.254.254 255.255.255.0
  • Step 2: Config xdebug.so as usually, depended on what is your server (Apache2, Nginx, etc.) and add xdebug.remote_log="/tmp/xdebug.log" to watch.
  • Step 3: xdebug.remote_host=10.254.254.254, I have tried with other IP (also change alias following my new IP) but it does not work...???
  • Step 4: Config your PHPStorm
    • Servers: Mapping your source files on docker
    • DBGp proxy: IDE key = based on your configuration, Host = 10.254.254.254, port = based on your configuration
  • Step 5: Edit configurations => Add PHP remote debug and select server as Step 4 and IDE key same as Step 4
  • Step 6: Click listening for PHP Debug Connections
  • Step 7: hold my beer !!!
@thyagoluciano

This comment has been minimized.

Show comment
Hide comment
@thyagoluciano

thyagoluciano Jun 5, 2017

@digitalit: Thank you! Worked for me!

@digitalit: Thank you! Worked for me!

@phpguru

This comment has been minimized.

Show comment
Hide comment
@phpguru

phpguru Jul 19, 2017

Sounds silly but if it is not working for you, restart your Docker containers and your IDE. I had all the settings correct and it didn't work until restarting the IDE.

phpguru commented Jul 19, 2017

Sounds silly but if it is not working for you, restart your Docker containers and your IDE. I had all the settings correct and it didn't work until restarting the IDE.

@Takeno

This comment has been minimized.

Show comment
Hide comment
@Takeno

Takeno Aug 22, 2017

Hi guys!

In Docker for Mac 17.06+, it works using docker.for.mac.localhost hostname to reach host machine.

You can find finalized solution here: https://github.com/ImprontaAdvance/docker-compose-symfony

Takeno commented Aug 22, 2017

Hi guys!

In Docker for Mac 17.06+, it works using docker.for.mac.localhost hostname to reach host machine.

You can find finalized solution here: https://github.com/ImprontaAdvance/docker-compose-symfony

@ikerlin

This comment has been minimized.

Show comment
Hide comment
@ikerlin

ikerlin Aug 29, 2017

@Takeno thanks share

ikerlin commented Aug 29, 2017

@Takeno thanks share

@yuklia

This comment has been minimized.

Show comment
Hide comment
@yuklia

yuklia Sep 13, 2017

@digitalit Why don't you just leave localhost in remote_host?

yuklia commented Sep 13, 2017

@digitalit Why don't you just leave localhost in remote_host?

@pshanoop

This comment has been minimized.

Show comment
Hide comment
@pshanoop

pshanoop Nov 27, 2017

docker network inspect bridge |awk '/"Gateway"/ {gsub ("\"","") ;print $2} To get host docker bridge ip.

docker network inspect bridge |awk '/"Gateway"/ {gsub ("\"","") ;print $2} To get host docker bridge ip.

@dekuyper

This comment has been minimized.

Show comment
Hide comment
@dekuyper

dekuyper Jan 17, 2018

You can get the host ip address by running this command: ifconfig en0 | awk '/ *inet /{print $2}'

You can get the host ip address by running this command: ifconfig en0 | awk '/ *inet /{print $2}'

@Ryangr0

This comment has been minimized.

Show comment
Hide comment
@Ryangr0

Ryangr0 Feb 5, 2018

THE SOLUTION

run yes | pecl install xdebug-2.5.5 instead of yes | pecl install xdebug. Support for PHP 5.6.x and under seems to have been removed in the latest release (2.6.0) and up.

Source: https://pecl.php.net/package-changelog.php?package=xdebug&release=2.6.0

THE PROBLEM
This does not seem to work anymore. I just ran a docker-compose build --no-cache on a dockerfile with a change that was unrelated to xdebug, and this happened.

Step 5/25 : RUN yes | pecl install xdebug
 ---> Running in f14a14dee07c
WARNING: channel "pecl.php.net" has updated its protocols, use "pecl channel-update pecl.php.net" to update
pecl/xdebug requires PHP (version >= 7.0.0), installed version is 5.6.32
No valid packages found
install failed
ERROR: Service 'web' failed to build: The command '/bin/sh -c yes | pecl install xdebug' returned a non-zero code: 1

I then removed my changes to the dockerfile and ran the build command again, same result. Tried running pecl channel-update pecl.php.net before pecl install xdebug and again, the same result.

Tried looking for the error message on google, the only similar one is this: https://build.webdevops.io/build/1d8a753154ca3762481e79d85a712321

Ryangr0 commented Feb 5, 2018

THE SOLUTION

run yes | pecl install xdebug-2.5.5 instead of yes | pecl install xdebug. Support for PHP 5.6.x and under seems to have been removed in the latest release (2.6.0) and up.

Source: https://pecl.php.net/package-changelog.php?package=xdebug&release=2.6.0

THE PROBLEM
This does not seem to work anymore. I just ran a docker-compose build --no-cache on a dockerfile with a change that was unrelated to xdebug, and this happened.

Step 5/25 : RUN yes | pecl install xdebug
 ---> Running in f14a14dee07c
WARNING: channel "pecl.php.net" has updated its protocols, use "pecl channel-update pecl.php.net" to update
pecl/xdebug requires PHP (version >= 7.0.0), installed version is 5.6.32
No valid packages found
install failed
ERROR: Service 'web' failed to build: The command '/bin/sh -c yes | pecl install xdebug' returned a non-zero code: 1

I then removed my changes to the dockerfile and ran the build command again, same result. Tried running pecl channel-update pecl.php.net before pecl install xdebug and again, the same result.

Tried looking for the error message on google, the only similar one is this: https://build.webdevops.io/build/1d8a753154ca3762481e79d85a712321

@Klizzy

This comment has been minimized.

Show comment
Hide comment
@Klizzy

Klizzy Feb 20, 2018

here is also a good video, where he is adressing the issue with the remote host: https://serversforhackers.com/c/getting-xdebug-working
thanks for some links and suggestions, it took me quite some time to get it running

Klizzy commented Feb 20, 2018

here is also a good video, where he is adressing the issue with the remote host: https://serversforhackers.com/c/getting-xdebug-working
thanks for some links and suggestions, it took me quite some time to get it running

@diglin

This comment has been minimized.

Show comment
Hide comment
@diglin

diglin Feb 23, 2018

For me the followings works on Docker for Mac:

xdebug.remote_autostart=0
xdebug.remote_enable=1
xdebug.default_enable=0
xdebug.remote_host=docker.for.mac.host.internal
xdebug.remote_port=9000
xdebug.remote_connect_back=0
xdebug.profiler_enable=0
xdebug.remote_log="/tmp/xdebug.log"

The docker.for.mac.host.internal host prevent scratching the head regarding IP alias or no network at all on host side. The source comes from the docker documentation https://docs.docker.com/docker-for-mac/networking/#use-cases-and-workarounds

No needs for extra configuration or environment variable in docker compose.

diglin commented Feb 23, 2018

For me the followings works on Docker for Mac:

xdebug.remote_autostart=0
xdebug.remote_enable=1
xdebug.default_enable=0
xdebug.remote_host=docker.for.mac.host.internal
xdebug.remote_port=9000
xdebug.remote_connect_back=0
xdebug.profiler_enable=0
xdebug.remote_log="/tmp/xdebug.log"

The docker.for.mac.host.internal host prevent scratching the head regarding IP alias or no network at all on host side. The source comes from the docker documentation https://docs.docker.com/docker-for-mac/networking/#use-cases-and-workarounds

No needs for extra configuration or environment variable in docker compose.

@helman

This comment has been minimized.

Show comment
Hide comment
@helman

helman Mar 2, 2018

Hi guys, I was struggling with configuring Docker and XDebug.
The main point is you will need to restart the XDebug Session listener on PHPStorm every time you change the configuration!

helman commented Mar 2, 2018

Hi guys, I was struggling with configuring Docker and XDebug.
The main point is you will need to restart the XDebug Session listener on PHPStorm every time you change the configuration!

@hbt

This comment has been minimized.

Show comment
Hide comment
@hbt

hbt Mar 18, 2018

I set up a quick howto repo with example + step by step guide here https://github.com/hbt/howto-docker-xdebug with screenshots

hbt commented Mar 18, 2018

I set up a quick howto repo with example + step by step guide here https://github.com/hbt/howto-docker-xdebug with screenshots

@joelataylor

This comment has been minimized.

Show comment
Hide comment
@joelataylor

joelataylor Mar 19, 2018

Thank you to all the comments here! I was able to get Atom working w/ php-debug + xdebug + docker!

Thank you to all the comments here! I was able to get Atom working w/ php-debug + xdebug + docker!

@Kil0p

This comment has been minimized.

Show comment
Hide comment
@Kil0p

Kil0p Mar 29, 2018

When I debug wordpress with this configuration everything seems to work but one thing.
I got 2 requests in every debug request. First request is good one which stops php scripts in normal debug session ( web server is paused and waiting for script to die or continue ). Second request seems to do nothing with web server, but xdebug client is working on breakpoint.

Kil0p commented Mar 29, 2018

When I debug wordpress with this configuration everything seems to work but one thing.
I got 2 requests in every debug request. First request is good one which stops php scripts in normal debug session ( web server is paused and waiting for script to die or continue ). Second request seems to do nothing with web server, but xdebug client is working on breakpoint.

@albertski

This comment has been minimized.

Show comment
Hide comment
@albertski

albertski Mar 31, 2018

When I run the command sudo ifconfig en0 alias 10.254.254.254 255.255.255.0 I can't access my site anymore through browsers. Do you guys know how to get around this?

When I run the command sudo ifconfig en0 alias 10.254.254.254 255.255.255.0 I can't access my site anymore through browsers. Do you guys know how to get around this?

@jtreminio

This comment has been minimized.

Show comment
Hide comment
@jtreminio

jtreminio Apr 1, 2018

MacOS:

[xdebug]
xdebug.remote_host = "docker.for.mac.host.internal"
xdebug.default_enable = 1
xdebug.remote_autostart = 1
xdebug.remote_connect_back = 0
xdebug.remote_enable = 1
xdebug.remote_handler = "dbgp"
xdebug.remote_port = 9000

Linux:

[xdebug]
xdebug.remote_host = "172.18.0.1"
xdebug.default_enable = 1
xdebug.remote_autostart = 1
xdebug.remote_connect_back = 0
xdebug.remote_enable = 1
xdebug.remote_handler = "dbgp"
xdebug.remote_port = 9000

Windows:

[xdebug]
xdebug.remote_host = "docker.for.win.host.internal"
xdebug.default_enable = 1
xdebug.remote_autostart = 1
xdebug.remote_connect_back = 0
xdebug.remote_enable = 1
xdebug.remote_handler = "dbgp"
xdebug.remote_port = 9000

MacOS:

[xdebug]
xdebug.remote_host = "docker.for.mac.host.internal"
xdebug.default_enable = 1
xdebug.remote_autostart = 1
xdebug.remote_connect_back = 0
xdebug.remote_enable = 1
xdebug.remote_handler = "dbgp"
xdebug.remote_port = 9000

Linux:

[xdebug]
xdebug.remote_host = "172.18.0.1"
xdebug.default_enable = 1
xdebug.remote_autostart = 1
xdebug.remote_connect_back = 0
xdebug.remote_enable = 1
xdebug.remote_handler = "dbgp"
xdebug.remote_port = 9000

Windows:

[xdebug]
xdebug.remote_host = "docker.for.win.host.internal"
xdebug.default_enable = 1
xdebug.remote_autostart = 1
xdebug.remote_connect_back = 0
xdebug.remote_enable = 1
xdebug.remote_handler = "dbgp"
xdebug.remote_port = 9000
@BramDriesen

This comment has been minimized.

Show comment
Hide comment
@BramDriesen

BramDriesen Apr 20, 2018

We can confirm that the last comment by @jtreminio is working for us. Tested on MacOS and Linux.

We can confirm that the last comment by @jtreminio is working for us. Tested on MacOS and Linux.

@asadovkamran

This comment has been minimized.

Show comment
Hide comment
@asadovkamran

asadovkamran May 3, 2018

I followed instructions and got xdebug listed in my phpinfo(). But connection times out when trying to connect the website.

I followed instructions and got xdebug listed in my phpinfo(). But connection times out when trying to connect the website.

@MikeDevs

This comment has been minimized.

Show comment
Hide comment
@MikeDevs

MikeDevs May 8, 2018

I think for Linux, MacOS, and Windows you should now use host.docker.internal for remote_host with Docker 18.03.0-ce+. That should simplify shared environments.

[xdebug]
xdebug.remote_host = "host.docker.internal"
xdebug.default_enable = 1
xdebug.remote_autostart = 1
xdebug.remote_connect_back = 0
xdebug.remote_enable = 1
xdebug.remote_handler = "dbgp"
xdebug.remote_port = 9000

MikeDevs commented May 8, 2018

I think for Linux, MacOS, and Windows you should now use host.docker.internal for remote_host with Docker 18.03.0-ce+. That should simplify shared environments.

[xdebug]
xdebug.remote_host = "host.docker.internal"
xdebug.default_enable = 1
xdebug.remote_autostart = 1
xdebug.remote_connect_back = 0
xdebug.remote_enable = 1
xdebug.remote_handler = "dbgp"
xdebug.remote_port = 9000
@hernandev

This comment has been minimized.

Show comment
Hide comment
@hernandev

hernandev May 8, 2018

Hello everyone, here is how I've included support for XDebug on Ambientum:

considering the image start file is start.sh:

#!/usr/bin/env bash

if [[ $XDEBUG_ENABLED == true ]]; then
    # enable xdebug extension
    sudo sed -i "/;zend_extension=xdebug/c\zend_extension=xdebug" /etc/php7/conf.d/00_xdebug.ini

    # enable xdebug remote config
    echo "[xdebug]" | sudo tee -a /etc/php7/conf.d/00_xdebug.ini > /dev/null
    echo "xdebug.remote_enable=1" | sudo tee -a /etc/php7/conf.d/00_xdebug.ini > /dev/null
    echo "xdebug.remote_host=`/sbin/ip route|awk '/default/ { print $3 }'`" | sudo tee -a /etc/php7/conf.d/00_xdebug.ini > /dev/null
    echo "xdebug.remote_port=9000" | sudo tee -a /etc/php7/conf.d/00_xdebug.ini > /dev/null
    echo "xdebug.scream=0" | sudo tee -a /etc/php7/conf.d/00_xdebug.ini > /dev/null
    echo "xdebug.cli_color=1" | sudo tee -a /etc/php7/conf.d/00_xdebug.ini > /dev/null
    echo "xdebug.show_local_vars=1" | sudo tee -a /etc/php7/conf.d/00_xdebug.ini > /dev/null
    echo 'xdebug.idekey = "ambientum"' | sudo tee -a /etc/php7/conf.d/00_xdebug.ini > /dev/null

fi

# run the original command
exec "$@"

This allows automatic host IP detection, using the /sbin/ip route|awk '/default/ { print $3 }'

Also notice the ide key is defaulted to ambientum on the example, and the 00_xdebug.ini may have another path.

If you want to check it out implemented on a image, here is the sources for Ambientum:

https://github.com/codecasts/ambientum/tree/master/php/7.2

hernandev commented May 8, 2018

Hello everyone, here is how I've included support for XDebug on Ambientum:

considering the image start file is start.sh:

#!/usr/bin/env bash

if [[ $XDEBUG_ENABLED == true ]]; then
    # enable xdebug extension
    sudo sed -i "/;zend_extension=xdebug/c\zend_extension=xdebug" /etc/php7/conf.d/00_xdebug.ini

    # enable xdebug remote config
    echo "[xdebug]" | sudo tee -a /etc/php7/conf.d/00_xdebug.ini > /dev/null
    echo "xdebug.remote_enable=1" | sudo tee -a /etc/php7/conf.d/00_xdebug.ini > /dev/null
    echo "xdebug.remote_host=`/sbin/ip route|awk '/default/ { print $3 }'`" | sudo tee -a /etc/php7/conf.d/00_xdebug.ini > /dev/null
    echo "xdebug.remote_port=9000" | sudo tee -a /etc/php7/conf.d/00_xdebug.ini > /dev/null
    echo "xdebug.scream=0" | sudo tee -a /etc/php7/conf.d/00_xdebug.ini > /dev/null
    echo "xdebug.cli_color=1" | sudo tee -a /etc/php7/conf.d/00_xdebug.ini > /dev/null
    echo "xdebug.show_local_vars=1" | sudo tee -a /etc/php7/conf.d/00_xdebug.ini > /dev/null
    echo 'xdebug.idekey = "ambientum"' | sudo tee -a /etc/php7/conf.d/00_xdebug.ini > /dev/null

fi

# run the original command
exec "$@"

This allows automatic host IP detection, using the /sbin/ip route|awk '/default/ { print $3 }'

Also notice the ide key is defaulted to ambientum on the example, and the 00_xdebug.ini may have another path.

If you want to check it out implemented on a image, here is the sources for Ambientum:

https://github.com/codecasts/ambientum/tree/master/php/7.2

@hernandev

This comment has been minimized.

Show comment
Hide comment
@hernandev

hernandev May 8, 2018

@MikeDevs one way to have the host.docker.internal on ANY Docker version is to include it on the /etc/hosts manually upon start (entry point script):

echo -e "`/sbin/ip route|awk '/default/ { print $3 }'`\tdocker.host.internal" | sudo tee -a /etc/hosts > /dev/null

Doing that line, you can now easily check docker.host.internal by doing

ping docker.host.internal

:)

hernandev commented May 8, 2018

@MikeDevs one way to have the host.docker.internal on ANY Docker version is to include it on the /etc/hosts manually upon start (entry point script):

echo -e "`/sbin/ip route|awk '/default/ { print $3 }'`\tdocker.host.internal" | sudo tee -a /etc/hosts > /dev/null

Doing that line, you can now easily check docker.host.internal by doing

ping docker.host.internal

:)

@stefanosaittamrf

This comment has been minimized.

Show comment
Hide comment
@stefanosaittamrf

stefanosaittamrf May 22, 2018

When I debug wordpress with this configuration everything seems to work but one thing.
I got 2 requests in every debug request. First request is good one which stops php scripts in normal debug session ( web server is paused and waiting for script to die or continue ). Second request seems to do nothing with web server, but xdebug client is working on breakpoint.

Same happen to me @Kil0p did you manage to solve? Also, i have an issue debugging a plugin, since in my dev environment i just expose the plugin directory and hide inside the docker container the wordpress code, the issue happens when my debugger try to step into the actual implementation but since the code is not there it fails. I Don't know if i explain it clearly, if not let me know.

When I debug wordpress with this configuration everything seems to work but one thing.
I got 2 requests in every debug request. First request is good one which stops php scripts in normal debug session ( web server is paused and waiting for script to die or continue ). Second request seems to do nothing with web server, but xdebug client is working on breakpoint.

Same happen to me @Kil0p did you manage to solve? Also, i have an issue debugging a plugin, since in my dev environment i just expose the plugin directory and hide inside the docker container the wordpress code, the issue happens when my debugger try to step into the actual implementation but since the code is not there it fails. I Don't know if i explain it clearly, if not let me know.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment