add link to options list
[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. Currently,
7 detected spam is not saved for human review, it is just rejected.
8
9 You can control how content is tested via the `blogspam_options` setting.
10 The list of options is [here](http://blogspam.net/api/testComment.html#options).
11 By default, the options are configured in a way that is appropriate for
12 wiki content. This includes turning off some of the more problimatic tests.
13
14 The `blogspam_pagespec` setting is a [[ikiwiki/PageSpec]] that can be
15 used to configure which pages are checked for spam. The default is to check
16 all edits. If you only want to check [[comments]] (not wiki page edits),
17 set it to "postcomment(*)".
18
19 By default, the blogspam.net server is used to do the spam checking. To
20 change this, the `blogspam_server` option can be set to the url for a
21 different server implementing the same API. Note that content is sent
22 unencrypted over the internet to the server, and the server sees
23 the full text of the content.