Improve documentation

This commit is contained in:
Simon Taddiken 2021-03-02 10:21:50 +01:00
parent 7ab5dbdee8
commit c84446d7fd

View File

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