Skip to content

Commit 8e49a87

Browse files
authored
Merge pull request #25 from vertexvaar/master
TASK: Add options summary and fix typo
2 parents 652a262 + 54b4932 commit 8e49a87

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ You can use the `xdebug.remote_log` to debug the protocol between your container
6363

6464
##### Docker Compose
6565

66-
This is an incomplet Docker Compose configuration:
66+
This is an incomplete Docker Compose configuration:
6767

6868
```
6969
services:
@@ -90,6 +90,13 @@ services:
9090
- debugproxy
9191
```
9292

93+
**Options summary:**
94+
* `IDE_IP` The primary local W-/LAN IP of your machine where your IDE runs on
95+
* `IDE_PORT` The Port your IDE is listening for incoming xdebug connections. (The port the debug proxy will try to connect to)
96+
* `XDEBUG_PORT` The port on which xdebug will try to establish a connection (to this container)
97+
* `FRAMEWORK` Currently supported values: `flow` and `dummy`
98+
* `ADDITIONAL_ARGS` For any additional argument like verbosity flags (`-vv`) or debug mode (`--debug`) (or both)
99+
93100
**Debugging the debugger**
94101

95102
Start the debug proxy with verbose flags if it does not connect to your IDE.

0 commit comments

Comments
 (0)