Permalink
Browse files

Documented the settings.

  • Loading branch information...
1 parent 8ea5cf6 commit 37ad0f578da77be6e78d4888a33a29063245cb54 @ericholscher committed Sep 22, 2010
Showing with 43 additions and 0 deletions.
  1. +1 −0 docs/source/index.rst
  2. +42 −0 docs/source/settings.rst
View
@@ -21,6 +21,7 @@ Contents
install
tutorial
+ settings
meta
What's with the name?
View
@@ -0,0 +1,42 @@
+Settings
+========
+
+Kong has a number of settings that will effect the behavior of Kong. Mostly related to the sending of notifications.
+
+
+KONG_MAIL_MANAGERS
+------------------
+
+Default: False
+
+When set to true, this mails notifications to the people defined in Django's MANAGERS setting.
+
+KONG_MAIL_ADMINS
+----------------
+
+Default: False
+
+Like :ref:`KONG_MAIL_MANAGERS`, when set to ``True``, this mails notifications to the people defined in Django's ADMINS setting.
+
+KONG_MAIL_ON_RECOVERY
+---------------------
+
+Default: True
+
+When ``True``, you are notified when your test has been fixed, as well as when it breaks.
+
+
+KONG_MAIL_ON_EVERY_FAILURE
+--------------------------
+
+Default: False
+
+When ``True``, this will send you an email on every test that fails. If ``False``, you will only get emails on the first time that this test fails. This would presumably be used along with :ref:`KONG_MAIL_ON_RECOVERY`, so that you only get mails when a test fails and then passes again.
+
+KONG_MAIL_ON_CONSECUTIVE_FAILURES
+---------------------------------
+
+Default: 1
+
+When set to a value above ``1``, only send emails when a test has failed x number of times.
+

0 comments on commit 37ad0f5

Please sign in to comment.