# HG changeset patch
# User Steve Losh <steve@stevelosh.com>
# Date 1264813543 18000
# Node ID 319926dba84235035df81696065e1cd834cef2aa
# Parent  64399c0fed7a7a7f2c18f858788d95da28edf94a
django-hoptoad: Update documentation.

diff -r 64399c0fed7a -r 319926dba842 django-hoptoad/config/index.html
--- a/django-hoptoad/config/index.html	Wed Jan 20 20:38:19 2010 -0500
+++ b/django-hoptoad/config/index.html	Fri Jan 29 20:05:43 2010 -0500
@@ -51,6 +51,7 @@
 <li><a href="#track-403-errors">Track 403 Errors</a></li>
 <li><a href="#ignore-specific-user-agents">Ignore Specific User Agents</a></li>
 <li><a href="#use-ssl-to-post-to-hoptoad">Use SSL to POST to Hoptoad</a></li>
+<li><a href="#hide-sensitive-request-parameters">Hide Sensitive Request Parameters</a></li>
 <li><a href="#asynchronous-posts-and-request-handlers">Asynchronous POSTs and Request Handlers</a><ul>
 <li><a href="#threadpool">"threadpool"</a></li>
 <li><a href="#blocking">"blocking"</a></li>
@@ -139,6 +140,17 @@
 
 
 <p>This will force a fallback to a non-SSL HTTP post to Hoptoad if the SSL post fails.</p>
+<h2 id="hide-sensitive-request-parameters">Hide Sensitive Request Parameters</h2>
+<p>If a user submits important data (credit card numbers, for example) with a GET
+or POST request and an error occurs, that data will be passed along to
+Hoptoad. If you want to blank out the contents of certain parameters you can
+use this option:</p>
+<div class="codehilite"><pre><span class="n">HOPTOAD_PROTECTED_PARAMS</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;credit_card_number&#39;</span><span class="p">,</span> <span class="s">&#39;ssn&#39;</span><span class="p">]</span>
+</pre></div>
+
+
+<p>Any parameter in this list will have its contents replaced with
+<code>********************</code> before it is sent to Hoptoad.</p>
 <h2 id="asynchronous-posts-and-request-handlers">Asynchronous POSTs and Request Handlers</h2>
 <p>On a highly trafficked website there is a noticeable degree of a delay when POST'ing to Hoptoad -- either due to error limitations, network instability, or other acts of God that can cause an HTTP request to slow down or fail. To fix this, django-hoptoad will spawn a daemon thread by default.  It will spawn a thread pool (with 4 threads) to queue up all errors for maximum throughput. However, this can be configured to your heart's content, including changing the notification handler completely. </p>
 <p>To change the number of threads spawned per threadpool from the default of 4, you can set the following variable to your desired thread count per threadpool:</p>