Skip to content
This repository was archived by the owner on Jun 25, 2024. It is now read-only.

Commit 1214a31

Browse files
committed
don't install xdebug out of the box
1 parent 4edadc5 commit 1214a31

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -232,3 +232,27 @@ Translations are categorized by page in definition files located in the `diction
232232
Localization is affected by the configuration setting `language.available`. Only language codes found in this property will be utilized.
233233
For example, if a translation is provided in Afrikaans for this module, the configuration must be adjusted to make 'af' an available
234234
language. If that's not done, the translation function will not utilize the translations even if provided.
235+
236+
### Debugging
237+
238+
Xdebug can be enabled by doing the following:
239+
240+
1. Define `REMOTE_DEBUG_IP` in `local.env`. This should be the IP address of your development machine, i.e. the one that
241+
is running your IDE. If you're using Linux as your Docker host, you can use 172.17.0.1 here.
242+
2. Map run-debug.sh into the container you wish to debug. For example:
243+
```yaml
244+
volumes:
245+
- ./development/run-debug.sh:/data/run.sh
246+
```
247+
3. Enable debugging in your IDE. See the next section for PhpStorm setup.
248+
249+
## Configuring PhpStorm for remote debugging
250+
251+
In PhpStorm go to: Preferences > PHP > Debug > DBGp Proxy and set the following settings:
252+
- Host: 172.17.0.1
253+
- Port: 9000
254+
Set path mappings in: Preferences > PHP > Servers
255+
- Add server 'localhost' and map 'application' to '/data' (varies by app)
256+
If this step is omitted, PhpStorm should prompt when an unrecognized path is encountered.
257+
258+
Then start listening by clicking the "listen" button on the PhpStorm toolbar.

0 commit comments

Comments
 (0)