summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2014-04-16 07:22:15 -0400
committerTim Graham <timograham@gmail.com>2014-04-16 07:30:50 -0400
commita476b15aa594f9b63d2ff32c65783f50dc47c63e (patch)
tree76cd855849234947a5855f1dda2a4338ad5d15b1
parent724ccd2ec15af78263adfc970ec9fb1f0597002b (diff)
[1.6.x] Added RemoteUserMiddleware to middleware reference page.
Backport of 465980d070a33555cdabb4787db50a4e23228de2 from master.
-rw-r--r--docs/howto/auth-remote-user.txt8
-rw-r--r--docs/ref/middleware.txt5
2 files changed, 8 insertions, 5 deletions
diff --git a/docs/howto/auth-remote-user.txt b/docs/howto/auth-remote-user.txt
index 09ae92822b..7daf455943 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 7aac286c2d..3b324fe37f 100644
--- a/docs/ref/middleware.txt
+++ b/docs/ref/middleware.txt
@@ -185,6 +185,11 @@ Adds the ``user`` attribute, representing the currently-logged-in user, to
every incoming ``HttpRequest`` object. See :ref:`Authentication in Web requests
<auth-web-requests>`.
+.. class:: RemoteUserMiddleware
+
+Middleware for utilizing Web server provided authentication. See
+:doc:`/howto/auth-remote-user` for usage details.
+
CSRF protection middleware
--------------------------