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

Commit 77eff28

Browse files
committed
Add some more detail to the README's debugging instructions
1 parent 105f3f0 commit 77eff28

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,8 @@ language. If that's not done, the translation function will not utilize the tran
238238
Xdebug can be enabled by doing the following:
239239

240240
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.
241+
is running your IDE. If you're using Linux as your Docker host, you can use 172.17.0.1 here. Note that the IP address
242+
shown in your containers' logs may not be your machines actual IP address (it could be for a VM, for example).
242243
2. Map run-debug.sh into the container you wish to debug. For example:
243244
```yaml
244245
volumes:
@@ -248,12 +249,13 @@ Xdebug can be enabled by doing the following:
248249
249250
## Configuring PhpStorm for remote debugging
250251
251-
In PhpStorm go to: Preferences > PHP > Debug > DBGp Proxy and set the following settings:
252+
In PhpStorm go to: Preferences > Languages & Frameworks > PHP > Debug > DBGp Proxy and set the following settings:
252253
- Host: (your IP address or hostname)
253254
- Port: 9000
254255
255-
Set path mappings in: Preferences > PHP > Servers
256-
- Add a server and map the project folder to '/data/vendor/simplesamlphp/simplesamlphp/modules/material'
256+
Set path mappings in: Preferences > Languages & Frameworks > PHP > Servers
257+
- Add a server, giving it your IP address and a port of 9000, and map the project folder to
258+
'/data/vendor/simplesamlphp/simplesamlphp/modules/material'
257259
- Map other directories as needed. PhpStorm should prompt when an unrecognized path is encountered.
258260
259261
Then start listening by clicking the "listen" button on the PhpStorm toolbar.

0 commit comments

Comments
 (0)