File: README.md

Recommend this page to a friend!
  Classes of Caleb  >  CIDRAM  >  README.md  >  Download  
File: README.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: CIDRAM
Check if an IP address is a bad source of traffic
Author: By
Last change: Update of README.md
Date: 2 years ago
Size: 4,075 bytes
 

Contents

Class file image Download

Join the chat at https://gitter.im/CIDRAM/Lobby v1: PHP >= 5.4.0 v2: PHP >= 7.2.0 License: GPL v2 PRs Welcome

What is CIDRAM?

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.

Features:

  • Licensed as GNU General Public License version 2.0 (GPLv2).
  • Easy to install, easy to customise, easy to use.
  • Works for any system with PHP+PCRE installed, regardless of OS (PHP+PCRE required).
  • Fully configurable based on your needs.
  • Ideal solution for websites and forum systems using shared hosting services.
  • Does NOT require shell access.
  • Does NOT require administrative privileges.
  • Good, strong, stable support base.

Documentation:

[\[CONTRIBUTING.md\] Want to help?](https://github.com/CIDRAM/CIDRAM/blob/v2/CONTRIBUTING.md)

Current major version development status:

?Stage reached? ?Major version? | v0 | v1 | v2 | v3 ---|---|---|---|--- Pre-Alpha<em><br />- Exploring early concepts/ideas. No code written/available yet.</em> | ? | ? | ? | ? Alpha<em><br />- Branched, but unstable. Not production-ready (high risk if used).</em> | ? | ? | ? Beta<em><br />- Branched, but unstable. Not production-ready (low risk if used).</em> | ? | ? | ? Stable<em><br />- First production-ready version has been tagged/released.</em> | ? | ? | ? Mature<em><br />- Multiple stable versions/releases exist.</em> | ? | ? | ? Locked<em><br />- Still maintained, but new features won't be implemented anymore.</em> | ? EoL/Dead<em><br />- Not maintained anymore. If possible, stop using, and update ASAP.</em> | ?

Last Updated: 31 August 2019 (2019.08.31).

For more information send a message to info at phpclasses dot org.