AntiSpam Configuration
Reference
All the configuration lives in the AntiSpam space of the main wiki: six list pages that ship with the extension, the AntiSpam.Logs page it creates on the first match, and two settings in the wiki administration. It is read from there whichever wiki a save happens on, so a farm has one set of lists rather than one per wiki. Each list page holds one entry per line, and a line starting with a hash sign is a comment.
| Page | Title in the interface | Holds | Written by |
|---|---|---|---|
| AntiSpam.Keywords | "Spam Keywords" | One Java regular expression per line. All the lines are joined with a pipe into a single expression. | You |
| AntiSpam.Excludes | "Space Excludes" | Full references of the spaces that Spam Checking must not inspect. | You |
| AntiSpam.KnownUsers | "Known Users" | Full references of the accounts that are protected. | You |
| AntiSpam.KnownGroups | "Known Groups" | Full references of the groups whose members are protected. | You |
| AntiSpam.IPAddresses | "Banned IP Addresses" | Addresses that may no longer save a page. | Spam Checking |
| AntiSpam.DisabledUsers | "Disabled Spam Users" | Accounts that were disabled for submitting spam. | Spam Checking |
| AntiSpam.Logs | "Logs" | One line per keyword match: the author, the page, and the keyword with the text surrounding it. Created on the first match, so it does not exist on a fresh installation. | Spam Checking |
A page named Keywords- followed by a wiki id, in the same space, holds keywords that apply to that wiki only. It is read in addition to AntiSpam.Keywords, never instead of it.
The two settings are in the wiki administration, under "Other" and then "AntiSpam":
| Setting | Default | Effect |
|---|---|---|
| "Is Spam Checking Active?" | Selected | Clearing it stops the save-time inspection entirely. Spam Cleaning is unaffected. |
| "Position of the IP address in the XFF header" | Empty | Which entry of the X-Forwarded-For header holds the client address, counted from the end: 0 is the last entry, 1 the last but one, and so on for each further proxy. Left empty, or set out of range, the first entry of the header is used. |
FAQ
Do I have to restart XWiki after editing a list?
No. Each page is read again on every check, so a saved change applies to the next save.
Will an upgrade overwrite my lists?
No. The six list pages are declared as customizable entries and the configuration page as a configuration entry, which is what tells the extension manager to keep your version.
Can a subwiki have its own excludes or known users?
No. Keywords are the only list that can be extended per wiki.
