소스 검색

Clarify REMOTE_AUTH_HEADER documentation (#5430)

esljaz 5 년 전
부모
커밋
230b503b7a
1개의 변경된 파일1개의 추가작업 그리고 1개의 파일을 삭제
  1. 1 1
      docs/configuration/optional-settings.md

+ 1 - 1
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'`
 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`.)
 
 
 ---
 ---