From 87f14312470ca51b936896b41413c96edfe3b18f Mon Sep 17 00:00:00 2001 From: VirtualTam Date: Tue, 26 Jun 2018 22:18:51 +0200 Subject: Fix broken documentation links and list formatting Signed-off-by: VirtualTam --- doc/md/REST-API.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'doc/md/REST-API.md') diff --git a/doc/md/REST-API.md b/doc/md/REST-API.md index 68a83c00..c016de56 100644 --- a/doc/md/REST-API.md +++ b/doc/md/REST-API.md @@ -3,8 +3,9 @@ See the [REST API documentation](http://shaarli.github.io/api-documentation/) for a list of available endpoints and parameters. -Please ensure that your server meets the [requirements](Server-requirements) -and is properly [configured](Server-configuration): +Please ensure that your server meets the +[requirements](Server-configuration#prerequisites) and is properly +[configured](Server-configuration): - URL rewriting is enabled (see specific Apache and Nginx sections) - the server's timezone is properly defined -- cgit v1.2.3 From 40f0ff2236a92e2f2fb1631d1ffe62c56d5425ed Mon Sep 17 00:00:00 2001 From: ArthurHoaro 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(+) (limited to 'doc/md/REST-API.md') 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