Debug PHP in Docker with PHPStorm and Xdebug

README.md

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

2. Get you local IP address (ip -o -4 addr list ${MY_NETWORK_INTERFACE:-eth0} | awk '{print $4}' | cut -d/ -f1)
3. Start your container with the following environment variables: 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}}"
      PHP_IDE_CONFIG: "serverName=my.local"

4. In Intellij/PHPStorm go to: Languages & Frameworks > PHP > Servers > and set the following settings:

• Name: name of your server, should be equal to value in PHP_IDE_CONFIG variable

Then you're all set and can start listening for PHP Debug connections from your IDE.

Happy debugging!

Thank you for this tutorial.

I just want to help out a bit how I managed to set it up with my client's docker. Just a few points on the above tutorial.

To get the IP I used this syntax:

    docker-composer exec <container-name> hostname -I

Real example on my computer:

mbaric@i7 /var/www/html/jobsoutsource (dev) $ docker-compose exec fpm hostname -I
172.22.0.9 

I started changing files fpm.docker:

FROM php:7.1.18-fpm

# Set to keep file permissions same as host for mounted volume
RUN useradd -m -u 1000 ubuntu

#RUN printf "deb http://archive.debian.org/debian/ jessie main\ndeb-src http://archive.debian.org/debian/ jessie main\ndeb http://security.debian.org jessie/updates main\ndeb-src http://security.debian.org jessie/updates main" > /etc/apt/sources.list

# Install GD
RUN apt-get update && apt-get install -y libfreetype6-dev libjpeg-dev libpng-dev libfontconfig1 libxrender1 git libmcrypt-dev  zip mysql-client && \
    docker-php-ext-configure gd \
          --enable-gd-native-ttf \
          --with-freetype-dir=/usr/include/freetype2 \
          --with-jpeg-dir=/usr/lib \
    && docker-php-ext-install gd


# Install MySQL
RUN docker-php-ext-install pdo_mysql

# Install Other Dependencies
RUN docker-php-ext-install bcmath
RUN docker-php-ext-install zip
RUN docker-php-ext-install exif
RUN docker-php-ext-install mbstring
RUN docker-php-ext-install mcrypt

# Install Composer
RUN apt-get install -y curl && \
    curl -sS https://getcomposer.org/installer | php && \
    mv composer.phar /usr/local/bin/composer && \
    composer self-update && \
    apt-get remove --purge curl -y && \
    apt-get clean

# Install Xdebug
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 \
    && echo "xdebug.idekey=PHPSTORM" >> /usr/local/etc/php/conf.d/xdebug.ini \
    && echo "xdebug.remote_port=9000" >> /usr/local/etc/php/conf.d/xdebug.ini \
    && echo "xdebug.remote_connect_back=1" >> /usr/local/etc/php/conf.d/xdebug.ini \
    && docker-php-ext-enable xdebug

WORKDIR /var/www

Take a note at the _ Install Xdebug_ section.

In the end, I went straight to docker-compose.yml and changed this:

  fpm:
    build:
      context: ./
      dockerfile: fpm.docker
    links:
      - mysql
      - memcached
      - beanstalkd
      - slanger
    volumes:
      - ./:/var/www
    environment:
      - "DB_PORT=3306"
      - "DB_HOST=mysql"
      - XDEBUG_CONFIG="remote_host=172.19.0.9"
      - PHP_IDE_CONFIG="serverName=jo"
    user: ubuntu

In the PHPStorm small changes were required the server needed to be renamed to jo and the mappings to /var/www/ since we are in the container not on my local machine anymore.

Finally for all of you guys there when you make changes to docker files or docker-compose.yml you need to rebuild it with this:

docker-compose up --build

Just one more thing, on all of you curios how I debug xdebug is with simple phpinfo().

Here are those images that I wanted to share:

Hope it will help somebody.

Thanks again to all for this.

Actually the solution is extremely simple now: Just set remote_host to the new special DNS name host.docker.internal. For example:

xdebug.remote_host = host.docker.internal

This now works with Docker for Windows or Docker for Mac (not Docker Toolbox) starting from version 18.03 and later. I just tried it and it worked perfectly for me. See documentation: Windows and Mac.

The nice thing about this elegant solution is that it fully abstracts away the magic behind the scenes associated with figuring out the IP address of your host development machine. IMHO, it should be Docker's responsibility to figure that out for you anyway, not the other way around.

EDIT: I've created my own Gist outlining this in detail from scratch here: https://gist.github.com/patricknelson/57ae24986cb13613314fb1f3c00a95d7

@mbaric answer made it work for us. Thank you for helping us!

No problem @jmossetc. Glad I could help.

Was it working for you guys because of the manual binding in the compose configuration to the environment variable XDEBUG_CONFIG="remote_host=172.19.0.9"? What happens when you change that IP to host.docker.internal?

If it works, I think it can be dramatically simplified by just hard-coding that hostname (either host.docker.internal or using10.0.2.2 if you're using Docker Toolbox with Virtualbox). The full hard-coded XDebug INI configuration can be found in my gist (also linked above) which doesn't need to be modified in environment variables, hopefully centralizing and de-cluttering things a bit.

@patricknelson my remote_host parameter is set to docker.host

I had trouble configuring xdebug. According to an old issue, you need to remove double quotes from the environment variable as follow

PHP_IDE_CONFIG="serverName=myserve"
changed to
PHP_IDE_CONFIG=serverName=myserver

And that made it work.