Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Fixed #3135: added some more explanation about how the various error …

…email settings work together. Thanks, Simon G.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@4619 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit e7fb31624a4803c579f78a63a8407bbc037915d7 1 parent b9522d0
Jacob Kaplan-Moss authored

Showing 1 changed file with 30 additions and 4 deletions. Show diff stats Hide diff stats

  1. 34  docs/settings.txt
34  docs/settings.txt
@@ -197,6 +197,10 @@ of (Full name, e-mail address). Example::
197 197
 
198 198
     (('John', 'john@example.com'), ('Mary', 'mary@example.com'))
199 199
 
  200
+Note that Django will email all of these people when there's an error, see the
  201
+section on `error-reporting via email`_ for more information.
  202
+
  203
+
200 204
 ALLOWED_INCLUDE_ROOTS
201 205
 ---------------------
202 206
 
@@ -414,7 +418,7 @@ IGNORABLE_404_ENDS
414 418
 
415 419
 Default: ``('mail.pl', 'mailform.pl', 'mail.cgi', 'mailform.cgi', 'favicon.ico', '.php')``
416 420
 
417  
-See also ``IGNORABLE_404_STARTS``.
  421
+See also ``IGNORABLE_404_STARTS`` and ``Django Error-reporting via Email``
418 422
 
419 423
 IGNORABLE_404_STARTS
420 424
 --------------------
@@ -422,7 +426,8 @@ IGNORABLE_404_STARTS
422 426
 Default: ``('/cgi-bin/', '/_vti_bin', '/_vti_inf')``
423 427
 
424 428
 A tuple of strings that specify beginnings of URLs that should be ignored by
425  
-the 404 e-mailer. See ``SEND_BROKEN_LINK_EMAILS`` and ``IGNORABLE_404_ENDS``.
  429
+the 404 e-mailer. See ``SEND_BROKEN_LINK_EMAILS``, ``IGNORABLE_404_ENDS`` and
  430
+the section on `error-reporting via email`_.
426 431
 
427 432
 INSTALLED_APPS
428 433
 --------------
@@ -636,8 +641,8 @@ Default: ``False``
636 641
 Whether to send an e-mail to the ``MANAGERS`` each time somebody visits a
637 642
 Django-powered page that is 404ed with a non-empty referer (i.e., a broken
638 643
 link). This is only used if ``CommonMiddleware`` is installed (see the
639  
-`middleware docs`_). See also ``IGNORABLE_404_STARTS`` and
640  
-``IGNORABLE_404_ENDS``.
  644
+`middleware docs`_). See also ``IGNORABLE_404_STARTS``,
  645
+``IGNORABLE_404_ENDS`` and the section on `error-reporting via email`_
641 646
 
642 647
 SERVER_EMAIL
643 648
 ------------
@@ -977,3 +982,24 @@ Also, it's an error to call ``configure()`` more than once, or to call
977 982
 
978 983
 It boils down to this: Use exactly one of either ``configure()`` or
979 984
 ``DJANGO_SETTINGS_MODULE``. Not both, and not neither.
  985
+
  986
+Error-reporting via email
  987
+=========================
  988
+
  989
+When ``DEBUG`` mode is turned off, Django will email the users listed in the
  990
+``ADMIN`` setting whenever a server error occurs. This is most commonly when a
  991
+resource is not found (404 errors), or when there's been an internal server
  992
+error (500). This gives the administrators immediate notification of any errors.
  993
+
  994
+You can tell Django to stop reporting these 404's by adding the page to the
  995
+``IGNORABLE_404_ENDS`` setting:
  996
+
  997
+    IGNORABLE_404_ENDS = ('xmlhttp.php')
  998
+
  999
+Or, you can ignore it using the start of the request path, by using the
  1000
+``IGNORABLE_404_STARTS`` setting:
  1001
+
  1002
+    IGNORABLE_404_STARTS = ('/phpmyadmin/')
  1003
+
  1004
+Finally, if you wish to turn off this email reporting completely, just remove
  1005
+all entries from the ``ADMINS`` setting.

0 notes on commit e7fb316

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