-
Notifications
You must be signed in to change notification settings - Fork 48
/
Copy pathreadme.txt
70 lines (62 loc) · 4.34 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
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, sibyperiyar@gmail.com
Assistance: Sonal Siby, sonusiby@gmail.com
-------------------------------------------------
Visual Documentation at : http://hotspot.zetozone.com
-------------------------------------------------
Software and Hardware
HTML, CSS, JavaScript, PHP, MySql, PDO, Javascript/Ajax, Font Awesome, JQuery, Twitter Bootstrap ... & PEAR2_Net_RouterOS API 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 initialization in most cases.
The details of the database need to be updated 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, like Host IP, username and password. If they are not correct or the system is not able to connect to the Hotspot router, will ask for correct credentials in the first screen.
-------------------------------------------------
System Users: Who are operating this utility.
3 User levels: Administrator, Unit Head and System users.
Any number of users can be created by the system Admin. They can be enabled/disabled, edited, deleted and can reset the password also by the admin. 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 a password, it will be reset to 'password' for that user. All users can change their own password using the change password option available in the system users section.
-------------------------------------------------
Documentation and Help
For more details of the operations and features of the utility please refer the visual documentation available at http://hotspot.zetozone.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/Deletion of User profiles in the router. Options like Session Timeout, MAC binding of Account, Expiry mode, grace period, price, 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.zetozone.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
................
..................
................
..................