summaryrefslogtreecommitdiff
path: root/docs
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:22:15 -0400
commit465980d070a33555cdabb4787db50a4e23228de2 (patch)
tree4e9d3a8354cb845544c6ab90d7afd5c823a4d4ce /docs
parent4e3d8ae61055dbb83d193585f2f36af6537b31cc (diff)
Added RemoteUserMiddleware to middleware reference page.
Diffstat (limited to 'docs')
-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 f7a6768d3c..50f23fff31 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
<auth-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