Clarify REMOTE_AUTH_HEADER documentation

netbox-community · Dec 5, 2020 · 34f54a0 · 34f54a0
1 parent 55e8d37
commit 34f54a0
Showing 1 changed file with 1 addition and 1 deletion.
diff --git 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`.)
 
 ---