=== CIDRAM ===
Plugin Name: CIDRAM
Contributors: maikuolan
Tags: anti-spam, asn, blacklist, blocker, blocklist, cidr, cloud, firewall, subnet, subnets, gpl, ip, protection, routing, security, waf
Requires at least: 3.0.1
Tested up to: 5.2.2
Stable tag: 1.13.1
Requires PHP: 5.4
License: GPLv2
License URI: https://www.gnu.org/licenses/gpl-2.0.html

CIDRAM: A PHP-level CIDR/IP-based firewall solution.

== Description ==

CIDRAM (Classless Inter-Domain Routing Access Manager) is a PHP script designed to protect websites by blocking requests originating from IP addresses regarded as being sources of undesirable traffic, including (but not limited to) traffic from non-human access endpoints, cloud services, spambots, scrapers, etc. It does this by calculating the possible CIDRs of the IP addresses supplied from inbound requests and then attempting to match these possible CIDRs against its signature files (these signature files contain lists of CIDRs of IP addresses regarded as being sources of undesirable traffic); If matches are found, the requests are blocked.

== Installation ==

# Installing via the plugins dashboard.
1. Before you begin, ensure that you're logged in as an administrator with the necessary permissions to install, update and edit plugins (after activating the plugin but before modifying the plugin configuration file, do not log out from this account).
2. From the plugins dashboard, click the "Add New" button. From the page that appears, type "CIDRAM" into the "Search Plugins" text field, and press enter. A button to install CIDRAM should appear, and CIDRAM should automatically install when you click on that button.
3. Before activating the plugin, it is advisable to understand the various configuration directives available to the plugin, what they do, and how to change them. Go to `https://cidram.github.io/`, scroll the page until you reach the "Documentation" subheading; Choose your language, and read through "Section 5: Configuration Options"; The information presented relates to the configuration directives available to the plugin.
4. Please read through the "Frequently Asked Questions" before activating!
5. From the plugins dashboard, click the "Activate" button located directly below where you see "CIDRAM".
6. After you've activated the plugin, you'll be able to modify the CIDRAM configuration file directly from your plugins dashboard. Unfortunately, due to filetype restrictions, the CIDRAM configuration file can't be modified from the plugins dashboard while CIDRAM is deactivated/inactive, and won't appear in the files list. To modify the CIDRAM configuration (after CIDRAM has been activated), click the "Edit" button located directly below where you see "CIDRAM", and in the list that should appear to the right, look for "cidram/vault/config.ini". Click on that, and the CIDRAM configuration directives should appear. Edit as per your needs, and click "Update File".

# Installing via manual upload.
1. Download the package onto your local machine, and extract its content to a directory convenient for editing.
2. Before activating the plugin, it is advisable to understand the various configuration directives available to the plugin, what they do, and how to change them. Go to `https://cidram.github.io/`, scroll the page until you reach the "Documentation" subheading; Choose your language, and read through "Section 5: Configuration Options"; The information presented relates to the configuration directives available to the plugin.
3. Please read through the "Frequently Asked Questions" before activating!
4. Modify the file `/vault/config.ini` as per your needs (this file contains the configuration directives available to the plugin), and make any other necessary changes to the package (e.g., installing custom signature files, if you need them).
5. Upload the plugin files to the `/wp-content/plugins/cidram` directory of your Wordpress installation.
6. From the plugins dashboard, click the "Activate" button located directly below where you see "CIDRAM".

== Frequently Asked Questions ==

Please refer to `https://github.com/CIDRAM/Docs/blob/master/readme.en.md#SECTION9`.

== Screenshots ==

1. Screenshot of the CIDRAM Front-End homepage.
2. Screenshot of the CIDRAM "Access Denied" page.

== Changelog ==

Please refer to `https://github.com/CIDRAM/CIDRAM/blob/v1/Changelog.txt`.

== Requirements ==

- PHP >= 5.4.0
- PCRE

== Updating ==

Note: CIDRAM does not interact in any way with your database, and stores its own configuration settings, customisations, and related materials as flatfiles within its own directory. If you've not changed any of the default configuration settings and if you're not using any customisations for this plugin, updating normally via the plugins dashboard, without need for any additional steps, should be sufficient and shouldn't cause any problems. However, if you've modified the configuration settings for CIDRAM, or if you've made any customisations, I would recommend making backups of all of these prior to updating, due to that updating will likely overwrite these changes and customisations (after updating, you can then restore your customisations from your backups). Alternatively, if you update via the CIDRAM front-end updates page, configuration settings and customisations should all be preserved.