ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / plugins / blogspam.mdwn
1 [[!template id=plugin name=blogspam author="[[Joey]]"]]
2 [[!tag type/auth type/comments]]
3
4 This plugin adds antispam support to ikiwiki, using the
5 [blogspam.net](http://blogspam.net/) API. Both page edits and
6 [[comment|comments]] postings can be checked for spam. Page edits that
7 appear to contain spam will be rejected; comments that look spammy will be
8 stored in a queue for moderation by an admin.
9
10 To check for and moderate comments, log in to the wiki as an admin,
11 go to your Preferences page, and click the "Comment Moderation" button.
12
13 The plugin requires the [[!cpan RPC::XML]] perl module.
14
15 You can control how content is tested via the `blogspam_options` setting.
16 The list of options is [here](http://blogspam.net/api/testComment.html#options).
17 By default, the options are configured in a way that is appropriate for
18 wiki content. This includes turning off some of the more problematic tests.
19 An interesting option for testing is `fail`, by setting it (e.g.,
20 `blogspam_options => 'fail'`), *all* comments will be marked as SPAM, so that
21 you can check whether the interaction with blogspam.net works.
22
23 The `blogspam_pagespec` setting is a [[ikiwiki/PageSpec]] that can be
24 used to configure which pages are checked for spam. The default is to check
25 all edits. If you only want to check [[comments]] (not wiki page edits),
26 set it to "postcomment(*)". Posts by admins are never checked for spam.
27
28 By default, the blogspam.net server is used to do the spam checking. To
29 change this, the `blogspam_server` option can be set to the url for a
30 different server implementing the same API. Note that content is sent
31 unencrypted over the internet to the server, and the server sees
32 the full text of the content.