Browse Source

Merge pull request #1181 from ArthurHoaro/docs/api-debug

Documentation - REST API - Mention dev.debug mode
nodiscc 5 years ago
parent
commit
d6e392a9cb
1 changed files with 19 additions and 0 deletions
  1. 19 0
      doc/md/REST-API.md

+ 19 - 0
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
+  }
+}
+```