From cb7ee25462f1f6862c19ea88c29df9b0f97bba37 Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Wed, 16 Apr 2014 07:22:15 -0400 Subject: [PATCH] [1.7.x] Added RemoteUserMiddleware to middleware reference page. Backport of 465980d070 from master --- docs/howto/auth-remote-user.txt | 8 +++----- docs/ref/middleware.txt | 5 +++++ 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/howto/auth-remote-user.txt b/docs/howto/auth-remote-user.txt index 09ae92822b1..7daf4559432 100644 --- a/docs/howto/auth-remote-user.txt +++ b/docs/howto/auth-remote-user.txt @@ -27,19 +27,17 @@ use of the ``REMOTE_USER`` value using the ``RemoteUserMiddleware`` and Configuration ============= -.. class:: django.contrib.auth.middleware.RemoteUserMiddleware - First, you must add the :class:`django.contrib.auth.middleware.RemoteUserMiddleware` to the :setting:`MIDDLEWARE_CLASSES` setting **after** the :class:`django.contrib.auth.middleware.AuthenticationMiddleware`:: MIDDLEWARE_CLASSES = ( - ... + '...', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.auth.middleware.RemoteUserMiddleware', - ... - ) + '...', + ) Next, you must replace the :class:`~django.contrib.auth.backends.ModelBackend` with ``RemoteUserBackend`` in the :setting:`AUTHENTICATION_BACKENDS` setting:: diff --git a/docs/ref/middleware.txt b/docs/ref/middleware.txt index 08527e0dd39..6a8ac6dde76 100644 --- a/docs/ref/middleware.txt +++ b/docs/ref/middleware.txt @@ -204,6 +204,11 @@ Adds the ``user`` attribute, representing the currently-logged-in user, to every incoming ``HttpRequest`` object. See :ref:`Authentication in Web requests `. +.. class:: RemoteUserMiddleware + +Middleware for utilizing Web server provided authentication. See +:doc:`/howto/auth-remote-user` for usage details. + .. class:: SessionAuthenticationMiddleware .. versionadded:: 1.7