Permalink
Browse files

Update markdown

  • Loading branch information...
1 parent 707e4b3 commit 97706a600aac39fd81d17643756f792eee46e6b4 @smfreegard smfreegard committed Jan 17, 2012
Showing with 16 additions and 20 deletions.
  1. +2 −2 docs/plugins/dnsbl.md
  2. +14 −18 docs/plugins/dnswl.md
@@ -10,6 +10,7 @@ Configuration
This plugins uses the following files:
dnsbl.zones - Contains a list of zones to query, one per line.
+
dnsbl.ini - INI format with options described below:
* zones
@@ -45,8 +46,7 @@ dnsbl.ini - INI format with options described below:
the hash field is the other list names.
Example:
- <pre><code>
- redis 127.0.0.1:6379> hgetall dns-list-stat:zen.spamhaus.org
+ <pre><code>redis 127.0.0.1:6379> hgetall dns-list-stat:zen.spamhaus.org
1) "TOTAL"
2) "23"
3) "ENOTFOUND"
View
@@ -12,49 +12,46 @@ you wish to skip, but after any plugins that accept recipients.
Configuration
-------------
-* dnswl.zones
+This plugins uses the following files:
- A list of zones to query.
+dnswl.zones - Contains a list of zones to query, one per line.
-* dnswl.ini
+dnswl.ini - INI format with options described below:
+
+* zones
- * zones
-
A comma or semi-colon list of zones to query. It will be merged with
any lists in dnswl.zones.
-
- * periodic_checks
+* periodic_checks
If enabled, this will check all the zones every n minutes.
The minimum value that will be accepted here is 5. Any value less
than 5 will cause the checks to be run at start-up only.
-
+
The checks confirm that the list is responding and that it is not
listing the world. If any errors are detected, then the zone is
disabled and will be re-checked on the next test. If a zone
subsequently starts working correctly then it will be re-enabled.
-
- * enable_stats
+* enable_stats
To use this feature you must have installed the 'redis' module and
have a redis server running locally on the machine.
-
+
When enabled, this will record several list statistics to redis.
-
+
It will track the total number of queries (TOTAL) and the average
response time (AVG_RT) and the return type (e.g. LISTED or ERROR)
to a redis hash where the key is 'dns-list-stat:zone' and the hash
field is the response type.
-
+
It will also track the positive response overlap between the lists
in another redis hash where the key is 'dns-list-overlap:zone' and
the hash field is the other list names.
-
-Example stats:
- redis 127.0.0.1:6379> hgetall dns-list-stat:zen.spamhaus.org
+ Example:
+ <pre><code>redis 127.0.0.1:6379> hgetall dns-list-stat:zen.spamhaus.org
1) "TOTAL"
2) "23"
3) "ENOTFOUND"
@@ -63,12 +60,11 @@ Example stats:
6) "12"
7) "AVG_RT"
8) "45.5"
-
redis 127.0.0.1:6379> hgetall dns-list-overlap:zen.spamhaus.org
1) "b.barracudacentral.org"
2) "1"
3) "bl.spamcop.net"
4) "1"
5) "TOTAL"
6) "1"
-
+ </code></pre>

0 comments on commit 97706a6

Please sign in to comment.