Add email authentication backend note to the documentation

2012-01-26 23:13:13 -04:00
parent 485573c5d6
commit 4737b393b5
1 changed files with 3 additions and 1 deletions
--- a/docs/settings.rst
+++ b/docs/settings.rst
@@ -330,7 +330,9 @@ Common
    
    Default: ``username`` 
    
-    Controls the mechanism used to authenticated user. Options are: ``username``, ``email``    
+    Controls the mechanism used to authenticated user. Options are: ``username``, ``email``
+    If using the ``email`` login method a proper email authentication backend must used
+    such as AUTHENTICATION_BACKENDS = ('common.auth.email_auth_backend.EmailAuthBackend',)


 .. data:: COMMON_ALLOW_ANONYMOUS_ACCESS