Permalink
Browse files

Fixed code licence, apps names where incorrect. Updated documentation

  • Loading branch information...
1 parent 258144a commit f342bd6f232520ec66976c45740b966547d220bf @omab committed Nov 9, 2010
Showing with 105 additions and 35 deletions.
  1. 0 COPYRIGHT.Django-Socialauth → COPYRIGHT.django-twitter-oauth
  2. +105 −35 README.rst
View
0 COPYRIGHT.Django-Socialauth → COPYRIGHT.django-twitter-oauth
File renamed without changes.
View
140 README.rst
@@ -1,54 +1,124 @@
+==================
Django Social Auth
==================
-1. Description
---------------
-Basically this is a code merge between:
- * Django-Socialauth (https://github.com/uswaretech/Django-Socialauth)
- * django-twitter-oauth (https://github.com/henriklied/django-twitter-oauth)
-the app supplies two views that controls OAuth and OpenID loggin/registration.
+Django Social Auth is an easy to setup social authentication/registration
+mechanism for Django projects.
-2. OAuth
------------
-Twitter and Facebook Oauth mechanims for authentication/registration,
-corresponding apps and settings must be filled:
-
- - Twitter
- * Register a new app at http://twitter.com/apps/new
- * Be sure to mark the "Yes, use Twitter for login" checkbox
- * Fill "Cosumer Key" and "Consumer Secret" values in settings
- TWITTER_CONSUMER_KEY
- TWITTER_CONSUMER_SECRET
- Twitter demands a redirect url configuration and will force the user
- to that address when redirecting, I suggest to setup something like
- http://myvirtualapp.com and then configuring myvirtualapp.com in
- /etc/hosts file, the port will be missing but works well for testing.
-
- - Facebook
- * Register a new app at http://developers.facebook.com/setup/
- * Fill "App Id" and "App Secret" values in settings:
- FACEBOOK_APP_ID
- FACEBOOK_API_SECRET
-
-3. OpenId
+Crafted using base code from django-twitter-oauth_ and django-openid-auth_,
+implements a common interface to define new authentication providers from
+third parties.
+
+.. _django-twitter-oauth: https://github.com/henriklied/django-twitter-oauth
+.. _django-openid-auth: https://launchpad.net/django-openid-auth
+
+#. Dependencies
+---------------
+ * OpenId support depends on python-openid_
+ * Twitter and Facebook support demands an application registration
+ on their corresponding sites.
+
+.. _python-openid: http://pypi.python.org/pypi/python-openid/
+
+#. Installation
+---------------
+
+#. Add social_auth app to your PYTHONPATH
+
+#. Add social_auth application to your installed apps::
+ INSTALLED_APPS = (
+ ...
+ 'social_auth'
+ )
+
+#. Add desired authentication backends to AUTHENTICATION_BACKENDS setting::
+ AUTHENTICATION_BACKENDS = (
+ 'social_auth.backends.TwitterOAuthBackend',
+ 'social_auth.backends.FacebookOAuthBackend',
+ 'social_auth.backends.OpenIDBackend',
+ 'django.contrib.auth.backends.ModelBackend',
+ )
+
+#. Setup Twitter and Facebook keys (see below)::
+ TWITTER_CONSUMER_KEY = ''
+ TWITTER_CONSUMER_SECRET = ''
+ FACEBOOK_APP_ID = ''
+ FACEBOOK_API_SECRET = ''
+
+#. Setup login urls::
+ LOGIN_URL = '/login-form/'
+ LOGIN_REDIRECT_URL = '/logged-in/'
+
+ Check docs at LOGIN_URL_ and LOGIN_REDIRECT_URL_.
+
+.. _LOGIN_URL: http://docs.djangoproject.com/en/dev/ref/settings/?from=olddocs#login-url
+.. _LOGIN_REDIRECT_URL: http://docs.djangoproject.com/en/dev/ref/settings/?from=olddocs#login-redirect-url
+
+#. Sync database to create needed models::
+ ./manage syncdb
+
+#. OpenId
---------
-Yahoo and Google OpenId providers are supported, also custom providers
-like myopenid.com are supported if provider url is specified by a POST
-parameter (openid_identifier).
+OpenId support is simpler to implement than OAuth, by Google and Yahoo
+providers are supported by default, others are supported by POST method
+providing endpoint Url.
+
+#. OAuth
+--------
+OAuth communication demands a set of keys exchange to validate the client
+authenticity prior to user approbation, Twitter and Facebook facilitates these
+keys by application registration.
+
+#. Twitter
+----------
+Twitter offers per application keys named "Consumer Key" and
+"Consumer Secret". To enable Twitter these two keys are needed.
+Further documentation at `Twitter development resources`_
+ * Register a new app at `Twitter App Creation`_,
+ * mark the "Yes, use Twitter for login" checkbox, and
+ * fill "Consumer Key" and "Consumer Secret" settings::
+ TWITTER_CONSUMER_KEY
+ TWITTER_CONSUMER_SECRET
+
+Twitter demands a redirect url configuration and will force the user
+to that address when redirecting, and http://127.0.0.1:8000 won't
+work. As a development hack, I suggest to setup something like
+http://myvirtualapp.com and adding an entry in /etc/hosts for that
+address pointing to localhost, port will be missed, but will do the
+trick for testing.
+
+If you cannot resit the missing port issue, play a bit with dnsmasq_.
+
+.. _Twitter development resources: http://dev.twitter.com/pages/auth
+.. _Twitter App Creation: http://twitter.com/apps/new
+.. _dnsmasq: http://www.thekelleys.org.uk/dnsmasq/doc.html
+
+#. Facebook
+-----------
+Facebook works similar to Twitter but it's simpler to setup and
+redirect url is passed as a parameter when issuing an authorization.
+Further documentation at `Facebook development resources`_
+ * Register a new app at `Facebook App Creation`_, and
+ * fill "App Id" and "App Secret" values in settings::
+ FACEBOOK_APP_ID
+ FACEBOOK_API_SECRET
+
+.. _Facebook development resources: http://developers.facebook.com/docs/authentication/
+.. _Facebook App Creation: http://developers.facebook.com/setup/
-4. Bugs
+#. Bugs
-------
Several, maybe, please report :-)
5. Copyrights
-------------
Base work is copyrighted by:
-Oauth base code:
+django-twitter-oauth:
Original Copyright goes to Henrik Lied (henriklied)
Code borrowed from https://github.com/henriklied/django-twitter-oauth
-OpenId base code:
+django-openid-auth:
django-openid-auth - OpenID integration for django.contrib.auth
Copyright (C) 2007 Simon Willison
Copyright (C) 2008-2010 Canonical Ltd.

0 comments on commit f342bd6

Please sign in to comment.