From ac6eceb0e570304b9bff7a8fefa6428b352f8920 Mon Sep 17 00:00:00 2001
From: julesdevops <julesbourdais7198@gmail.com>
Date: Sun, 23 Jan 2022 14:26:01 +0100
Subject: [PATCH] doc(dev): add xdebug informations

---
 readme.md | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/readme.md b/readme.md
index 22d0691dd..de5da04d9 100644
--- a/readme.md
+++ b/readme.md
@@ -156,6 +156,11 @@ Once the database has been migrated & seeded, you can run the tests like so:
 docker-compose run app php vendor/bin/phpunit
 ```
 
+#### Debugging
+
+The docker-compose setup ships with Xdebug, which you can listen to on port 9090.
+NB : For some editors like Visual Studio Code, you might need to map your workspace folder to the /app folder within the docker container for this to work.
+
 ## 🌎 Translations
 
 Translations for text within BookStack is managed through the [BookStack project on Crowdin](https://crowdin.com/project/bookstack). Some strings have colon-prefixed variables in such as `:userName`. Leave these values as they are as they will be replaced at run-time. Crowdin is the preferred way to provide translations, otherwise the raw translations files can be found within the `resources/lang` path.