d197fbece2495fdb046e051b4e296f3508bba696
[cas.git] / provider / README.rst
1 ===================
2 django-cas-provider
3 ===================
4
5 OVERVIEW
6 =========
7
8 django-cas-provider is a provider for the `Central Authentication Service <http://jasig.org/cas>`_. It supports CAS version 1.0 and parts of CAS version 2.0 protocol. It allows remote services to authenticate users for the purposes of Single Sign-On (SSO). For example, a user logs into a CAS server 
9 (provided by django-cas-provider) and can then access other services (such as email, calendar, etc) without re-entering her password for each service. For more details, see the `CAS wiki <http://www.ja-sig.org/wiki/display/CAS/Home>`_ and `Single Sign-On on Wikipedia <http://en.wikipedia.org/wiki/Single_Sign_On>`_.
10
11 INSTALLATION
12 =============
13
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 ======
22
23 #. Add ``'cas_provider'`` to your ``INSTALLED_APPS`` tuple in *settings.py*.
24 #. In *settings.py*, set ``LOGIN_URL`` to ``'/cas/login/'`` and ``LOGOUT_URL`` to ``'/cas/logout/'``
25 #. In *urls.py*, put the following line: ``(r'^cas/', include('cas_provider.urls')),``
26 #. Create login/logout templates (or modify the samples)