Update debugging page
parent
33633c468c
commit
6a7f12d75f
1 changed files with 46 additions and 19 deletions
65
Debugging.md
65
Debugging.md
|
@ -1,19 +1,35 @@
|
||||||
# XDebug
|
# Debugging with Xdebug
|
||||||
|
Loom Spinner PHP environments include **Xdebug** by default, making it easy to set up step debugging in your preferred IDE.
|
||||||
|
## Disabling Xdebug
|
||||||
|
To disable Xdebug for a new environment:
|
||||||
|
- Pass the `--disable-xdebug` option to `spin:up`
|
||||||
|
- **Or** set
|
||||||
|
``` yaml
|
||||||
|
options:
|
||||||
|
environment:
|
||||||
|
php:
|
||||||
|
xdebug: false
|
||||||
|
```
|
||||||
|
in your project’s before building the environment `spinner.yaml`
|
||||||
|
|
||||||
By default, your PHP container includes XDebug. This can be disabled for new environments by passing the
|
> Changes require destroying/rebuilding your environment (see [Configuration](Configuration)). **Note:**
|
||||||
`--disable-xdebug` option to the `spin:up` command, or by setting `options.environment.php.xdebug: false` in your
|
>
|
||||||
projects `spinner.yaml` file.
|
|
||||||
|
|
||||||
# Server Settings
|
## Configuring Your IDE for Debugging
|
||||||
|
|
||||||
The following instructions are for PHPStorm, I have not tested this with other IDE's, however the settings table should
|
The following instructions use PhpStorm, but similar settings apply in other IDEs.
|
||||||
be fairly universal.
|
|
||||||
|
|
||||||
## Server Configuration
|
### 1. Configure PHP Server
|
||||||
|
|
||||||
- `File` -> `Settings`
|
1. **Go to:** `File` > `Settings` > `PHP` > `Servers`
|
||||||
- `PHP` -> `Servers` -> `+`
|
2. **Add a new server:**
|
||||||
- Give your server a name and use the values shown below.
|
- **Name:** (any, e.g. `Loom Spinner`)
|
||||||
|
- **Host:** `127.0.0.1`
|
||||||
|
- **Port:**
|
||||||
|
Use the **local port** your PHP container exposes (e.g., if `52033:9003` appears in `docker ps`, use `52033`)
|
||||||
|
- **Debugger:** Xdebug
|
||||||
|
- **Use path mappings:** ✅ (Enabled)
|
||||||
|
- Map your **project root** to `/var/www/html`
|
||||||
|
|
||||||
| Setting | Value |
|
| Setting | Value |
|
||||||
|-------------------------|----------------------------------------------------------------------------------------------------------------|
|
|-------------------------|----------------------------------------------------------------------------------------------------------------|
|
||||||
|
@ -24,13 +40,24 @@ be fairly universal.
|
||||||
| File/Directory | Select **your project root** |
|
| File/Directory | Select **your project root** |
|
||||||
| Absolute path on server | /var/www/html |
|
| Absolute path on server | /var/www/html |
|
||||||
|
|
||||||
## Remote Debugger
|
### 2. Set Up Remote Debugging
|
||||||
|
|
||||||
- `Run` -> `Edit Configurations`
|
1. **Go to:** `Run` > `Edit Configurations`
|
||||||
- `+` -> `PHP Remote Debug`
|
2. **Add New Configuration:**
|
||||||
- Give it a name
|
- Select **PHP Remote Debug**
|
||||||
- Use the server you created before
|
- Assign a name (e.g., `Debug with Loom`)
|
||||||
- Use **SPINNER** as IDE key
|
- Choose the server you just created
|
||||||
|
- Set **IDE key**: `SPINNER`
|
||||||
|
|
||||||
Make sure you start listening when you want to debug by clicking the little bug icon in the top right (by default) in
|
### 3. Start Listening for Debug Connections
|
||||||
PHPStorm.
|
|
||||||
|
- Click the debug (bug) icon in your IDE to start listening for incoming debug connections.
|
||||||
|
- Set breakpoints in your code as needed.
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
- The IDE key must be set to `SPINNER` for remote debugging.
|
||||||
|
- The local port used by the PHP container can be found via `docker ps`.
|
||||||
|
- Make sure Docker is running and your environment is active.
|
||||||
|
|
||||||
|
For detailed tips, troubleshooting, or more advanced setup, consult your IDE's Xdebug documentation.
|
||||||
|
|
Loading…
Add table
Reference in a new issue