]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/blogspam.mdwn
Update user name
[git.ikiwiki.info.git] / doc / plugins / blogspam.mdwn
index 466afd8d92874b7d2f6a21edda8124a1dd07b61f..0ebae7d8404ead8106bb46998103e9d533f710da 100644 (file)
@@ -1,5 +1,5 @@
 [[!template id=plugin name=blogspam author="[[Joey]]"]]
-[[!tag type/auth]]
+[[!tag type/auth type/comments]]
 
 This plugin adds antispam support to ikiwiki, using the
 [blogspam.net](http://blogspam.net/) API. Both page edits and
@@ -10,17 +10,22 @@ stored in a queue for moderation by an admin.
 To check for and moderate comments, log in to the wiki as an admin,
 go to your Preferences page, and click the "Comment Moderation" button.
 
-The plugin requires the [[!cpan RPC::XML]] perl module.
+The plugin requires the [[!cpan JSON]] perl module.
+The [[!cpan LWPx::ParanoidAgent]] Perl module is recommended,
+although this plugin can also fall back to [[!cpan LWP]].
 
 You can control how content is tested via the `blogspam_options` setting.
-The list of options is [here](http://blogspam.net/api/testComment.html#options).
+The list of options is [here](http://blogspam.net/api/2.0/testComment.html#options).
 By default, the options are configured in a way that is appropriate for
-wiki content. This includes turning off some of the more problimatic tests.
+wiki content. This includes turning off some of the more problematic tests.
+An interesting option for testing is `fail`, by setting it (e.g.,
+`blogspam_options => 'fail'`), *all* comments will be marked as SPAM, so that
+you can check whether the interaction with blogspam.net works.
 
 The `blogspam_pagespec` setting is a [[ikiwiki/PageSpec]] that can be
 used to configure which pages are checked for spam. The default is to check
 all edits. If you only want to check [[comments]] (not wiki page edits),
-set it to "postcomment(*)".
+set it to "postcomment(*)". Posts by admins are never checked for spam.
 
 By default, the blogspam.net server is used to do the spam checking. To
 change this, the `blogspam_server` option can be set to the url for a