Can't have ForeignKey from PGT to ST, if ST is deleted immediately.

[django-cas-provider.git] / README.rst

diff --git a/README.rst b/README.rst
index 9e922c6..d7bed27 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -5,7 +5,7 @@ django-cas-provider
 OVERVIEW
 =========
 
 OVERVIEW
 =========
 

-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 
+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

 (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>`_.
 
 INSTALLATION
 (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>`_.
 
 INSTALLATION


@@ -19,7 +19,6 @@ Or, put `cas_provider` somewhere on your Python path.
 
 If you want use CAS v.2 protocol or above, you must install `lxml` package to correct work.
 
 
 If you want use CAS v.2 protocol or above, you must install `lxml` package to correct work.
 

-       

 USAGE
 ======
 
 USAGE
 ======
 


@@ -34,7 +33,7 @@ SETTINGS
 
 CAS_TICKET_EXPIRATION - minutes to tickets expiration. Default is 5 minutes.
 
 
 CAS_TICKET_EXPIRATION - minutes to tickets expiration. Default is 5 minutes.
 

-CAS_CUSTOM_ATTRIBUTES_CALLBACK - name of callback to provide dictionary with 
+CAS_CUSTOM_ATTRIBUTES_CALLBACK - name of callback to provide dictionary with

 extended user attributes (may be used in CAS v.2 or above). Default is None.
 
 CAS_CUSTOM_ATTRIBUTES_FORMAT - name of custom attribute formatter callback will be
 extended user attributes (may be used in CAS v.2 or above). Default is None.
 
 CAS_CUSTOM_ATTRIBUTES_FORMAT - name of custom attribute formatter callback will be


@@ -42,6 +41,10 @@ used to format custom user attributes. This package provide module `attribute_fo
 with formatters for common used formats. Available formats styles are `RubyCAS`, `Jasig`
 and `Name-Value. Default is Jasig style. See module source code for more details.
 
 with formatters for common used formats. Available formats styles are `RubyCAS`, `Jasig`
 and `Name-Value. Default is Jasig style. See module source code for more details.
 

+CAS_AUTO_REDIRECT_AFTER_LOGOUT - If False (default behavior, specified in CAS protocol)
+after successful logout notification page will be shown. If it's True, after successful logout will
+be auto redirect back to service without any notification.
+

 
 PROTOCOL DOCUMENTATION
 =====================
 
 PROTOCOL DOCUMENTATION
 =====================


@@ -64,18 +67,18 @@ It has not required arguments.
 Optional arguments:
 
 * template_name - login form template name (default is 'cas/login.html')
 Optional arguments:
 
 * template_name - login form template name (default is 'cas/login.html')

-* success_redirect - redirect after successful login if service GET argument is not provided 
+* success_redirect - redirect after successful login if service GET argument is not provided

    (default is settings.LOGIN_REDIRECT_URL)
 * warn_template_name - warning page template name to allow login user to service if he
   already authenticated in SSO (default is 'cas/warn.html')
 
    (default is settings.LOGIN_REDIRECT_URL)
 * warn_template_name - warning page template name to allow login user to service if he
   already authenticated in SSO (default is 'cas/warn.html')
 

-If request.GET has 'warn' argument and user has already authenticated in SSO it shows 
+If request.GET has 'warn' argument and user has already authenticated in SSO it shows

 warning message instead of generate Service Ticket and redirect.
 
 logout
 -----------
 
 warning message instead of generate Service Ticket and redirect.
 
 logout
 -----------
 

-This destroys a client's single sign-on CAS session. The ticket-granting cookie is destroyed, 
+This destroys a client's single sign-on CAS session. The ticket-granting cookie is destroyed,

 and subsequent requests to login view will not obtain service tickets until the user again
 presents primary credentials (and thereby establishes a new single sign-on session).
 
 and subsequent requests to login view will not obtain service tickets until the user again
 presents primary credentials (and thereby establishes a new single sign-on session).
 


@@ -91,7 +94,7 @@ validate
 It checks the validity of a service ticket. It is part of the CAS 1.0 protocol and thus does
 not handle proxy authentication.
 
 It checks the validity of a service ticket. It is part of the CAS 1.0 protocol and thus does
 not handle proxy authentication.
 

-It has not arguments. 
+It has not arguments.

 
 service_validate
 -------------------------
 
 service_validate
 -------------------------