Commit 323f200a authored by Valentin Samir's avatar Valentin Samir

Add a TOC to README.rst

parent a1edd2f3
CAS Server CAS Server
========== ##########
.. image:: https://travis-ci.org/nitmir/django-cas-server.svg?branch=master .. image:: https://travis-ci.org/nitmir/django-cas-server.svg?branch=master
:target: https://travis-ci.org/nitmir/django-cas-server :target: https://travis-ci.org/nitmir/django-cas-server
...@@ -29,8 +29,10 @@ Note that for Django 1.7 compatibility, you need a version of ...@@ -29,8 +29,10 @@ Note that for Django 1.7 compatibility, you need a version of
`django-bootstrap3 <https://github.com/dyve/django-bootstrap3>`__ < 7.0.0 `django-bootstrap3 <https://github.com/dyve/django-bootstrap3>`__ < 7.0.0
like the 6.2.2 version. like the 6.2.2 version.
.. contents:: Table of Contents
Features Features
-------- ========
* Support CAS version 1.0, 2.0, 3.0 * Support CAS version 1.0, 2.0, 3.0
* Support Single Sign Out * Support Single Sign Out
...@@ -42,7 +44,7 @@ Features ...@@ -42,7 +44,7 @@ Features
* Supports Python 2.7, 3.x * Supports Python 2.7, 3.x
Quick start Quick start
----------- ===========
1. If you want to make a virtualenv for ``django-cas-server``, you will need the following 1. If you want to make a virtualenv for ``django-cas-server``, you will need the following
dependencies on a bare debian like system:: dependencies on a bare debian like system::
...@@ -112,12 +114,13 @@ Quick start ...@@ -112,12 +114,13 @@ Quick start
Settings Settings
-------- ========
All settings are optional. Add them to ``settings.py`` to customize ``django-cas-server``: All settings are optional. Add them to ``settings.py`` to customize ``django-cas-server``:
Template settings: Template settings
-----------------
* ``CAS_LOGO_URL``: Url to the logo showed in the up left corner on the default * ``CAS_LOGO_URL``: Url to the logo showed in the up left corner on the default
templates. Set it to ``False`` to disable it. templates. Set it to ``False`` to disable it.
...@@ -135,7 +138,8 @@ Template settings: ...@@ -135,7 +138,8 @@ Template settings:
logged out instead of displaying ``CAS_LOGOUT_TEMPLATE``. The default is ``False``. logged out instead of displaying ``CAS_LOGOUT_TEMPLATE``. The default is ``False``.
Authentication settings: Authentication settings
-----------------------
* ``CAS_AUTH_CLASS``: A dotted path to a class or a class implementing * ``CAS_AUTH_CLASS``: A dotted path to a class or a class implementing
``cas_server.auth.AuthUser``. The default is ``"cas_server.auth.DjangoAuthUser"`` ``cas_server.auth.AuthUser``. The default is ``"cas_server.auth.DjangoAuthUser"``
...@@ -154,7 +158,8 @@ Authentication settings: ...@@ -154,7 +158,8 @@ Authentication settings:
If more requests need to be send, there are queued. The default is ``10``. If more requests need to be send, there are queued. The default is ``10``.
* ``CAS_SLO_TIMEOUT``: Timeout for a single SLO request in seconds. The default is ``5``. * ``CAS_SLO_TIMEOUT``: Timeout for a single SLO request in seconds. The default is ``5``.
Tickets validity settings: Tickets validity settings
-------------------------
* ``CAS_TICKET_VALIDITY``: Number of seconds the service tickets and proxy tickets are valid. * ``CAS_TICKET_VALIDITY``: Number of seconds the service tickets and proxy tickets are valid.
This is the maximal time between ticket issuance by the CAS and ticket validation by an This is the maximal time between ticket issuance by the CAS and ticket validation by an
...@@ -164,7 +169,8 @@ Tickets validity settings: ...@@ -164,7 +169,8 @@ Tickets validity settings:
* ``CAS_TICKET_TIMEOUT``: Number of seconds a ticket is kept in the database before sending * ``CAS_TICKET_TIMEOUT``: Number of seconds a ticket is kept in the database before sending
Single Log Out request and being cleared. The default is ``86400`` (24 hours). Single Log Out request and being cleared. The default is ``86400`` (24 hours).
Tickets miscellaneous settings: Tickets miscellaneous settings
------------------------------
* ``CAS_TICKET_LEN``: Default ticket length. All CAS implementation MUST support ST and PT * ``CAS_TICKET_LEN``: Default ticket length. All CAS implementation MUST support ST and PT
up to 32 chars, PGT and PGTIOU up to 64 chars and it is RECOMMENDED that all tickets up up to 32 chars, PGT and PGTIOU up to 64 chars and it is RECOMMENDED that all tickets up
...@@ -188,7 +194,9 @@ Tickets miscellaneous settings: ...@@ -188,7 +194,9 @@ Tickets miscellaneous settings:
* ``CAS_PROXY_GRANTING_TICKET_IOU_PREFIX``: Prefix of proxy granting ticket IOU. The default is ``"PGTIOU"``. * ``CAS_PROXY_GRANTING_TICKET_IOU_PREFIX``: Prefix of proxy granting ticket IOU. The default is ``"PGTIOU"``.
Mysql backend settings. Only usefull if you are using the mysql authentication backend: Mysql backend settings
----------------------
Only usefull if you are using the mysql authentication backend:
* ``CAS_SQL_HOST``: Host for the SQL server. The default is ``"localhost"``. * ``CAS_SQL_HOST``: Host for the SQL server. The default is ``"localhost"``.
* ``CAS_SQL_USERNAME``: Username for connecting to the SQL server. * ``CAS_SQL_USERNAME``: Username for connecting to the SQL server.
...@@ -214,7 +222,9 @@ Mysql backend settings. Only usefull if you are using the mysql authentication b ...@@ -214,7 +222,9 @@ Mysql backend settings. Only usefull if you are using the mysql authentication b
The default is ``"crypt"``. The default is ``"crypt"``.
Test backend settings. Only usefull if you are using the test authentication backend: Test backend settings
---------------------
Only usefull if you are using the test authentication backend:
* ``CAS_TEST_USER``: Username of the test user. The default is ``"test"``. * ``CAS_TEST_USER``: Username of the test user. The default is ``"test"``.
* ``CAS_TEST_PASSWORD``: Password of the test user. The default is ``"test"``. * ``CAS_TEST_PASSWORD``: Password of the test user. The default is ``"test"``.
...@@ -224,7 +234,7 @@ Test backend settings. Only usefull if you are using the test authentication bac ...@@ -224,7 +234,7 @@ Test backend settings. Only usefull if you are using the test authentication bac
Authentication backend Authentication backend
---------------------- ======================
``django-cas-server`` comes with some authentication backends: ``django-cas-server`` comes with some authentication backends:
...@@ -237,7 +247,7 @@ Authentication backend ...@@ -237,7 +247,7 @@ Authentication backend
The returned attributes are those return by sql query ``CAS_SQL_USER_QUERY``. The returned attributes are those return by sql query ``CAS_SQL_USER_QUERY``.
Logs Logs
---- ====
``django-cas-server`` logs most of its actions. To enable login, you must set the ``LOGGING`` ``django-cas-server`` logs most of its actions. To enable login, you must set the ``LOGGING``
(https://docs.djangoproject.com/en/stable/topics/logging) variable in ``settings.py``. (https://docs.djangoproject.com/en/stable/topics/logging) variable in ``settings.py``.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment