README.rst

Django Gaeauth

An Django authentication backend for using the Google App Engine Users and Oauth API for user login/logout.

It only works on Google App Engine and you will also need the Djangoappengine backend for Django-Nonrel.

Installation

• get the code:

  git clone https://fhahn@github.com/fhahn/django-gaeauth.git

• add gaeauth.backends.GoogleAccountBackend to your AUTHENTICATION_BACKENDS and gaeauth to your INSTALLED_APPS

  settings.py:

  AUTHENTICATION_BACKENDS = (
        ...
        'gaeauth.backends.GoogleAccountBackend',
  )
  
  INSTALLED_APPS = (
        ...
        'gaeauth',
  )
  

• include gaeauth.urls in your urlconf to login, logout and authenticate

  urls.py:

  urlpatterns = patterns('',
       ...
       (r'^accounts/', include('gaeauth.urls')),
  )
  

Now you can use /accounts/login/ to use Google Accounts for login and /accounts/logout/ to log out.

Urls

Django-gaeauth provides following named urls:

google_login

displays the Google login form

google_logout

logout the user using the Google App Engine Users API

google_authenticate

authenticates the user using the Google App Engine Users API

Settings

Available settings:

ALLOWED_USERS

Limit access to a list of usernames

e.g. with ALLOWD_USERS = ('bar@foo.com',) only the user with username bar@foo.com can sign in

ALLOWED_DOMAINS

Limit access to a list of domains

e.g. with ALLOWED_DOMAINS = ('foo.com',) only users with @foo.com email adresses can sign in