Changeset 898 for trunk/BlackListPlugin/data/TWiki/BlackListPlugin.txt
- Timestamp:
- 11/24/08 01:10:49 (4 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/BlackListPlugin/data/TWiki/BlackListPlugin.txt
r878 r898 6 6 ---++ Description 7 7 8 This is a simple utility to keep black sheep away from a public TWiki site. The site can be protected against excessive page access (e.g. by bad robots), suspicious activities of users, such as multiple registrations or rapid topic updates indicating Wiki:WikiSpam, or saving text with wiki-spam.8 This is a simple utility to keep black sheep away from a public Foswiki site. The site can be protected against excessive page access (e.g. by bad robots), suspicious activities of users, such as multiple registrations or rapid topic updates indicating Wiki:WikiSpam, or saving text with wiki-spam. 9 9 10 The Plugin monitors activities by IP address and uses three IP address lists to protect the TWiki site:10 The Plugin monitors activities by IP address and uses three IP address lists to protect the Foswiki site: 11 11 * WHITELIST: Manually maintained list of users who should never get on the BANLIST 12 12 * BLACKLIST: Manually maintained list of malicious users … … 21 21 The registration form can also be protected from improper use. 22 22 23 To fight Wiki-spam, the Plugin can also add a =rel="nofollow"= parameter to external URLs. Search engines will not follow links that have this parameter, taking away the incentive to add spam to TWiki.23 To fight Wiki-spam, the Plugin can also add a =rel="nofollow"= parameter to external URLs. Search engines will not follow links that have this parameter, taking away the incentive to add spam to Foswiki. 24 24 25 25 ---++ Plugin Settings … … 29 29 ---+++ General settings 30 30 * One line description, is shown in the %SYSTEMWEB%.TextFormattingRules topic: 31 * Set SHORTDESCRIPTION = Utility to keep malicious users away from a public TWiki site31 * Set SHORTDESCRIPTION = Utility to keep malicious users away from a public Foswiki site 32 32 33 33 * Debug plugin: (See output in =data/debug.txt=) … … 104 104 * Protect registration: (number of minutes to expire, 15 minutes is recommended, 0 to disable) 105 105 * Set REGEXPIRE = 0 106 * If enabled, a magic number is protecting the registration process. TWiki expects a form field with a magic number. An error message is shown if not valid or if expired. This makes it harder to register a user by a script. A hidden field needs to be added to the registration form:%BR% =<input type="hidden" name="rx" value="%<nop>BLACKLISTPLUGIN{ action="magic" }%" />=106 * If enabled, a magic number is protecting the registration process. Foswiki expects a form field with a magic number. An error message is shown if not valid or if expired. This makes it harder to register a user by a script. A hidden field needs to be added to the registration form:%BR% =<input type="hidden" name="rx" value="%<nop>BLACKLISTPLUGIN{ action="magic" }%" />= 107 107 108 108 * Message shown when using registration form incorrectly: (this message is deliberately vague) … … 115 115 ---++ Plugin Installation Instructions 116 116 117 __Note:__ You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.117 __Note:__ You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where Foswiki is running. 118 118 119 119 * Download the ZIP file from the Plugin web (see below) 120 120 * Unzip ==%TOPIC%.zip== in your twiki installation directory. Content: 121 121 | *File:* | *Description:* | 122 | ==data/ TWiki/%TOPIC%.txt== | Plugin topic |123 | ==data/ TWiki/%TOPIC%.txt,v== | Plugin topic repository |124 | ==lib/ TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module |125 | ==pub/ TWiki/%TOPIC%/.htaccess== | Apache access control to protect pub dir |122 | ==data/System/%TOPIC%.txt== | Plugin topic | 123 | ==data/System/%TOPIC%.txt,v== | Plugin topic repository | 124 | ==lib/Foswiki/Plugins/%TOPIC%.pm== | Plugin Perl module | 125 | ==pub/Foswiki/%TOPIC%/.htaccess== | Apache access control to protect pub dir | 126 126 | ==templates/oopsblacklist.tmpl== | Generic oops message | 127 * Make sure =pub/ TWiki/%TOPIC%/= is writable by the CGI user (typically =nobody=)128 * Add the hidden form field to the registration form as described in the "Registration protection settings" section (this is already in TWiki 4.0)129 * From TWiki 4.0 release on:Run the configure utility in your browser to enable the Plugin127 * Make sure =pub/Foswiki/%TOPIC%/= is writable by the CGI user (typically =nobody=) 128 * Add the hidden form field to the registration form as described in the "Registration protection settings" section 129 * Run the configure utility in your browser to enable the Plugin 130 130 * Make sure that non-administrators cannot edit this plugin topic. By default, this topic is write protected with an =ALLOWTOPICCHANGE = !AdminGroup= setting. 131 131 * Test if the installation was successful: 132 132 1 Using above form, add the IP address of one of your workstations to the BANLIST 133 1 Access TWiki from that workstation134 * if you look at a TWiki topic (with the view script) you should see the BLACKLISTMESSAGE (defined above) after a one minute timeout133 1 Access Foswiki from that workstation 134 * if you look at a Foswiki topic (with the view script) you should see the BLACKLISTMESSAGE (defined above) after a one minute timeout 135 135 * else, you should get an 500 Internal Server Error for other scripts 136 136 1 On a different workstation, remove the IP address of the test workstation from the BANLIST … … 138 138 ---++ Known Issues and Limitations 139 139 140 * Wiki-spam filtering for HTML attachments works in TWiki 01-Sep-2004 and later.141 * With TWiki 4.0.2 on some platforms, notably Solaris, attached files are uploaded with a zero file size. This is because there is a bug in how TWiki 4.0.2 handles the beforeAttachmentSaveHandler. If affected, upgrade TWiki or apply bug fix [[TWikibug:Item2390][Item2390]]142 140 * Scan for script eval() and escape() is currently hardcoded 143 141 … … 160 158 | 30 Oct 2005: | Dakar Release compatibility: Work around Dakar preferencs bug | 161 159 | 29 Oct 2005: | Added wiki-spam filtering to prevent topic save with wiki-spam | 162 | 27 Oct 2005: | For BANLIST, add/remove multiple IP addresses at once, contributed by TWiki:Main.MichaelDaum |160 | 27 Oct 2005: | For BANLIST, add/remove multiple IP addresses at once, contributed by Foswiki:Main.MichaelDaum | 163 161 | 22 Jan 2005: | Added NOFOLLOWAGE handling | 164 162 | 19 Jan 2005: | Added score for "view raw" to address e-mail harvester issue |
Note: See TracChangeset
for help on using the changeset viewer.
