1d152faac19b224e2502a430ba3a41862e503ecc
[ikiwiki.git] / doc / plugins / blogspam.mdwn
1 [[!template id=plugin name=blogspam author="[[Joey]]"]]
2 [[!tag type/auth]]
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 The plugin requires the [[!cpan RPC::XML]] perl module.
11
12 You can control how content is tested via the `blogspam_options` setting.
13 The list of options is [here](http://blogspam.net/api/testComment.html#options).
14 By default, the options are configured in a way that is appropriate for
15 wiki content. This includes turning off some of the more problimatic tests.
16
17 The `blogspam_pagespec` setting is a [[ikiwiki/PageSpec]] that can be
18 used to configure which pages are checked for spam. The default is to check
19 all edits. If you only want to check [[comments]] (not wiki page edits),
20 set it to "postcomment(*)".
21
22 By default, the blogspam.net server is used to do the spam checking. To
23 change this, the `blogspam_server` option can be set to the url for a
24 different server implementing the same API. Note that content is sent
25 unencrypted over the internet to the server, and the server sees
26 the full text of the content.