From a3741d939ef0710a06d880ae36f9075fed66a0f1 Mon Sep 17 00:00:00 2001 From: Stefan Kalscheuer Date: Sun, 10 May 2020 12:44:05 +0200 Subject: [PATCH] README++ * minor corrections * update Statify versions * add FAQ section for IP subnets * CHANGELOG++ --- README.md | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index a8c1ead..7cfcb92 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ ## Description ## A blacklist extension for the famous [Statify](https://wordpress.org/plugins/statify/) Wordpress plugin. -This plugin adds customizable blacklist to Statify to allow blocking of referer spam or internal interactions. +This plugin adds a customizable blacklist to Statify to allow blocking of referer spam or internal interactions. ### Features ## @@ -32,7 +32,7 @@ Add a list of IP addresses or subnets (e.g. _192.0.2.123_, _198.51.100.0/24_, _2 Filters can be applied to data stored in database after modifying filter rules or for one-time clean-up. #### Compatibility #### -This plugin requires Statify to be installed. The extension has been tested with Statify up to version 1.5.1 +This plugin requires Statify to be installed. The extension has been tested with Statify up to version 1.7 The plugin is capable of handling multisite installations. ### Support & Contributions ### @@ -42,28 +42,28 @@ The plugin is capable of handling multisite installations. ### Credits ### * Author: Stefan Kalscheuer -* Special Thanks to [pluginkollektiv](https://github.com/pluginkollektiv) for maintaining _Statify_ +* Special Thanks to [pluginkollektiv](https://pluginkollektiv.org/) for maintaining _Statify_ ## Installation ## * If you don’t know how to install a plugin for WordPress, [here’s how](https://wordpress.org/support/article/managing-plugins/#installing-plugins). -* Make sure _Statify_ plugin is installed and active +* Make sure _Statify_ plugin is installed and active * Goto _Settings_ -> _Statify Blacklist_ to configure the plugin ### Requirements ### * PHP 5.5 or above * WordPress 4.7 or above -* Statify plugin installed and activated (1.5.0 or above) +* _Statify_ plugin installed and activated (1.5 or above) ## Frequently Asked Questions ## ### What is blocked by default? ### -Nothing. By default all blacklists are empty and disabled. They can and have to be filled by the blog administrator. +Nothing. By default, all blacklists are empty and disabled. They can and have to be filled by the blog administrator. A default blacklist is not provided, as the plugin itself is totally neutral. If you want to filter out referer spam, -visitors from search engines, just "false" referers from 301 redirects or you own IP address used for testing only depends on you. +visitors from search engines, just "false" referrers from 301 redirects or you own IP address used for testing only depends on you. ### Does the filter effect user experience? ### -No. It only prevent's _Statify_ from tracking, nothing more or less. +No. It only prevents _Statify_ from tracking, nothing more or less. ### Does live filtering impact performance? ### Yes, but probably not noticeable. Checking a single referer string against a (usually small) list should be negligible compared to the total loading procedure. @@ -73,14 +73,17 @@ If this still is an issue for you, consider deactivating the filter and only run No. The privacy policy of _Statify_ is untouched. Data is only processed, not stored or exposed to anyone. ### Are regular expression filters possible? ### -Yes, it is. Just select if you want to filter using regular expressions case sensitive or insensitive. - -Note, that regular expression matching is significantly slower than the plain domain filter. Hence it is only recommended for asynchronous cron or manual execution and not for live filtering. +Yes, it is. Just select regular expressions (case-sensitive or insensitive) as matching method instead of exact or keyword match. ### Why is IP filtering only available as live filter? ### -As you might know, Statify does not store any personal information, including IP addresses in the database. +As you might know, _Statify_ does not store any personal information, including IP addresses in the database. Because of this, an IP blacklist can only be applied while processing the request and not afterwards. +### Can whole IP subnet be blocked? ### +Yes. The plugin features subnet blacklists using CIDR notation. +For example _198.51.100.0/24_ blacklists all sources from _198.51.100.1_ to _198.51.100.254_. +Same for IPv6 prefixes like _2001:db8:a0b:12f0::/64_. + ## Screenshots ## 1. Statify Blacklist settings page @@ -93,6 +96,7 @@ Because of this, an IP blacklist can only be applied while processing the reques * Added automatic compatibility check for WP and PHP version (#17) * Added keyword filter mode for referer blacklist (#15) * Layout adjustments on settings page +* Regular expression filters are validated before saving (#13) ### 1.4.4 / 19.05.2018 ### * Fix live filter chain when regular expressions are active (#12)