From 40f0ff2236a92e2f2fb1631d1ffe62c56d5425ed Mon Sep 17 00:00:00 2001
From: ArthurHoaro <arthur@hoa.ro>
Date: Tue, 17 Jul 2018 13:53:53 +0200
Subject: Documentation - REST API - Mention dev.debug mode
---
doc/md/REST-API.md | 19 +++++++++++++++++++
1 file changed, 19 insertions(+)
diff --git a/doc/md/REST-API.md b/doc/md/REST-API.md
index c016de56..11bd1cd2 100644
--- a/doc/md/REST-API.md
+++ b/doc/md/REST-API.md
@@ -152,3 +152,22 @@ See the reference API client:
- [Documentation](http://python-shaarli-client.readthedocs.io/en/latest/) on ReadTheDocs
- [python-shaarli-client](https://github.com/shaarli/python-shaarli-client) on Github
+
+## Troubleshooting
+
+### Debug mode
+
+> This should never be used in a production environment.
+
+For security reasons, authentication issues will always return an `HTTP 401` error code without any detail.
+
+It is possible to enable the debug mode in `config.json.php`
+to get the actual error message in the HTTP response body with:
+
+```json
+{
+ "dev": {
+ "debug": true
+ }
+}
+```
--
cgit v1.2.3