README.rst

   1 ===================
   2 django-cas-provider
   3 ===================
   4
   5 ---------------------------------
   6 Chris Williams <chris@nitron.org>
   7 ---------------------------------
   8
   9 OVERVIEW
  10 =========
  11
  12 django-cas-provider is a provider for the `Central Authentication
  13 Service <http://jasig.org/cas>`_. It supports CAS version 1.0. It allows
  14 remote services to authenticate users for the purposes of
  15 Single Sign-On (SSO). For example, a user logs into a CAS server
  16 (provided by django-cas-provider) and can then access other services
  17 (such as email, calendar, etc) without re-entering her password for
  18 each service. For more details, see the `CAS wiki <http://www.ja-sig.org/wiki/display/CAS/Home>`_
  19 and `Single Sign-On on Wikipedia <http://en.wikipedia.org/wiki/Single_Sign_On>`_.
  20
  21 INSTALLATION
  22 =============
  23
  24 To install, run the following command from this directory:
  25
  26         ``python setup.py install``
  27
  28 Or, put cas_provider somewhere on your Python path.
  29
  30 USAGE
  31 ======
  32
  33 #. Add ``'cas_provider'`` to your ``INSTALLED_APPS`` tuple in *settings.py*.
  34 #. In *settings.py*, set ``LOGIN_URL`` to ``'/cas/login/'`` and ``LOGOUT_URL`` to ``'/cas/logout/'``
  35 #. In *urls.py*, put the following line: ``(r'^cas/', include('cas_provider.urls')),``
  36 #. Create login/logout templates (or modify the samples)
  37 #. Use 'cleanuptickets' management command to clean up expired tickets
  38
  39 SETTINGS
  40 =========
  41
  42 CAS_TICKET_EXPIRATION - minutes to tickets expiration (default is 5 minutes)
  43