clean-up and migrate to README.md

This commit is contained in:
Terry Rodery 2018-03-01 13:28:58 -06:00
parent 8e1fb0b076
commit 19116c3feb
2 changed files with 37 additions and 34 deletions

View File

@ -0,0 +1,37 @@
MikroTik FastNetMon plug-in
===========
Overview
--------
Connects to a MikroTik router and adds or removes a blackhole rule for an attack by IP address.
The actions can be modified such as adding a firewall rule.
This script uses the MikroTik PHP API. More information about this can be found at the following URLs:
* http://www.mikrotik.com
* http://wiki.mikrotik.com/wiki/API_PHP_class
Installation
------------
#### Prerequisite
You must have a user with API access on the router
#### Process
1. Configure the router in the ```fastnetmon_mikrotik.php``` file
```
$cfg[ ip_mikrotik ] = "192.168.10.1"; // MikroTik Router IP
$cfg[ api_user ] = "api"; // username
$cfg[ api_pass ] = "api123"; // password
```
2. Change the ```notify_about_attack.sh``` with the new to run the PHP script
This is the first buggy version, you are welcome to add more features.
Changelog
---------
v1.0 - 4 Jul 16 - Initial version
Author: Maximiliano Dobladez info@mkesolutions.net
http://maxid.com.ar | http://www.mkesolutions.net

View File

@ -1,34 +0,0 @@
Fastnetmon Plugin: MikroTik RouterOS PHP API integration for FastNetMon
This script connect to router MikroTik and add or remove a blackhole's rule for the IP attack.
You can modify the action, ex add a firewall rule, etc.
This script use PHP API for MikroTik:
* http://www.mikrotik.com
* http://wiki.mikrotik.com/wiki/API_PHP_class
v1.0 - 4 Jul 16 - initial version
Author: Maximiliano Dobladez info@mkesolutions.net
http://maxid.com.ar | http://www.mkesolutions.net
** instalation
* You must to have an user with API access on the router MikroTik.
* Set the router's config on fastnetmon_mikrotik.php file
$cfg[ ip_mikrotik ] = "192.168.10.1"; // IP Mikrotik Router
$cfg[ api_user ] = "api"; //user
$cfg[ api_pass ] = "api123"; //pass
* Change the notify_about_attack.sh file with the new to run the php script
**
This is the first buggy version, you are welcome to add more feature.