Update README, add information about internatinalization
This commit is contained in:
		
							
								
								
									
										18
									
								
								README.rst
									
									
									
									
									
								
							
							
						
						
									
										18
									
								
								README.rst
									
									
									
									
									
								
							@@ -2,17 +2,18 @@
 | 
			
		||||
CAS Server
 | 
			
		||||
=====
 | 
			
		||||
 | 
			
		||||
CAS Server is a Django app implementing the CAS Protocol 3.0 Specification
 | 
			
		||||
(https://jasig.github.io/cas/development/protocol/CAS-Protocol-Specification.html)
 | 
			
		||||
CAS Server is a Django app implementing the `CAS Protocol 3.0 Specification
 | 
			
		||||
<https://jasig.github.io/cas/development/protocol/CAS-Protocol-Specification.html>`_.
 | 
			
		||||
 | 
			
		||||
By defaut, the authentication process use django internal users but you can easily
 | 
			
		||||
use any sources (see auth classes in the auth.py file)
 | 
			
		||||
 | 
			
		||||
The differents parametters you can use in settings.py to tweak the application
 | 
			
		||||
are listed in default_settings.py
 | 
			
		||||
 | 
			
		||||
The defaut login/logout template use django-bootstrap3 (https://github.com/dyve/django-bootstrap3)
 | 
			
		||||
The defaut login/logout template use `django-bootstrap3 <https://github.com/dyve/django-bootstrap3>`_
 | 
			
		||||
but you can use your own templates using the CAS_LOGIN_TEMPLATE,
 | 
			
		||||
CAS_LOGGED_TEMPLATE and CAS_WARN_TEMPLATE.
 | 
			
		||||
CAS_LOGGED_TEMPLATE and CAS_WARN_TEMPLATE setting variables.
 | 
			
		||||
 | 
			
		||||
Quick start
 | 
			
		||||
-----------
 | 
			
		||||
@@ -24,6 +25,15 @@ Quick start
 | 
			
		||||
        'cas_server',
 | 
			
		||||
    )
 | 
			
		||||
 | 
			
		||||
   For internatinalization support, add "django.middleware.locale.LocaleMiddleware"
 | 
			
		||||
   to your MIDDLEWARE_CLASSES setting like this::
 | 
			
		||||
 | 
			
		||||
    MIDDLEWARE_CLASSES = (
 | 
			
		||||
        ...
 | 
			
		||||
        'django.middleware.locale.LocaleMiddleware',
 | 
			
		||||
        ...
 | 
			
		||||
    )
 | 
			
		||||
 | 
			
		||||
2. Include the polls URLconf in your project urls.py like this::
 | 
			
		||||
 | 
			
		||||
    url(r'^cas/', include('cas_server.urls', namespace="cas_server")),
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user