Skip to content
Newer
Older
100644 84 lines (61 sloc) 1.99 KB
1db8e26 @pennersr Added a bit of README
authored Oct 13, 2010
1 ==============
2 Django AllAuth
3 ==============
e01d8f3 @pennersr Initial commit
authored Oct 13, 2010
4
1db8e26 @pennersr Added a bit of README
authored Oct 13, 2010
5 Integrated set of Django applications addressing authentication,
6 registration, account management as well as 3rd party (social) account
7 authentication.
8
ed8e735 @pennersr Documented available settings
authored Oct 16, 2010
9 Installation
10 ============
1db8e26 @pennersr Added a bit of README
authored Oct 13, 2010
11
12 Django
13 ------
14
21d1b09 @pennersr Preparing for first pypi release
authored Feb 12, 2011
15 settings.py::
1db8e26 @pennersr Added a bit of README
authored Oct 13, 2010
16
17 TEMPLATE_CONTEXT_PROCESSORS = (
18 ...
19 "allauth.account.context_processors.account"
20 )
912bfc2 added auth_backend setting to readme to get email login to work
ebaum authored Feb 9, 2011
21
695909e removed extra space from readme
ebaum authored Feb 10, 2011
22 AUTHENTICATION_BACKENDS = (
912bfc2 added auth_backend setting to readme to get email login to work
ebaum authored Feb 9, 2011
23 ...
24 "allauth.account.auth_backends.AuthenticationBackend",
25 )
26
1db8e26 @pennersr Added a bit of README
authored Oct 13, 2010
27 INSTALLED_APPS = (
1a6086b @pennersr Added uni_form, emailconfirmation as dependencies
authored Oct 18, 2010
28 ...
29 'emailconfirmation',
30 'uni_form',
31
1db8e26 @pennersr Added a bit of README
authored Oct 13, 2010
32 'allauth',
33 'allauth.account',
34 'allauth.socialaccount',
35 'allauth.twitter',
36 'allauth.openid',
37 'allauth.facebook',
38
21d1b09 @pennersr Preparing for first pypi release
authored Feb 12, 2011
39 urls.py::
1db8e26 @pennersr Added a bit of README
authored Oct 13, 2010
40
41 urlpatterns = patterns('',
42 ...
43 (r'^accounts/', include('allauth.urls')))
44
45
ed8e735 @pennersr Documented available settings
authored Oct 16, 2010
46 Configuration
47 =============
48
49 Available settings:
50
51 ACCOUNT_EMAIL_REQUIRED (=False)
52 The user is required to hand over an e-mail address when signing up
53
54 ACCOUNT_EMAIL_VERIFICATION (=False)
55 After signing up, keep the user account inactive until the e-mail
56 address is verified
57
58 ACCOUNT_EMAIL_AUTHENTICATION (=False)
59 Login by e-mail address, not username
60
61 ACCOUNT_UNIQUE_EMAIL (=True)
62 Enforce uniqueness of e-mail addresses
63
64 SOCIALACCOUNT_QUERY_EMAIL (=ACCOUNT_EMAIL_REQUIRED)
65 Request e-mail address from 3rd party account provider? E.g. using
66 OpenID AX, or the Facebook "email" permission
67
68 SOCIALACCOUNT_AUTO_SIGNUP (=True)
69 Attempt to bypass the signup form by using fields (e.g. username,
70 email) retrieved from the social account provider. If a conflict
71 arises due to a duplicate e-mail address the signup form will still
72 kick in.
73
21d1b09 @pennersr Preparing for first pypi release
authored Feb 12, 2011
74 EMAIL_CONFIRMATION_DAYS (=# of days, no default)
75 Determines the expiration date of email confirmation mails sent by
76 django-email-confirmation.
ed8e735 @pennersr Documented available settings
authored Oct 16, 2010
77
1db8e26 @pennersr Added a bit of README
authored Oct 13, 2010
78 Facebook & Twitter
79 ------------------
80
81 The required keys and secrets for interacting with Facebook and
82 Twitter are to be configured in the database via the Django admin
83 using the TwitterApp and FacebookApp models.
Something went wrong with that request. Please try again.