Improve documentation

This commit is contained in:
Simon Taddiken 2021-03-02 10:21:50 +01:00
parent 97f3c214e8
commit 72ebe7df58

View File

@ -193,10 +193,10 @@ PAPERLESS_ENABLE_HTTP_REMOTE_USER=<bool>
Defaults to `false` which disables this feature.
PAPERLESS_HTTP_REMOTE_USER_HEADER_NAME=<strl>
PAPERLESS_HTTP_REMOTE_USER_HEADER_NAME=<str>
If `PAPERLESS_ENABLE_HTTP_REMOTE_USER` is enabled, this property allows to
customize the name of the HTTP header from which the username is extracted.
Values are in terms of
customize the name of the HTTP header from which the authenticated username
is extracted. Values are in terms of
[HttpRequest.META](https://docs.djangoproject.com/en/3.1/ref/request-response/#django.http.HttpRequest.META).
Thus, the configured value must start with `HTTP_` followed by the
normalized actual header name.