Skip to content

Commit d6e392a

Browse files
authored
Merge pull request shaarli#1181 from ArthurHoaro/docs/api-debug
Documentation - REST API - Mention dev.debug mode
2 parents 5d32c50 + 40f0ff2 commit d6e392a

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

doc/md/REST-API.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,3 +152,22 @@ See the reference API client:
152152

153153
- [Documentation](http://python-shaarli-client.readthedocs.io/en/latest/) on ReadTheDocs
154154
- [python-shaarli-client](https://github.com/shaarli/python-shaarli-client) on Github
155+
156+
## Troubleshooting
157+
158+
### Debug mode
159+
160+
> This should never be used in a production environment.
161+
162+
For security reasons, authentication issues will always return an `HTTP 401` error code without any detail.
163+
164+
It is possible to enable the debug mode in `config.json.php`
165+
to get the actual error message in the HTTP response body with:
166+
167+
```json
168+
{
169+
"dev": {
170+
"debug": true
171+
}
172+
}
173+
```

0 commit comments

Comments
 (0)