Module: Stop Forum Spam
Version: 0.3
Author: Thomas Seifert <thomas@phorum.org>, Skye Nott <skye@f4.ca>

This module uses stopforumspam.com to check newly registered users
against their database of known spammers.

Tested on version 5.2.21.


License:
-------

Free to use, modify, or redistribute this code so long as I am given credit for
the original development somewhere. This code comes with absolutly no warranty.


Installation:
------------

1. Unpack the archive.

2. Move the directory "stopforumspam" to the directory "mods" within your
   Phorum installation. Don't change the directory name!

3. Login as administrator in Phorum's administrative interface and go to the
   "Modules" section.

4. Enable the module "Stop Forum Spam".


Module settings:
---------------

==== General Settings

== API Key

Not yet used. It can be filled with random characters.

Get it from http://www.stopforumspam.com/signup.

The default value is "0000".

== Minimum Frequency Score

Spam score threshold

If the total number of times the checked fields appear in the stopforumspam
database exceeds this number, the registration will be considered spammy.
Adjust according to your checks and watch the event log for fale positives.

Set to 1 for maximum protection.

The default value is "1".

==== Log Settings

== Log blocked form posts to the Event Logging module?

When both this feature and the Event Logging module are enabled, then the Stop
Forum Spam Module will log information about blocked registrations to the
Phorum Event Log. To view this log, go to the Event Log viewer.

The default value is "checked".

==== Action done

== What action has to be taken when a spammy registration is suspected?

Action when a spam message is suspected

You can choose whether you want to fully block suspected spammy registrations
or that you want to have them saved in a moderated state, so they will need
approval by a moderator.

A message is suspicious if it one of the selected checks fails.

The default value is "Accept, but make unapproved".

== Return Generic Error

Message type shown to blocked user

Enabling this option will return a generic error message to the suspected
spammer that does not contain any hints as to the source or reason for the
block.

The default value is "unchecked".

==== Checks done

== Check IP Address

The default value is "checked".

== Check Username

The default value is "unchecked".

== Check Email Address

The default value is "checked".


Language support:
----------------

This module supports multiple languages.

The following languages are included:

- English
- German (formal)
- German (informal) male
- German (informal) female

If you want to translate the module to a new language, you'll have to do the
following:

Copy lang/english.php to lang/yourlang.php (yourlang.php must have the same
name as Phorum's main language file that you use). After this, translate the
strings in lang/yourlang.php.

If you have created a translation for this module, please post a zip file
containing lang/yourlang.php in the module thread at phorum.org, so the
translation can be added to the module package. See:
http://www.phorum.org/phorum5/read.php?62,150485