Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Documented the settings.

  • Loading branch information...
commit 37ad0f578da77be6e78d4888a33a29063245cb54 1 parent 8ea5cf6
Eric Holscher authored

Showing 2 changed files with 43 additions and 0 deletions. Show diff stats Hide diff stats

  1. +1 0  docs/source/index.rst
  2. +42 0 docs/source/settings.rst
1  docs/source/index.rst
Source Rendered
@@ -21,6 +21,7 @@ Contents
21 21
22 22 install
23 23 tutorial
  24 + settings
24 25 meta
25 26
26 27 What's with the name?
42 docs/source/settings.rst
Source Rendered
... ... @@ -0,0 +1,42 @@
  1 +Settings
  2 +========
  3 +
  4 +Kong has a number of settings that will effect the behavior of Kong. Mostly related to the sending of notifications.
  5 +
  6 +
  7 +KONG_MAIL_MANAGERS
  8 +------------------
  9 +
  10 +Default: False
  11 +
  12 +When set to true, this mails notifications to the people defined in Django's MANAGERS setting.
  13 +
  14 +KONG_MAIL_ADMINS
  15 +----------------
  16 +
  17 +Default: False
  18 +
  19 +Like :ref:`KONG_MAIL_MANAGERS`, when set to ``True``, this mails notifications to the people defined in Django's ADMINS setting.
  20 +
  21 +KONG_MAIL_ON_RECOVERY
  22 +---------------------
  23 +
  24 +Default: True
  25 +
  26 +When ``True``, you are notified when your test has been fixed, as well as when it breaks.
  27 +
  28 +
  29 +KONG_MAIL_ON_EVERY_FAILURE
  30 +--------------------------
  31 +
  32 +Default: False
  33 +
  34 +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.
  35 +
  36 +KONG_MAIL_ON_CONSECUTIVE_FAILURES
  37 +---------------------------------
  38 +
  39 +Default: 1
  40 +
  41 +When set to a value above ``1``, only send emails when a test has failed x number of times.
  42 +

0 comments on commit 37ad0f5

Please sign in to comment.
Something went wrong with that request. Please try again.