2568ad054855c712b25c408d731d1f0f48db43d9
[django-cas-provider.git] / README
1 django-cas-provider
2 Chris Williams <chris@nitron.org>
3
4 OVERVIEW:
5         django-cas-provider is a provider for the Central Authentication 
6 Service (http://jasig.org/cas). It allows remote services to authenticate 
7 users for the purposes of Single Sign-On (SSO). For example, a user logs into
8 a CAS server (provided by django-cas-provider) and can then access other
9 services (such as email, calendar, etc) without re-entering her password for
10 each service. For more details, see http://www.ja-sig.org/wiki/display/CAS/Home
11 and http://en.wikipedia.org/wiki/Single_Sign_On
12
13 INSTALLATION:
14         To install, run the following command from this directory:
15
16                 python setup.py install
17
18         Or, put cas_provider somewhere on your Python path.
19         
20 USAGE:
21         *) Add 'cas_provider' to your INSTALLED_APPS tuple in settings.py.
22         *) In settings.py, set LOGIN_URL to '/cas/login/' and LOGOUT_URL to '/cas/logout/'
23                 before they expire. Default: 5 minutes
24         *) In urls.py, put the following line:
25             (r'^cas/', include('cas_provider.urls')),
26         *) Create login/logout templates (templates/cas/login.html and templates/cas/logout.html).
27