X-Git-Url: https://git.mdrn.pl/django-cas-provider.git/blobdiff_plain/c4e951ccbda6275dd5134a431af7e0ee8f129feb..8c0324bfebcfa820c2f8d0955430cddedaa23e8a:/README.rst diff --git a/README.rst b/README.rst index 0677574..1cc428b 100644 --- a/README.rst +++ b/README.rst @@ -9,30 +9,22 @@ Chris Williams OVERVIEW ========= -django-cas-provider is a provider for the `Central Authentication -Service `_. It supports CAS version 1.0. 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 `_ -and `Single Sign-On on Wikipedia `_. +django-cas-provider is a provider for the `Central Authentication Service `_. 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 `_ and `Single Sign-On on Wikipedia `_. INSTALLATION ============= -To install, run the following command from this directory: +To install, run the following command from this directory:: - ``python setup.py install`` + python setup.py install -Or, put cas_provider somewhere on your Python path. +Or, put `cas_provider` somewhere on your Python path. USAGE ====== #. Add ``'cas_provider'`` to your ``INSTALLED_APPS`` tuple in *settings.py*. #. In *settings.py*, set ``LOGIN_URL`` to ``'/cas/login/'`` and ``LOGOUT_URL`` to ``'/cas/logout/'`` - before they expire. Default: 5 minutes -#. In *urls.py*, put the following line: - ``(r'^cas/', include('cas_provider.urls')),`` +#. In *urls.py*, put the following line: ``(r'^cas/', include('cas_provider.urls')),`` #. Create login/logout templates (or modify the samples)