entrouvert
/
authentic
16
0
Fork 0
Code Issues Pull Requests 32 Releases Activity

[doc] Aword on debug mode by default, statics and the debug toolbar. 

The DEBUG mode by default is a temporary choice to have the users
beginning with Authentic 2 and using the development server not be
disappointed by the static files not served.

The Django Debug Toolbar is a dependency in the DEBUG mode.
This commit is contained in:
Mikaël Ates 2012-04-12 23:29:51 +02:00
parent bd96987b19
commit cb002e6f4f
1 changed files with 30 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
doc/installation.rst
View File

@ -38,6 +38,13 @@ or easy_install::
easy_install django django-profiles django-authopenid south
In DEBUG mode (Default mode)
____________________________
* Django Debug Toolbar::
Download at https://github.com/django-debug-toolbar/django-debug-toolbar
Quick Start
-----------
@ -62,8 +69,8 @@ You should see the following output::
Specifying a different database
-------------------------------
This is done by modifying the DATABASES dictionary in your local_settings.py file
(create it in Authentic project directory); for example::
This is done by modifying the DATABASES dictionary in your local_settings.py
file (create it in Authentic project directory); for example::
DATABASES['default'] = {
'ENGINE': 'django.db.backends.postgresql',
@ -84,11 +91,30 @@ How to upgrade to a new version of authentic ?
Authentic store all its data in a relational database as specified in its
settings.py or local_settings.py file. So in order to upgrade to a new version
of authentic you have to update your database schema using the
migration command — you will need to have installed the dependency django-south,
see the beginning of this README file.::
migration command — you will need to have installed the dependency
django-south, see the beginning of this README file.::
python ./manage.py migrate
Then you will need to create new tables if there are.::
python ./manage.py syncdb
DEBUG Mode by default, static files and the Django debug toolbar dependency ?
-----------------------------------------------------------------------------
By default, Authentic 2 is in the DEBUG mode. As a matter of fact, static
files are only served by the Django development server when the project is
run in the DEBUG mode.
Then, we made this temporary choice (DEBUG mode by default) because most
of the users will begin with Authentic 2 using the Django development server
and we want to avoid that people have a bad first impression because static
files would not be served.
In production, the Django development server should not be used and a
dedicated server should be used to serve the static files.
In the DEBUG mode, the Django Debug Toolbar is used. Then, by default,
Authentic 2 is also dependant of this module. Find more information on
https://github.com/django-debug-toolbar/django-debug-toolbar#readme.