root/trunk/readme.txt

Revision 78 (checked in by brad, 4 years ago)

Updates to readme file.

Line 
1 SpamLookup
2 A plugin for Movable Type
3
4 Release 2.0
5
6 Brad Choate
7 Tobias Hoellrich
8
9
10 DESCRIPTION
11
12 Adds a comment and TrackBack posting filter that checks inbound comment IPs
13 and URLs against distributed blacklists.
14
15 If a comment or TrackBack ping is sent from an open proxy or a blacklisted
16 IP, they will either be blocked or moderated, depending on your configuration.
17
18
19 REQUIREMENTS
20
21 This plugin requires Movable Type 3.1 or later.
22
23
24 INSTALLATION
25
26 Install the following files to your Movable Type 'plugins' directory (if
27 a 'plugins' directory does not already exist with your installation, you
28 will need to create it):
29
30     mt/plugins/spamlookup/
31                          spamlookup.pl
32                          mt-spamlookup.cgi
33                          sltool
34
35 And these files into this location:
36
37     mt/plugins/spamlookup/tmpl/
38                               comments.tmpl
39                               config.tmpl
40                               despam.tmpl
41                               logs.tmpl
42                               pings.tmpl
43                               slfooter.tmpl
44                               slheader.tmpl
45                               view_cache.tmpl
46
47 And finally...
48
49     mt/images/spamlookup/
50                          nav-viewlog.gif
51
52 Of these files, mt-spamlookup.cgi and sltool should have "execute"
53 permission.  The other files must simply be readable.
54
55 If you experience problems or unexpected results, simply remove these
56 files from your MT installation to revert back to the Movable Type
57 default comment handling.
58
59 This plugin is compatible with MT-Blacklist and MT's own comment throttling
60 mechanisms.
61
62 This plugin is compatible with MT's dynamic publishing features since it
63 only affects the processing done by mt-comments.cgi.
64
65
66 USAGE
67
68 Upon installing the plugin, you can go to the Movable Type main menu
69 and click on the 'SpamLookup' link now available under the "Plugins" list.
70 If you do not see such a link, the plugin is not installed properly.
71
72 This plugin gives you several defensive options:
73
74     * IP-based blacklisting based on DNS lookup services. Several
75       organizations and services exist to provide dynamic and
76       distributed IP blacklisting for known open proxies. You can
77       configure the list of services that are used for this test.
78
79     * Domain-based blacklisting based on DNS lookup services. As with
80       IP-based lookups, DNS lookups on domain names is also possible.
81
82     * Dynamic proxy testing. A more aggresive approach, but one that
83       will help identify open proxies that may not already be listed
84       by DNSBL services. You can also opt to automatically IP-ban
85       open proxies discovered in this way.
86
87     * Filtering based on "X-Forwarded-For" HTTP header. This header
88       typically accompanies a request from a proxy. Note however that
89       not all HTTP proxies are bad. Sometimes a user runs a local proxy
90       on their network to allow for local caching of data. To allow for
91       this, a list of IP subnets can be given to prevent blocking most
92       legitimate cases.
93
94     * Link count limitation. Moderate/Block comments and TrackBacks
95       based on the number of links that appear in the message.
96
97 CREDITS
98
99 Developers: Brad Choate and Tobias Hoellrich.
100 Testing and technical feedback: Ask Bjørn Hansen and Adam Kalsey.
101
102
103 LICENSE
104
105 Released under the MIT license. Please see
106     http://www.opensource.org/licenses/mit-license.php
107 for details.
108
109
110 HISTORY
111
112 4/6/2005 - 2.0 release
113     * Renamed to SpamLookup.
114     * Added support for MT-Moderate 1.0 which supports moderation of
115       TrackBack pings.
116     * Integrated MT-ProxyPlug functionality by Tobias Hoellrich.
117     * Added despam functionality.
118     * Added wordlist filters for moderating and blocking.
119     * Added comment and ping viewing so administrator can manage feedback
120       across all installed weblogs.
121     * Added domain-based blacklisting; extracts URLs mentioned and checks
122       against public domain blacklist services.
123     * Added support for TrackBack filtering.
124     * Added support for passphrase requirement for comments and TrackBack
125       pings.
126     * Added IP-block cache management screen.
127     * Added a configuration screen.
128     * Removed requirement of Net::DNS package.
129     * Added option granting a free pass for authenticated commenters.
130     * Added option granting a free pass for comments without any URLs.
131     * Added option granting approval for comments whose URL matches
132       a previously approved comment's URL (but only if the text of the
133       comment itself contains no additional URLs).
134     * Added option to block pings whose IP does not match the IP address
135       of the source URL.
136     * Added log view functionality.
137
138 11/5/2004 - 1.1 release
139
140 11/5/2004 - Initial release (as MT-DSBL)
Note: See TracBrowser for help on using the browser.