From 72ebe7df58313b2dfe861f3557ae44e280d48374 Mon Sep 17 00:00:00 2001 From: Simon Taddiken Date: Tue, 2 Mar 2021 10:21:50 +0100 Subject: [PATCH] Improve documentation --- docs/configuration.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/configuration.rst b/docs/configuration.rst index d182d589d..7ffab20d7 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -193,10 +193,10 @@ PAPERLESS_ENABLE_HTTP_REMOTE_USER= Defaults to `false` which disables this feature. -PAPERLESS_HTTP_REMOTE_USER_HEADER_NAME= +PAPERLESS_HTTP_REMOTE_USER_HEADER_NAME= 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.