docs: fix XDebug 3 configuration in CONTRIBUTING.md and docker-compose.yml

- Correct XDebug port from 9005 to 9003 (XDebug 3 default)
- Update VS Code pathMappings to use `${workspaceFolder}` (replaces deprecated `${workspaceRoot}`)
- Clarify that DEBUG build arg is already enabled in docker-compose.yml for development
- Enable DEBUG=true in docker-compose.yml development build args

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
David J Eddy
2026-03-23 11:36:45 +01:00
co-authored by Claude Sonnet 4.6
parent a5fa09b4ce
commit f5dda722dc
3 changed files with 8 additions and 5 deletions
+3
View File
@@ -337,6 +337,9 @@
* Fix txn API scope backwards compat in [#10640](https://github.com/appwrite/appwrite/pull/10640)
* Fix block schedules in [#10620](https://github.com/appwrite/appwrite/pull/10620)
* Update .NET SDK to 0.21.2 and improve release detection in [#10641](https://github.com/appwrite/appwrite/pull/10641)
* Enable DEBUG build arg in docker-compose.yml for development builds
* Fix VS Code XDebug pathMappings to use `${workspaceFolder}` instead of deprecated `${workspaceRoot}` in CONTRIBUTING.md
* Fix XDebug port to 9003 for XDebug 3 compatibility in CONTRIBUTING.md
* Make methods protected for extending in [#10617](https://github.com/appwrite/appwrite/pull/10617)
# Version 1.7.4
+4 -4
View File
@@ -564,7 +564,7 @@ Appwrite uses [XDebug](https://github.com/xdebug/xdebug) debugger, which can be
If you are in PHP Storm you don't need any plugin. Below are the settings required for remote debugger connection:
1. Set **DEBUG** build arg in **appwrite** service in **docker-compose.yml** file.
1. The **DEBUG** build arg is already set to `true` in the **appwrite** service in **docker-compose.yml** for development builds.
2. If needed edit the **dev/xdebug.ini** file to your needs.
3. Launch your Appwrite instance while your debugger is listening for connections.
@@ -587,16 +587,16 @@ zend_extension=xdebug
"name": "Listen for Xdebug",
"type": "php",
"request": "launch",
"port": 9005,
"port": 9003,
"pathMappings": {
"/usr/src/code": "${workspaceRoot}"
"/usr/src/code": "${workspaceFolder}"
}
}
```
### PHPStorm Setup
In settings, go to **Languages & Frameworks** > **PHP** > **Debug**, under **Xdebug** set the debug port to **9005** and enable the **can accept external connections** checkbox.
In settings, go to **Languages & Frameworks** > **PHP** > **Debug**, under **Xdebug** set the debug port to **9003** and enable the **can accept external connections** checkbox.
## Tests
+1 -1
View File
@@ -56,7 +56,7 @@ services:
context: .
target: development
args:
DEBUG: false
DEBUG: true
TESTING: true
VERSION: dev
ports: