Skip to content

Commit 68febbf

Browse files
authored
Merge pull request #277 from thecodingmachine/feature/improve-xdebug-docs
Feature/improve xdebug docs
2 parents d655294 + 1162c74 commit 68febbf

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -367,6 +367,14 @@ Behind the scenes, the image will:
367367
- if you are using a Linux machine, the `xdebug.client_host` IP will point to your Docker gateway
368368
- if you are using a Windows or MaxOS machine, the `xdebug.client_host` IP will point to [`host.docker.internal`](https://docs.docker.com/docker-for-mac/networking/#use-cases-and-workarounds) or [`docker.for.mac.localhost`](https://docs.docker.com/docker-for-mac/networking/#use-cases-and-workarounds)
369369

370+
If you want to debug directly inside your container (for example if you're using [VSCode devcontainers](https://code.visualstudio.com/docs/remote/containers)) you can overwrite the [`xdebug.client_host`](https://xdebug.org/docs/all_settings#client_host) value by setting the following environment variable:
371+
372+
```bash
373+
XDEBUG_CLIENT_HOST=127.0.0.1
374+
```
375+
376+
In that case the manually set value takes precedence over the mentioned ones above.
377+
370378
## NodeJS
371379

372380
The *fat* images come with a Node variant. You can use Node 10, 12, 14 or 16. If you need a Node 8 variant, [use thecodingmachine/php v3 images](https://github.com/thecodingmachine/docker-images-php/tree/v3). If you need a Node 6 variant, [use thecodingmachine/php v1 images](https://github.com/thecodingmachine/docker-images-php/tree/7.2-v1).

utils/README.blueprint.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,14 @@ Behind the scenes, the image will:
285285
- if you are using a Linux machine, the `xdebug.client_host` IP will point to your Docker gateway
286286
- if you are using a Windows or MaxOS machine, the `xdebug.client_host` IP will point to [`host.docker.internal`](https://docs.docker.com/docker-for-mac/networking/#use-cases-and-workarounds) or [`docker.for.mac.localhost`](https://docs.docker.com/docker-for-mac/networking/#use-cases-and-workarounds)
287287

288+
If you want to debug directly inside your container (for example if you're using [VSCode devcontainers](https://code.visualstudio.com/docs/remote/containers)) you can overwrite the [`xdebug.client_host`](https://xdebug.org/docs/all_settings#client_host) value by setting the following environment variable:
289+
290+
```bash
291+
XDEBUG_CLIENT_HOST=127.0.0.1
292+
```
293+
294+
In that case the manually set value takes precedence over the mentioned ones above.
295+
288296
## NodeJS
289297

290298
The *fat* images come with a Node variant. You can use Node 10, 12, 14 or 16. If you need a Node 8 variant, [use thecodingmachine/php v3 images](https://github.com/thecodingmachine/docker-images-php/tree/v3). If you need a Node 6 variant, [use thecodingmachine/php v1 images](https://github.com/thecodingmachine/docker-images-php/tree/7.2-v1).

0 commit comments

Comments
 (0)