summaryrefslogtreecommitdiffstats
path: root/askbot/doc/source/live-settings.rst
diff options
context:
space:
mode:
Diffstat (limited to 'askbot/doc/source/live-settings.rst')
-rw-r--r--askbot/doc/source/live-settings.rst37
1 files changed, 37 insertions, 0 deletions
diff --git a/askbot/doc/source/live-settings.rst b/askbot/doc/source/live-settings.rst
index e154a257..12546e6c 100644
--- a/askbot/doc/source/live-settings.rst
+++ b/askbot/doc/source/live-settings.rst
@@ -19,3 +19,40 @@ No-one but the site administrators can change those settings.
At the moment this command is not available from the web-interface
but this will be fixed in the future.
+.. _live-settings-options:
+Entering live settings in settings.py file
+==========================================
+
+You might want to bypass live settings and enter them directly
+in the ``settings.py`` file in the ``LIVESETTINGS_OPTIONS`` dictionary.
+
+Having live settings overridden from the ``settings.py`` file may
+somewhat speed up your site
+and
+decrease a chance that the values could be accessed
+by an unauthorized person.
+
+Please see an example below::
+
+ LIVESETTINGS_OPTIONS = {
+ 1: {
+ 'DB' : True,
+ 'SETTINGS': {
+ 'EMAIL': {
+ 'REPLY_BY_EMAIL': True
+ }
+ }
+ }
+
+Firstly, the number "1" is site id. Most
+likely the number should be the same as the value of ``SITE_ID`` setting.
+
+The value for the site id key is a nested dictionary with two keys:
+``'DB'`` (if True - then the rest of settings will be taken from the database)
+and ``'SETTINGS'`` - a dictionary with the actual settings.
+In this example ``'EMAIL'`` is the settings group
+and
+``'REPLY_BY_EMAIL'`` is the setting name, with ``True`` being the value.
+
+Setting group names and setting names can be looked up in files within
+``askbot/conf`` directory.