Skip to content

Commit f50599c

Browse files
committed
doc(README): improve formatting, add type=karma
1 parent 7adb93f commit f50599c

File tree

2 files changed

+39
-35
lines changed

2 files changed

+39
-35
lines changed

README.md

Lines changed: 38 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33

44
[![NPM][npm-img]][npm-url]
55

6-
# haraka-plugin-dns-lists
6+
# haraka-plugin-dns-list
77

88
## dns lists
99

10-
Looks up the IP address of the remote host in a IP list(s). There are several types of DNS based lists:
10+
Looks up the IP address of the remote host in DNS lists. There are several types of DNS based lists:
1111

1212
### block
1313

14-
Block lists (aka: DNSBL) are designed to be used for blocking mail from any host listed in them. Block lists are the most common DNS list type and lists without a type specifier are considered block lists. The default action for block lists is the reject the connection. This can be changed by setting `reject=false` in the zone's settings block.
14+
Block lists (aka: DNSBL) are designed to be used for blocking mail from any host listed in them. Block lists are the most common DNS list type and lists without a type specified are considered block lists. The default action for block lists is to reject the connection. This can be changed by setting `reject=false` in the zone's settings block.
1515

1616

1717
### allow
@@ -20,6 +20,10 @@ When the remote IP is found in an allow list, this plugin returns OK for the ehl
2020

2121
IMPORTANT! The order of plugins in config/plugins is important when this feature is used. It should be listed *before* any plugins that you wish to skip, but after any plugins that accept recipients.
2222

23+
### karma
24+
25+
Karma lists can have different results for IPs beyond a simple block or allow. See [hostkarma.junkemailfilter.com](https://hostkarma.junkemailfilter.com) for details.
26+
2327

2428
## INSTALL
2529

@@ -55,38 +59,41 @@ An array or comma separated list of zones to query.
5559

5660
#### [main] search: (default: all)
5761

58-
- first: consider first DNSBL response conclusive. End processing.
59-
- all: process all DNSBL results
62+
- first: consider first DNS list response conclusive. End processing.
63+
- all: process all DNS list results
6064

6165

6266
#### [stats] enable=true
6367

64-
To use this feature you must have installed and configured the 'redis' plugin.
65-
66-
When enabled, this will record several list statistics to redis.
67-
68-
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.
69-
70-
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.
68+
This feature requires the 'redis' plugin. When enabled, this will record several list statistics to redis:
7169

72-
Example:
73-
<pre><code>redis 127.0.0.1:6379> hgetall dns-list-stat:zen.spamhaus.org
74-
1) "TOTAL"
75-
2) "23"
76-
3) "ENOTFOUND"
77-
4) "11"
78-
5) "LISTED"
79-
6) "12"
80-
7) "AVG_RT"
81-
8) "45.5"
82-
redis 127.0.0.1:6379> hgetall dns-list-overlap:zen.spamhaus.org
83-
1) "b.barracudacentral.org"
84-
2) "1"
85-
3) "bl.spamcop.net"
86-
4) "1"
87-
5) "TOTAL"
88-
6) "1"
89-
</code></pre>
70+
- the total number of queries (TOTAL)
71+
- the average response time (AVG\_RT)
72+
- the return type (e.g. LISTED or ERROR)
73+
74+
to a redis hash where the key is 'dns-list-stat:zone' and the hash field is the response type.
75+
76+
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:
77+
78+
````
79+
redis 127.0.0.1:6379> hgetall dns-list-stat:zen.spamhaus.org
80+
1) "TOTAL"
81+
2) "23"
82+
3) "ENOTFOUND"
83+
4) "11"
84+
5) "LISTED"
85+
6) "12"
86+
7) "AVG_RT"
87+
8) "45.5"
88+
89+
redis 127.0.0.1:6379> hgetall dns-list-overlap:zen.spamhaus.org
90+
1) "b.barracudacentral.org"
91+
2) "1"
92+
3) "bl.spamcop.net"
93+
4) "1"
94+
5) "TOTAL"
95+
6) "1"
96+
````
9097

9198
#### [stats] redis\_host
9299

@@ -98,16 +105,13 @@ In the form of `host:port` this option allows you to specify a different host on
98105
The exact name of the DNS zone (as specified above in main.zones) may contain settings about that DNS list.
99106

100107
* type=[ block, allow, karma ]
101-
* reject (default: true)
102-
Reject connections from IPs on block lists. Setting this to false makes dnsbl informational. reject=false is best used in conjunction with plugins like [karma](/manual/plugins/karma.html) that employ a scoring engine to make choices about message delivery.
108+
* reject=true (default: true) Reject connections from IPs on block lists. Setting this to false makes dnsbl informational. reject=false is best used in conjunction with plugins like [karma](/manual/plugins/karma.html) that employ a scoring engine to make choices about message delivery.
103109
* ipv6=true | false
104110

105111

106-
<!-- leave these buried at the bottom of the document -->
107112
[ci-img]: https://github.com/haraka/haraka-plugin-dns-list/actions/workflows/ci.yml/badge.svg
108113
[ci-url]: https://github.com/haraka/haraka-plugin-dns-list/actions/workflows/ci.yml
109114
[clim-img]: https://codeclimate.com/github/haraka/haraka-plugin-dns-list/badges/gpa.svg
110115
[clim-url]: https://codeclimate.com/github/haraka/haraka-plugin-dns-list
111116
[npm-img]: https://nodei.co/npm/haraka-plugin-dns-list.png
112117
[npm-url]: https://www.npmjs.com/package/haraka-plugin-dns-list
113-

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "haraka-plugin-dns-list",
3-
"version": "1.0.0",
3+
"version": "1.0.1",
44
"description": "Haraka plugin for DNS lists (DNSBL, DNSWL)",
55
"main": "index.js",
66
"scripts": {

0 commit comments

Comments
 (0)