Commit 11ded967 authored by Preston Holmes's avatar Preston Holmes
Browse files

Fixed #19498 -- refactored auth documentation 

The auth doc was a single page which had grown unwieldy.
This refactor split and grouped the content into sub-topics.
Additional corrections and cleanups were made along the way.
parent db278c3b

docs/howto/deployment/wsgi/apache-auth.txt

+1 −1
Original line number Diff line number Diff line
@@ -4,7 +4,7 @@ Authenticating against Django's user database from Apache 


Since keeping multiple authentication databases in sync is a common problem when

dealing with Apache, you can configure Apache to authenticate against Django's

:doc:`authentication system </topics/auth>` directly. This requires Apache

:doc:`authentication system </topics/auth/index>` directly. This requires Apache

version >= 2.2 and mod_wsgi >= 2.0. For example, you could:



* Serve static/media files directly from Apache only to authenticated users.

docs/index.txt

+1 −1
Original line number Diff line number Diff line
@@ -246,7 +246,7 @@ Common Web application tools 
Django offers multiple tools commonly needed in the development of Web

applications:



* :doc:`Authentication <topics/auth>`

* :doc:`Authentication <topics/auth/index>`

* :doc:`Caching <topics/cache>`

* :doc:`Logging <topics/logging>`

* :doc:`Sending emails <topics/email>`

docs/internals/git.txt

+1 −1
Original line number Diff line number Diff line
@@ -134,7 +134,7 @@ part of Django itself, and so are no longer separately maintained: 
  of Django since the 0.95 release.



* ``multi-auth``: A refactoring of :doc:`Django's bundled

  authentication framework </topics/auth>` which added support for

  authentication framework </topics/auth/index>` which added support for

  :ref:`authentication backends <authentication-backends>`. This has

  been part of Django since the 0.95 release.

docs/misc/api-stability.txt

+1 −1
Original line number Diff line number Diff line
@@ -38,7 +38,7 @@ In general, everything covered in the documentation -- with the exception of 
anything in the :doc:`internals area </internals/index>` is considered stable as

of 1.0. This includes these APIs:



- :doc:`Authorization </topics/auth>`

- :doc:`Authorization </topics/auth/index>`



- :doc:`Caching </topics/cache>`.

docs/ref/authbackends.txt

deleted100644 → 0
+0 −33
Original line number Diff line number Diff line 
=======================

Authentication backends

=======================



.. module:: django.contrib.auth.backends

   :synopsis: Django's built-in authentication backend classes.



This document details the authentication backends that come with Django. For

information on how to use them and how to write your own authentication

backends, see the :ref:`Other authentication sources section

<authentication-backends>` of the :doc:`User authentication guide

</topics/auth>`.





Available authentication backends

=================================



The following backends are available in :mod:`django.contrib.auth.backends`:



.. class:: ModelBackend



    This is the default authentication backend used by Django.  It

    authenticates using usernames and passwords stored in the

    :class:`~django.contrib.auth.models.User` model.





.. class:: RemoteUserBackend



    Use this backend to take advantage of external-to-Django-handled

    authentication.  It authenticates using usernames passed in

    :attr:`request.META['REMOTE_USER'] <django.http.HttpRequest.META>`.  See

    the :doc:`Authenticating against REMOTE_USER </howto/auth-remote-user>`

    documentation.