]> git.immae.eu Git - github/shaarli/Shaarli.git/commitdiff
Documentation - REST API - Mention dev.debug mode 1181/head
authorArthurHoaro <arthur@hoa.ro>
Tue, 17 Jul 2018 11:53:53 +0000 (13:53 +0200)
committerArthurHoaro <arthur@hoa.ro>
Tue, 17 Jul 2018 11:54:15 +0000 (13:54 +0200)
doc/md/REST-API.md

index c016de56a6ff031a77fb4bffe7cb514b52a1878f..11bd1cd22f9a62a275ef3b5ce8570849545bb00e 100644 (file)
@@ -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
+  }
+}
+```