maprangzth / easy-hotspot Goto Github PK

Components/Packages/Scripts used in this project
-------------------------------------------------
Elevator – Metro UI Inspired Free Bootstrap HTML5 Template by graygrids.com
https://graygrids.com/item/elevator-metro-ui-inspired-responsive-bootstrap-template/

Twitter Bootstrap (& Jquery) http://getbootstrap.com/, https://jquery.com/
Font Awesome http://fontawesome.io/

Google Fonts http://fonts.googleapis.com/

Pear2 PHP API Client by boenrobot [Vasil Rangelov, a.k.a. boen_robot (boen [dot] robot [at] gmail [dot] com)]
https://github.com/pear2/Net_RouterOS
https://github.com/pear2/Net_RouterOS/wiki
https://wiki.mikrotik.com/wiki/API_PHP_package
http://pear2.php.net/support/
-------------------------------------------------
Developed by: Siby P Varkey, [email protected]
Assistance: Sonal Siby, [email protected]
-------------------------------------------------
Visual Documentation at : http://hotspot.helloperiyar.com
-------------------------------------------------
Software and Hardware

As expected: HTML, CSS, JavaScript, PHP, MySql, PDO, Javascript/Ajax, Font Awesome, JQuery, Twitter Bootstrap ... &  PEAR2_Net_RouterOS are the major software component parts of the utility.  Above all the Mikrotik Router OS Based router or PC working with Router OS configured to an IP is the most important Hardware part involved.  

Requirements: Any web server supports PHP 5.x and all the above.
-------------------------------------------------
Prerequisites
A MySql database need to be created prior to operation, if it doesn't exist will be created automatically on initialisation.

The details of the database need to be corrected in the file 'dbconfig.php' file before operation. (Host, DB name, DB Username and DB Password)

The Details of the Router has to be entered in the 'config.php' file before operation. (Host(IP), username and password)
-------------------------------------------------
System Users: Who are operating this utility.
Any number of users can be created by the system Admin.  There are 3 levels of system users, Admin, Unit head and system users. A default system admin with username 'admin' and password 'admin' will be created automatically on initialisation. Admin user can reset passwords of all other users.  On resetting the password, it will be reset to 'password' for that user. All users can change their password using the change password option available in the system users section.

-------------------------------------------------
Documentation and Help
For more details of the opetations and features of the utility please refer the visual documentation available at http://hotspot.helloperiyar.com
-------------------------------------------------
Major features:

Creation of vouchers for Single person. (Guest User Accounts/Hotspot users)
Creation of vouchers for Multiple persons.
Listing Active Users
Listing inactive Users
Remove Selected/All User Accounts
Remove all validity expired User Accounts
Server Log of Recent Activities
Removal of uninitiated guest accounts.  Accounts created earlier but no one has started using it yet.
Voucher Management and Printing.  6 Different Voucher modes are available for Printing vouchers satisfying the needs of all.
Management of System user Accounts by Admin: Creation, Listing, Activation/Deactivation, Updating details and deletion of System users.
Hotspot User Profiles Management:  Creation/Updation of User profiles in the router. Options like Session Timeout, MAC Cookie Timeout, Keepalive Timeout, Download and Upload Speed Limits, Number of simultaneous user logins allowed per user account etc can be set for each profile.
Re-printing of Last Voucher/Vouchers List.
and many more...
Please visit http://hotspot.helloperiyar.com for a detailed visual documentation of the project.
-------------------------------------------------
How to Install in different OS based PCs
Linux / Unix variations
................
..................
Windows Based PCs
................
..................
MAC OSX based MACs
................
..................
................
..................