From 769756b91f361df1b8af64ed347bb9923da6b30a Mon Sep 17 00:00:00 2001 From: Antoine Nguyen Date: Fri, 31 May 2013 17:42:49 +0200 Subject: [PATCH] Documentation update. --- doc/getting_started/configuration.rst | 44 ++++++++++++++++++--------- doc/getting_started/upgrade.rst | 20 ++++++++++++ 2 files changed, 50 insertions(+), 14 deletions(-) diff --git a/doc/getting_started/configuration.rst b/doc/getting_started/configuration.rst index d73922261..654f183ad 100644 --- a/doc/getting_started/configuration.rst +++ b/doc/getting_started/configuration.rst @@ -159,20 +159,6 @@ your need. The default configuration file provided by the *modoboa-admin.py* command is properly configured. -Clearing the session table -========================== - -Django does not provide automatic purging. Therefore, it's your job to -purge expired sessions on a regular basis. - -Django provides a sample clean-up script: ``django-admin.py -cleanup``. That script deletes any session in the session table whose -``expire_date`` is in the past. - -For example, you could setup a cron job to run this script every night:: - - 0 0 * * * /manage.py cleanup - *********************** External authentication *********************** @@ -259,3 +245,33 @@ Modoboa. email address change for example). Currently, the only solution is to manually delete the Modoboa record, it will be recreated on the next user login. + +******************** +Database maintenance +******************** + +Cleaning the logs table +======================= + +Modoboa logs administrator specific actions into the database. A +clean-up script is provided to automatically remove oldest +records. The maximum log record age can be configured through the +online panel. + +To use it, you can setup a cron job to run every night:: + + 0 0 * * * /manage.py cleanlogs + +Cleaning the session table +========================== + +Django does not provide automatic purging. Therefore, it's your job to +purge expired sessions on a regular basis. + +Django provides a sample clean-up script: ``django-admin.py +cleanup``. That script deletes any session in the session table whose +``expire_date`` is in the past. + +For example, you could setup a cron job to run this script every night:: + + 0 0 * * * /manage.py cleanup diff --git a/doc/getting_started/upgrade.rst b/doc/getting_started/upgrade.rst index 6c2088ade..59bd8f782 100644 --- a/doc/getting_started/upgrade.rst +++ b/doc/getting_started/upgrade.rst @@ -36,6 +36,9 @@ Finally, follow the common procedure:: 1.0.0: production ready, at last ================================ +Configuration file update +------------------------- + Several modifications need to be done into *settings.py*. #. Add the following import statement:: @@ -162,6 +165,23 @@ Several modifications need to be done into *settings.py*. } } +Migration issues +---------------- + +When running the ``python manage.py syncdb --migrate`` command, you +may encounter the following issues: + +#. Remove useless content types + + If the script asks you this question, just reply **no**. + +#. South fails to migrate ``reversion`` + + Due to the admin user model change, the script *0001_initial.py* + may fail. Just deactivate ``reversion`` from ``INSTALLED_APPS`` and + run the command again. Once done, reactivate ``reversion`` and run + the command one last time. + 0.9.4: administrative panel performance improved ================================================