Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
oyeaussie committed Aug 12, 2024
1 parent aa12792 commit 99657c2
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,15 @@
<h2>Description:</h2>
## Description:
PHPFirewall is a tool to allow/block connections to your web resource using IP address. The IP address details are either retrieved from local database or by making API calls to IP2Location.io

<h2>Code Example:</h2>
## Why this project?
Internet is ever growing. New devices are coming online everyday which requires the ISPs to add new network range into their system. This makes it quite difficult for firewalls like Cisco or pfsense (linux) to manage policies or know about all networks that are introduced by the ISP of a particular region. Most network hacking happens because of incorrect/failed firewall rules. It's just hard to know all of the network IP ranges of a region.

I wanted to create a firewall application that can be installed on shared hosting, that does not require physical access to the hardware or require a dedicated hardware to run. PHPFirewall can run in a shared hosting environment like Cpanel and it will work just fine. Most Cpanel providers provide access to the users space via SSH, so managing the firewall via CLI is possible.

The whole idea is not to worry about which IP belongs to which part of the world. 1 line should be enough to allow connection from that region and the firewall should take care of the rest of the connections by blocking them.
Ip2location.io API along with this application - PHPFirewall, makes this possible.

## Code Example:
```php
//In index.php
<?php
Expand All @@ -19,11 +26,11 @@ if (!(new \PHPFirewall\Firewall)->checkIp()) {
// Rest of your code
```

<h2>Documentation:</h2>
## Documentation:

[Documentation for this repository](https://github.com/oyeaussie/PHPFirewall/wiki/1.-Description)

<h2>Credits:</h2>
## Credits:
Thanks to the following projects for their great work. Without them, this project would not be possible.<br>

Composer<br>
Expand All @@ -39,17 +46,17 @@ Carbon Date : https://carbon.nesbot.com/<br>
Codeception : https://codeception.com/<br>
PHPUnit : https://phpunit.de/<br>

<h2>Issues/Discussions/New features:</h2>
## Issues/Discussions/New features:
Feel free to open an issue in case of a bug or to discuss anything related to the tool or to add a new feature.

<h2>Buy Me A Coffee/Beer:</h2>
## Buy Me A Coffee/Beer:
Time is valuable. If you feel this project has been helpful and it has saved your time worth a coffee or a beer...<br><br>
<a href="https://www.buymeacoffee.com/oyeaussie" target="_blank"><img src="https://github.com/oyeaussie/assets/blob/main/buymecoffee.jpg" alt="Buy Me A Coffee"></a>
<a href="https://github.com/sponsors/oyeaussie?frequency=one-time&sponsor=oyeaussie&amount=10" target="_blank"><img src="https://github.com/oyeaussie/assets/blob/main/buymebeer.jpg" alt="Buy Me A Beer"></a>

<h2>Hire me:</h2>
## Hire me:
If you would like to develop a PHP application that requires expert level programming. I am available for hire. Message me and we can discuss further.

<h2>Repo Activity:</h2>
## Repo Activity:

![Repo Activity](https://repobeats.axiom.co/api/embed/b697a39a301be8feae16fcdf29cb428864b7188b.svg "Repo Activity")

0 comments on commit 99657c2

Please sign in to comment.