Installing XDebug in Docker

Question

I'm trying to install the XDebug in a Docker container, but I'm getting the following error:

E: Unable to locate package php-xdebug

This is my Dockerfile:

FROM php:7.0-apache

RUN a2enmod rewrite

RUN docker-php-ext-install pdo pdo_mysql

RUN apt-get install php-xdebug -y

COPY php.ini /usr/local/etc/php/
COPY . /var/www/html/

When I'm running the same command in my computer, the XDebug is getting installed without any error:

apt-get install php-xdebug

Where might the problem be?

Kamafeather · Accepted Answer · 2023-05-11 11:03:22Z

51

I solved this by adding the following lines into my Docker file:

# "xdebug-2.9.0" for PHP<=7.4 — "xdebug" (3) for PHP>=8
ARG XDEBUG_VERSION="xdebug-2.9.0"

FROM php:7.0-apache

RUN a2enmod rewrite

RUN docker-php-ext-install pdo pdo_mysql

RUN yes | pecl install ${XDEBUG_VERSION} \
    && 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


COPY php.ini /usr/local/etc/php/
COPY . /var/www/html/

edited May 11, 2023 at 11:03

Kamafeather

10.1k15 gold badges79 silver badges111 bronze badges

answered Apr 29, 2018 at 15:07

UrmLmn

1,3072 gold badges19 silver badges28 bronze badges

Sign up to request clarification or add additional context in comments.

8 Comments

Bernhard Over a year ago

Hi, when I use this with localhost, the webserver does not respond. Do you have any hint, what I cold do?

Draex_ Over a year ago

@Bernhard, perhaps you forgot to bidn ports with -p when starting the container? Either way, you can start a new question with your full dockerfile and commands that you use :-).

AlbinoDrought Over a year ago

As of now we can shorten some of this to RUN pecl install xdebug && docker-php-ext-enable xdebug

Serhii Popov Over a year ago

In my case, this command helped RUN pecl install xdebug-2.9.0 && docker-php-ext-enable xdebug

Kamafeather Over a year ago

Default version changed and will fail with PHP 7.x. — For PHP 7.4 install xdebug-2.9.0, while for PHP 8.x install xdebug (will default to version 3.x) [at least, as in 2023]

|

Mitja · Accepted Answer · 2020-02-07 14:56:51Z

40

try this:

RUN pecl install xdebug && docker-php-ext-enable xdebug

answered Feb 7, 2020 at 14:56

Mitja

5164 silver badges2 bronze badges

1 Comment

okainov Over a year ago

Please note for PHP 5.x you have to explicitly specify version pecl install xdebug-2.5.5 since newer versions of xdebug don't support 5.x any more

Alex · Accepted Answer · 2020-05-09 16:56:35Z

24

As of PHP 7.4 you only need this

RUN pecl install xdebug \
    && docker-php-ext-enable xdebug

And add this line to enable remote debugging

&& echo "xdebug.remote_enable=on" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini \
&& echo "xdebug.remote_host = host.docker.internal" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini \

edited May 9, 2020 at 16:56

answered May 9, 2020 at 16:35

Alex

4574 silver badges11 bronze badges

1 Comment

Samuel Aiala Ferreira Over a year ago

i guess that host.docker.internal is mac only ... if you're on ubuntu you should use 172.17.0.1

Mateusz Przybylek · Accepted Answer · 2021-02-06 11:49:46Z

9

Since xdebug version 3 there are breaking changes in config names.

RUN pecl install xdebug; \
    docker-php-ext-enable xdebug

and for configuration:

        { \
            echo "xdebug.mode=debug"; \
            echo "xdebug.start_with_request=yes"; \
            echo "xdebug.client_host=host.docker.internal"; \
            echo "xdebug.client_port=9000"; \
        } > /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini; \

More info: https://xdebug.org/docs/upgrade_guide

edited Feb 6, 2021 at 11:49

answered Feb 6, 2021 at 11:44

Mateusz Przybylek

6,2153 gold badges44 silver badges42 bronze badges

4 Comments

fietserwin Over a year ago

Be aware that another one of the breaking changes is that the default port has changed from 9000 to 9003, so if your IDE has not been updated and now (also) listens to 9003 that last echo line is necessary, but better update or change your IDE configuration.

MikeiLL Over a year ago

Would you mind explaining where the "and for configuration" section belongs?

Mateusz Przybylek Over a year ago

It's a bash script (for dockerfile) that automatically put proper php/xdebug configuration into docker-php-ext-xdebug.ini file.

foxfabi Over a year ago

@MikeiLL if you use a Dockerfile like me, you can put the xdebug config settings into it like this: RUN echo "xdebug.mode=debug" >> $PHP_INI_DIR/conf.d/xdebug.ini ...

Chris Hirt · Accepted Answer · 2021-05-11 10:18:58Z

6

For PHP 7.3 I was able to install XDebug using the mlocati's docker-php-extension-installer.

My Dockerfile looks like this:

FROM php:7.3-apache
COPY --from=mlocati/php-extension-installer /usr/bin/install-php-extensions /usr/local/bin/
RUN install-php-extensions xdebug @composer

My docker-compose.yml contains the following which allows the special host.docker.internal name:

extra_hosts:
  - "host.docker.internal:host-gateway"

My xdebug configuration file /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini looks like this:

[xdebug]
zend_extension=xdebug
xdebug.mode=develop,debug
xdebug.start_with_request = yes
xdebug.client_host = "host.docker.internal"
xdebug.client_ip = "9003"
xdebug.idekey="VSCODE"
xdebug.log=/tmp/xdebug_remote.log

More details are in a Gist describing my PHP Debugging in Docker setup.

answered May 11, 2021 at 10:18

Chris Hirt

1112 silver badges4 bronze badges

2 Comments

Fabien Haddadi Over a year ago

xdebug.client_ip: you mean xdebug.client_port I hope?

Balwant Over a year ago

thanks man extra_hosts: - "host.docker.internal:host-gateway" this is what I'm missing in my setup

Anurag Prashant · Accepted Answer · 2022-02-21 13:41:30Z

0

I was using php8.0-alpine in the dockerfile. I was having an issue in installing xdebug in the container, so I changed the image to php8.0-alpine3.13 and works fine. Seems like 3.14 was having some issue with xdebug.

answered Feb 21, 2022 at 13:41

Anurag Prashant

1,03211 silver badges31 bronze badges

Comments

Marcin Orlowski · Accepted Answer · 2023-01-27 21:06:48Z

0

Just a note that use of xdebug.remote_enable and xdebug.remote_host is no longer correct as these options are renamed in xdebug v3 and now you should to use config names instead:

# For xdebug v3
RUN pecl install xdebug \
    && docker-php-ext-enable xdebug \
    && echo "xdebug.mode=debug" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini \
    && echo "xdebug.client_host = host.docker.internal" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini \

Docs:

answered Jan 27, 2023 at 21:06

Marcin Orlowski

75.7k11 gold badges128 silver badges152 bronze badges

Collectives™ on Stack Overflow

Installing XDebug in Docker

7 Answers 7

8 Comments

1 Comment

1 Comment

4 Comments

2 Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

7 Answers 7

8 Comments

1 Comment

1 Comment

4 Comments

2 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related