Update Dockerfile, docker-compose.development.yml, and docs for XDebug 3.
This commit is contained in:
parent
9ab502b390
commit
9bb7d4f855
|
@ -23,9 +23,7 @@ RUN sed -i 's|opcache.revalidate_freq=60|opcache.revalidate_freq=0|g' /usr/local
|
|||
|
||||
# Install and configure 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 "zend_extension=$(find /usr/local/lib/php/extensions/ -name xdebug.so)" > /usr/local/etc/php/conf.d/xdebug.ini
|
||||
|
||||
# Create a fresh /var/farmOS directory owned by www-data.
|
||||
RUN rm -r /var/farmOS && mkdir /var/farmOS && chown www-data:www-data /var/farmOS
|
||||
|
|
|
@ -20,4 +20,8 @@ services:
|
|||
ports:
|
||||
- '80:80'
|
||||
environment:
|
||||
XDEBUG_CONFIG: remote_host=172.17.0.1
|
||||
XDEBUG_MODE: debug
|
||||
XDEBUG_CONFIG: client_host=172.17.0.1
|
||||
# Enable these for PHPStorm:
|
||||
#XDEBUG_SESSION: PHPSTORM
|
||||
#PHP_IDE_CONFIG: serverName=localhost
|
||||
|
|
|
@ -1,9 +1,11 @@
|
|||
# Debugging
|
||||
|
||||
The farmOS development Docker image comes pre-installed with
|
||||
[XDebug](https://xdebug.org). In order to connect to it, the `XDEBUG_CONFIG`
|
||||
environment variable must be used to configure XDebug's `remote_host` setting
|
||||
with the Docker container's "Gateway" IP address.
|
||||
[XDebug](https://xdebug.org) 3, which allows debugger connections on port 9003.
|
||||
|
||||
In order to connect to it, the `XDEBUG_CONFIG` environment variable must be
|
||||
used to configure XDebug's `client_host` setting with the Docker container's
|
||||
"Gateway" IP address.
|
||||
|
||||
With the containers running, this command will print the gateway IP:
|
||||
|
||||
|
@ -13,7 +15,8 @@ Edit `docker-compose.yml` and enter the gateway IP in the `XDEBUG_CONFIG`
|
|||
environment variable. For example:
|
||||
|
||||
environment:
|
||||
XDEBUG_CONFIG: remote_host=192.168.128.1
|
||||
XDEBUG_MODE: debug
|
||||
XDEBUG_CONFIG: client_host=192.168.128.1
|
||||
|
||||
Restart the Docker containers for this change to take affect.
|
||||
|
||||
|
@ -32,13 +35,15 @@ execution at your breakpoint.
|
|||
|
||||
### Drush + PHPStorm
|
||||
|
||||
Debugging code that is run via [Drush](/development/environment/drush) commands requires
|
||||
additional configuration. Add `idekey=PHPSTORM` to the `XDEBUG_CONFIG`
|
||||
environment variable, and add a `PHP_IDE_CONFIG` environment variable with
|
||||
`serverName=localhost`, as follows:
|
||||
Debugging code that is run via [Drush](/development/environment/drush) commands
|
||||
requires additional configuration. Add an `XDEBUG_SESSION` environment variable
|
||||
with a value of `PHPSTORM`, and a `PHP_IDE_CONFIG` environment variable with a
|
||||
value of `serverName=localhost`, as follows:
|
||||
|
||||
environment:
|
||||
XDEBUG_CONFIG: remote_host=192.168.128.1 idekey=PHPSTORM
|
||||
XDEBUG_MODE: debug
|
||||
XDEBUG_CONFIG: client_host=192.168.128.1
|
||||
XDEBUG_SESSION: PHPSTORM
|
||||
PHP_IDE_CONFIG: serverName=localhost
|
||||
|
||||
Run a `drush` command and a prompt should appear in PHPStorm. You will need to
|
||||
|
|
Loading…
Reference in New Issue