From 230b503b7a9af23402b382c70ddbd208625f5560 Mon Sep 17 00:00:00 2001 From: esljaz <60260824+esljaz@users.noreply.github.com> Date: Mon, 14 Dec 2020 20:03:13 +0100 Subject: [PATCH] Clarify REMOTE_AUTH_HEADER documentation (#5430) --- docs/configuration/optional-settings.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/optional-settings.md b/docs/configuration/optional-settings.md index eb6022226..fe43f0483 100644 --- a/docs/configuration/optional-settings.md +++ b/docs/configuration/optional-settings.md @@ -460,7 +460,7 @@ NetBox can be configured to support remote user authentication by inferring user Default: `'HTTP_REMOTE_USER'` -When remote user authentication is in use, this is the name of the HTTP header which informs NetBox of the currently authenticated user. (Requires `REMOTE_AUTH_ENABLED`.) +When remote user authentication is in use, this is the name of the HTTP header which informs NetBox of the currently authenticated user. For example, to use the request header `X-Remote-User` it needs to be set to `HTTP_X_REMOTE_USER`. (Requires `REMOTE_AUTH_ENABLED`.) ---