diff options
| author | Joonas Häkkinen <joonashak@proton.me> | 2025-02-19 14:36:06 +0200 |
|---|---|---|
| committer | Sarah Boyce <42296566+sarahboyce@users.noreply.github.com> | 2025-02-20 16:16:29 +0100 |
| commit | 914cde19c230314864c018fecb2ce09e38a34903 (patch) | |
| tree | 3f23596fa5e957b7b8fbc6eba9f0535aec8e0f1b | |
| parent | f8b72f8547ca2c490f553584ec59f61c92221712 (diff) | |
[5.1.x] Fixed #36200 -- Clarified MIDDLEWARE setting updates when using a custom RemoteUserMiddleware.
Backport of 87c5de3b7f2316aa17353d74f54e6ff19013d049 from main.
| -rw-r--r-- | docs/howto/auth-remote-user.txt | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/docs/howto/auth-remote-user.txt b/docs/howto/auth-remote-user.txt index f8492e367a..254a141b45 100644 --- a/docs/howto/auth-remote-user.txt +++ b/docs/howto/auth-remote-user.txt @@ -76,14 +76,27 @@ regardless of ``AUTHENTICATION_BACKENDS``. If your authentication mechanism uses a custom HTTP header and not ``REMOTE_USER``, you can subclass ``RemoteUserMiddleware`` and set the -``header`` attribute to the desired ``request.META`` key. For example:: +``header`` attribute to the desired ``request.META`` key. For example: + +.. code-block:: python + :caption: ``mysite/middleware.py`` from django.contrib.auth.middleware import RemoteUserMiddleware - class CustomHeaderMiddleware(RemoteUserMiddleware): + class CustomHeaderRemoteUserMiddleware(RemoteUserMiddleware): header = "HTTP_AUTHUSER" +This custom middleware is then used in the :setting:`MIDDLEWARE` setting +instead of :class:`django.contrib.auth.middleware.RemoteUserMiddleware`:: + + MIDDLEWARE = [ + "...", + "django.contrib.auth.middleware.AuthenticationMiddleware", + "mysite.middleware.CustomHeaderRemoteUserMiddleware", + "...", + ] + .. warning:: Be very careful if using a ``RemoteUserMiddleware`` subclass with a custom |
