Prepared xdebug Docker image with instructions (#5544)

This commit is contained in:
Jan Mikeš 2021-02-16 08:52:34 +01:00 committed by GitHub
parent 59e1063b50
commit e9a16265ea
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 51 additions and 6 deletions

View File

@ -0,0 +1,17 @@
################################################
## Docker image used for debugging Rector ##
################################################
ARG RECTOR_IMAGE="rector"
FROM rector/${RECTOR_IMAGE}:latest
# To overcome open_basedir restrictions for secured version
RUN [ ! -f "/usr/local/etc/php/conf.d/security.ini" ] || mv /usr/local/etc/php/conf.d/security.ini /tmp/security.ini
RUN pecl install xdebug
COPY .docker/php-xdebug/xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini
# We are done, put it back to original place
RUN [ ! -f "/tmp/security.ini" ] || mv /tmp/security.ini /usr/local/etc/php/conf.d/security.ini

View File

@ -0,0 +1,29 @@
## Docker image for Xdebug debugging
### Build
Builds image with `rector-xdebug` tag.
```shell
docker build . --tag rector-xdebug --file .docker/php-xdebug/Dockerfile
```
To build image with secured rector inside, use `--build-arg RECTOR_IMAGE="rector-secured"`:
```shell
docker build . --tag rector-secured-xdebug --build-arg RECTOR_IMAGE=rector-secured --file .docker/php-xdebug/Dockerfile
```
### Usage
Get into container (change ip address):
```shell
docker run -it --rm \
--entrypoint="" \
--volume $(pwd):/rector \
--env XDEBUG_CONFIG="client_host=172.16.165.1" \
--env PHP_IDE_CONFIG="serverName=rector" \
rector-xdebug bash
```
**Do not forget to run rector binary with `--xdebug` option.**

View File

@ -0,0 +1,5 @@
[xdebug]
zend_extension = "/usr/local/lib/php/extensions/no-debug-non-zts-20200930/xdebug.so"
xdebug.mode = debug
xdebug.client_port = 9003
xdebug.start_with_request = yes

View File

@ -1,6 +0,0 @@
[xdebug]
xdebug.remote_enable=1
xdebug.remote_autostart=1
xdebug.remote_connect_back=0
xdebug.profiler_enable=0
xdebug.remote_port=9001