Difference between revisions of "HotSpot"

From Mupssoft Wiki
Jump to navigation Jump to search
 
(42 intermediate revisions by the same user not shown)
Line 4: Line 4:
 
In order for the module to work, it is necessary to make sure that it is [[Install_and_Basic_Configuration#Install_and_Start_services|installed and running in Settings]]:</p>
 
In order for the module to work, it is necessary to make sure that it is [[Install_and_Basic_Configuration#Install_and_Start_services|installed and running in Settings]]:</p>
 
<p>The interface of the hotspot module provides different tabs for regular tasks with wifi users and configuration hotspot on RouterOS devices. There are Users, Operators, Points, Gateways, Events, and Reports tabs.</p>
 
<p>The interface of the hotspot module provides different tabs for regular tasks with wifi users and configuration hotspot on RouterOS devices. There are Users, Operators, Points, Gateways, Events, and Reports tabs.</p>
−
 
+
<h2>'''Basic HotSpot gateway configuration on Mikrotik RouterOS'''</h2>
 +
<p>This paragraph does not apply to the description of the Hotspot module but contains information on configuring MikroTik ROS as a HotSpot gateway.</p>
 +
<p><ul>
 +
<li>Make sure that your router, which will act as a HotSpot gateway, is configured and has Internet access.<br></li>
 +
<li>In our example, the router is configured and has Internet access. We will configure HotSpot on the "bridgeGuest" Interface.<br>[[File:wifi-inteface-create.png|Add new interface for WIFI]]</li>
 +
<li>The HotSpot package must be installed on your router - this can be seen in the System -> packages tab.<br>[[File:wifi-system-packages.png|Install system packages]]</li>
 +
<li>If the package is missing, download it (hotspot.npk), but always the same version as the system package. You need to install the package to the root (files), after which you need to reboot the router. Check that the package is installed.<br></li>
 +
</ul></p>
 +
<p>To configure HotSpot go to the system - hotspot section</p>
 +
<p><ul>
 +
<li>For quick setup, use the setup button, after a "wizard" will be launched to configure the hotspot. You need to define the interface behind which your hotspot users will be located.<br>[[File:wifi-hotspot-setup.png|Hotpot setup]]</li>
 +
<li>For a more accurate configuration, an IP address must be registered on the HotSpot interface. It is this IP that will be automatically substituted when configuring HotSpot, if there is no IP address on the interface, the "wizard" will come up with it and substitute it.<br>[[File:wifi-hotspot-setup-1.png|Hotpot setup - step 1]]</li>
 +
<li>You will be automatically prompted to create a Pool IP addresses for distribution to clients.<br>[[File:wifi-hotspot-setup-2.png|Hotpot setup - step 2]]</li>
 +
<li>If you do not fill in the DNS Name field, then when users connect to the authorization page, the IP address of the interface will appear. If you specify a name, then it will be displayed.<br>[[File:wifi-hotspot-setup-3.png|Hotpot setup - step 3]]</li>
 +
<li>You are prompted to create your first HotSpot user.<br>[[File:wifi-hotspot-setup-4.png|Hotpot setup - step 4]]</li>
 +
<li>Congratulations! You have HotSpot configured.<br></li>
 +
</ul></p>
 
<h2>'''Users'''</h2>
 
<h2>'''Users'''</h2>
 
<p>When you click on the Users tab, you will see the following window:</p>
 
<p>When you click on the Users tab, you will see the following window:</p>
Line 36: Line 52:
 
<p>The WIFI connection policy:</p>
 
<p>The WIFI connection policy:</p>
 
<p><ul>
 
<p><ul>
−
<li>Connection days - Number of connection days what wifi user will remain autorized to Hotspot RouterOS.<br></li>
+
<li>Connection days - Number of connection days that wifi user will remain authorized to Hotspot RouterOS<br></li>
−
<li>Speed - The twodirection bandwith for wifi user. There are predifined speed: 1M, 5M, 10M, unlim. It's possibile use custom speed<br></li>
+
<li>Speed - The two-direction bandwidth for wifi users. There are predefined speed: 1M, 5M, 10M, unlim. It's possible use custom speed<br></li>
−
<li>Traffic - The traffic restriction for wifi user. There are predifined traffic restrictions: unlim, 1Gb, 2Gb, 5Gb, 10Gb. It's possibile use custom traffic restriction<br></li>
+
<li>Traffic - The traffic restriction for wifi users. There are predefined traffic restrictions: unlim, 1Gb, 2Gb, 5Gb, 10Gb. It's possible to use custom traffic restriction<br></li>
−
<li>Select date from to - to filter data by date<br></li>
+
<li>Shared users - The number of users or wireless client devices what can work with one wifi user account<br></li>
−
<li>Packing base Button - packs database data by day<br></li>
 
−
<li>Button Delete all - Delete all data from the database<br></li>
 
 
</ul></p>
 
</ul></p>
  
 +
<p>The WIFI password policy:</p>
 +
<p><ul>
 +
<li>Password length- Length of a password. By default 4 chars<br></li>
 +
<li>digits (0..9) - Requirement use digits in password<br></li>
 +
<li>low case letters (a..z) - Requirement use low case letters in a password<br></li>
 +
<li>high case letters (A..Z) - Requirement use high case letters in a password<br></li>
 +
<li>simbols (!@#$%^*) - Requirement use symbols "!@#$%^*" in password<br></li>
 +
</ul></p>
 +
<p>When you click on Add User button, you will see the following window:</p>
 +
[[File:Wifi-print-wifi-ticket.png|Print wifi ticket]]
 +
<p>There is ticket can be printed. Print template can by modified by change wifi_ticket.rtf file what located in distributive folder.</p>
  
−
<h2>'''Traffic Snapshots'''</h2>
+
<h2>'''Operators'''</h2>
−
<p>When you click on the Traffic Snapshots tab, you will see the following window:</p>
+
<p>This tab is used to associate Mupsbox users with Point. Point provides information about hotspot RouterOS devices and Gateways information.</p>
−
[[File:Traffic-Snapshots2.png|Traffic Snapshots]]
+
[[File:Wifi-operators.png|Wifi operators]]
−
<p>There are 2 buttons on the Traffic Snapshots tab:</p>
+
<h3>'''Modify point for operator'''</h3>
 +
<p>Use double-click on the operator and choose an appropriate point.</p>
 +
[[File:Wifi-set-point.png|Wifi set point]]
 +
 
 +
 
 +
<h2>'''Points'''</h2>
 +
<p>This tab is used for configuration points. Point is the association RouterOS device, which works as hotspot and config of authorization wifi users (Gateway information).</p>
 +
[[File:Wifi-points.png|Wifi points]]
 +
<p>There are 5 buttons on the Points tab:</p>
 
<p><ul>
 
<p><ul>
−
<li>Connection days - Number of connection days what user can remain autorized on Hotspot ROuterOS. After expiration time user will autorized on hotspot as new userS<br></li>
+
<li>[[File:add.png|Add hotspot point]] - Add hotspot point<br></li>
−
<li>Surname - The surname of wifi user. Available for ticket authorization only<br></li>
+
<li>[[File:remove.png|Delete hotspot point]] - Delete hotspot point<br></li>
−
<li>Speed - The twodirection speed for wifi user. There are predefinded speeds: 1M, 5M, 10M, unlim. It's possible use custom speed<br></li>
+
<li>[[File:Enable.png|Enable hotspot point]] - Enable hotspot point<br></li>
−
<li>Traffic - Trafic restriction of wifi user. There are predefinded restrictions: 1Gb, 2Gb, 5Gb, 10Gb,unlim. It's possible use custom restriction<br></li>
+
<li>[[File:Disable.png|Disable hotspot point]] - Disable hotspot point<br></li>
−
<li>Pasport № - The pasport number of wifi user. Available for ticket authorization only<br></li>
+
<li>[[File:Refresh.png|Refresh]] - Refresh window <br></li>
−
</ul>
 
−
<li>Shared users - The pasport number of wifi user. Available for ticket authorization only<br></li>
 
 
</ul></p>
 
</ul></p>
 +
<p>When you click on Add hotspot point button, you will see the following window:</p>
 +
[[File:Wifi-add-point.png|Wifi add hotspot point]]
 
<p><ul>
 
<p><ul>
−
<li>[[File:refresh.png|Refresh traffic snapshots history]] - Refresh traffic snapshots history<br></li>
+
<li>Name - Name of the point<br></li>
−
<li>[[File:exel.png|Export all data to Excel]] - Export all data to Excel<br></li>
+
<li>Device - RouterOS device what in the list of Device module. RouterOS should be configurated as a hotspot<br></li>
 +
<li>Gateway - Set of authorization information. The gateway should be configurated before point creation<br></li>
 
</ul></p>
 
</ul></p>
−
<p>In the Traffic Snapshot tab we see all the data that the system collected from all devices that were included in the collection group. The toolbar has the following:</p>
+
 
 +
<h2>'''Gateways'''</h2>
 +
<p>This tab is used for configuration gateways. Gateway is a set of information on how wifi users will authentification on hotspot RouterOS.</p>
 +
[[File:Wifi-gateways.png|Wifi gateways]]
 +
<p>There are 2 buttons on the Gateway tab:</p>
 
<p><ul>
 
<p><ul>
−
<li>Traffic in - Display traffic in Bytes, Kb, MB, GB<br></li>
+
<li>[[File:add.png|Add hotspot point]] - Add gateway<br></li>
−
<li>Button GO - Refresh traffic snapshots history<br></li>
+
<li>[[File:remove.png|Delete hotspot point]] - Delete gateway<br></li>
−
<li>Show total bytes and packets- When choosing, you will see the total for packets and traffic below.<br></li>
 
−
<li>Select date from to - to filter data by date<br></li>
 
−
<li>Packing base Button - packs database data by day<br></li>
 
−
<li>Button Delete all - Delete all data from the database<br></li>
 
 
</ul></p>
 
</ul></p>
  
−
<h2>'''Report'''</h2>
+
<p>When you click on Add Gateway button, you will see the following window:</p>
−
<p>This tab is used to create reports on the accumulated data for the period.</p>
+
[[File:Wifi-add-gateway.png|Add wifi gateways]]
−
[[File:Traffic-report.png|Report]]
 
−
<h3>'''Report toolbar'''</h3>
 
−
[[File:Traffic-report2.png|Report]]
 
 
<p><ul>
 
<p><ul>
 +
<li>Gateway name - unique Gateway name<br></li>
 +
<li>Message- The Message that wifi user will receive on a mobile device with SMS code. There is a requirement to use #wifipassword# inside text. It's variable will change on generate a password with an appropriate wifi password policy <br></li>
 +
<li>Mode - The Mode provides SMS authentification via the external provider or internal modem connected to RouterOS device<br></li>
 +
<li>External string - The string (web-link)of autentification your on external sms provider. There is a requirement to use #phonenumber# and #smsmessage# inside text. The variable #phonenumber# is number that sms will sent. The variable #smsmessage# is text of Message field, text that will recieved by wifi users<br></li>
 +
<li>RouterOS device - The RouterOS device that listed in Device module. The device will work as sms modem. There SMS model should be integrated or attached to RouterOS device<br></li>
 +
<li>Modem type - If set to class-0, then send class 0 SMS message. It is displayed immedeately and not stored in phone<br></li>
 +
<li>Modem port - The name of port from /port list that GSM modem is attached to<br></li>
 +
<li>Modem channel - Which modem channel to use for sending.<br></li>
 +
</ul></p>
 +
<p>The WIFI connection policy is the same as in creation user process:</p>
 +
<p><ul>
 +
<li>Connection days - Number of connection days that wifi user will remain authorized to Hotspot RouterOS<br></li>
 +
<li>Speed - The two-direction bandwidth for wifi users. There are predefined speed: 1M, 5M, 10M, unlim. It's possible use custom speed<br></li>
 +
<li>Traffic - The traffic restriction for wifi users. There are predefined traffic restrictions: unlim, 1Gb, 2Gb, 5Gb, 10Gb. It's possible to use custom traffic restriction<br></li>
 +
<li>Shared users - The number of users or wireless client devices what can work with one wifi user account<br></li>
 +
</ul></p>
 +
<p>The Gateway provides preflight check options like status, balance, and trying to send test SMS.</p>
 +
<p>The Status string provides check variable options from the SMS provider if it's available.</p>
 +
<p>The Balance string provides check balance options from the SMS provider if it's available.</p>
 +
<p>The Phone number string provides check trying to send test SMS.</p>
 +
  
−
<li>Search - Used to quickly find a device.<br></li>
+
 
−
<li>"=" or "!" - equal or unequal<br></li>
+
<h2>'''Events'''</h2>
−
<li>Ether "AND" or "OR" - You can use different construction of logical queries to the traffic database using logical expressions "and" or "or"<br></li>
+
<p>The Events tab provides historical information about wifi user, their mobile devices, etc.</p>
−
<li>Select date from to - to filter data by date<br></li>
+
[[File:Wifi-events.png|Wifi events]]
−
<li>Traffic in - Display traffic in Bytes, Kb, MB, GB<br></li>
+
<p><ul>
−
<li>Button GO - Send a query to the database to display data on the selected conditions.<br></li>
+
<li>ID - The event ID created by mupsbox<br></li>
−
<li>[[File:printer.png|Print Report]] - Print a summary report.<br></li>
+
<li>Application time - The time that on mupsbox machine<br></li>
 +
<li>Router time - The time that on hotspot RouterOS<br></li>
 +
<li>Action - The description of event<br></li>
 +
<li>User Login - The name of User Login for the current event. The information will write if available for that event<br></li>
 +
<li>User Name - The name of User for the current event. The information will write if available for that event<br></li>
 +
<li>User Surname - The surname of User for the current event. The information will write if available for that event<br></li>
 +
<li>User Mac Address / IP - The Mac Address or IP of a wifi client device. The information will write if available for that event<br></li>
 +
<li>Point - The Point which event is present<br></li>
 +
<li>Gateway - The Gateway which event is present<br></li>
 
</ul></p>
 
</ul></p>
 +
 +
<h2>'''Reports'''</h2>
 +
<p>The Reports tab provides agrigate or combination information about wifi user, their mobile devices, etc. The information can be exported in Excel format.</p>
 +
[[File:Wifi-reports.png|Wifi reports]]
 +
 +
<p>The first matrix provides information about wifi users with filtering options.</p>
 +
<p>The second matrix provides information about the activity of wifi users with filtering time options.</p>
  
 
<div id="BackToTop"  class="noprint" style="background-color:#DDEFDD; position:fixed;
 
<div id="BackToTop"  class="noprint" style="background-color:#DDEFDD; position:fixed;

Latest revision as of 07:52, 9 September 2020

Hotspot module

How to

The module is a powerful system MikroTik HotSpot -> user authorization. Ideal for hotels, offices, cafes, and other places where Internet access is required via Web authorization (via HotSpot gateway). The Hotspot module supports various types of authorization - authorization via SMS, creating tickets with different rights and times. In order for the module to work, it is necessary to make sure that it is installed and running in Settings:

The interface of the hotspot module provides different tabs for regular tasks with wifi users and configuration hotspot on RouterOS devices. There are Users, Operators, Points, Gateways, Events, and Reports tabs.

Basic HotSpot gateway configuration on Mikrotik RouterOS

This paragraph does not apply to the description of the Hotspot module but contains information on configuring MikroTik ROS as a HotSpot gateway.

  • Make sure that your router, which will act as a HotSpot gateway, is configured and has Internet access.
  • In our example, the router is configured and has Internet access. We will configure HotSpot on the "bridgeGuest" Interface.
    Add new interface for WIFI
  • The HotSpot package must be installed on your router - this can be seen in the System -> packages tab.
    Install system packages
  • If the package is missing, download it (hotspot.npk), but always the same version as the system package. You need to install the package to the root (files), after which you need to reboot the router. Check that the package is installed.

To configure HotSpot go to the system - hotspot section

  • For quick setup, use the setup button, after a "wizard" will be launched to configure the hotspot. You need to define the interface behind which your hotspot users will be located.
    Hotpot setup
  • For a more accurate configuration, an IP address must be registered on the HotSpot interface. It is this IP that will be automatically substituted when configuring HotSpot, if there is no IP address on the interface, the "wizard" will come up with it and substitute it.
    Hotpot setup - step 1
  • You will be automatically prompted to create a Pool IP addresses for distribution to clients.
    Hotpot setup - step 2
  • If you do not fill in the DNS Name field, then when users connect to the authorization page, the IP address of the interface will appear. If you specify a name, then it will be displayed.
    Hotpot setup - step 3
  • You are prompted to create your first HotSpot user.
    Hotpot setup - step 4
  • Congratulations! You have HotSpot configured.

Users

When you click on the Users tab, you will see the following window:

Traffic Jobs

There are 5 buttons on the Users tab:

  • Add user - Add user on hotspot RouterOS and mupsbox database
  • Delete user from hotspot - Delete user account on hotspot RouterOS and the Mupsbox database marks user account as deleted
  • Enable user - Enable user on hotspot RouterOS
  • Disable user - Disable user on hotspot RouterOS
  • Refresh - Refresh window

There are filtering checkboxes on the Users tab:

  • Filtering only wifi SMS users - Show wifi user what authorizing via SMS code
  • Filtering only wifi ticket users - Show wifi user what authorizing via ticket
  • Filtering only disabled wifi users - Filtering only disabled wifi users
  • Filtering only removed wifi users - Filtering only removed wifi users

Add new wifi user

Wifi operator can manualy add new user on hotspot RouterOS, account information in Mupsbox database, and genarate password by appropriate policy. In order for the program to add new user from your hotspot RouterOS, you must click on the Add user, then the Add new wifi user window will open:

Add new wifi user

  • Login - The wifi user will use login for authorization on Hotspot RouterOS
  • Surname - The surname of wifi user. Available for ticket authorization only
  • Name - The name of wifi user. Available for ticket authorization only
  • Patronym - The patronym of wifi user. Available for ticket authorization only
  • Pasport № - The pasport number of wifi user. Available for ticket authorization only

The operator can modify WIFI connection and WIFI passwords policies on user creation step.

The WIFI connection policy:

  • Connection days - Number of connection days that wifi user will remain authorized to Hotspot RouterOS
  • Speed - The two-direction bandwidth for wifi users. There are predefined speed: 1M, 5M, 10M, unlim. It's possible use custom speed
  • Traffic - The traffic restriction for wifi users. There are predefined traffic restrictions: unlim, 1Gb, 2Gb, 5Gb, 10Gb. It's possible to use custom traffic restriction
  • Shared users - The number of users or wireless client devices what can work with one wifi user account

The WIFI password policy:

  • Password length- Length of a password. By default 4 chars
  • digits (0..9) - Requirement use digits in password
  • low case letters (a..z) - Requirement use low case letters in a password
  • high case letters (A..Z) - Requirement use high case letters in a password
  • simbols (!@#$%^*) - Requirement use symbols "!@#$%^*" in password

When you click on Add User button, you will see the following window:

Print wifi ticket

There is ticket can be printed. Print template can by modified by change wifi_ticket.rtf file what located in distributive folder.

Operators

This tab is used to associate Mupsbox users with Point. Point provides information about hotspot RouterOS devices and Gateways information.

Wifi operators

Modify point for operator

Use double-click on the operator and choose an appropriate point.

Wifi set point


Points

This tab is used for configuration points. Point is the association RouterOS device, which works as hotspot and config of authorization wifi users (Gateway information).

Wifi points

There are 5 buttons on the Points tab:

  • Add hotspot point - Add hotspot point
  • Delete hotspot point - Delete hotspot point
  • Enable hotspot point - Enable hotspot point
  • Disable hotspot point - Disable hotspot point
  • Refresh - Refresh window

When you click on Add hotspot point button, you will see the following window:

Wifi add hotspot point

  • Name - Name of the point
  • Device - RouterOS device what in the list of Device module. RouterOS should be configurated as a hotspot
  • Gateway - Set of authorization information. The gateway should be configurated before point creation

Gateways

This tab is used for configuration gateways. Gateway is a set of information on how wifi users will authentification on hotspot RouterOS.

Wifi gateways

There are 2 buttons on the Gateway tab:

  • Add hotspot point - Add gateway
  • Delete hotspot point - Delete gateway

When you click on Add Gateway button, you will see the following window:

Add wifi gateways

  • Gateway name - unique Gateway name
  • Message- The Message that wifi user will receive on a mobile device with SMS code. There is a requirement to use #wifipassword# inside text. It's variable will change on generate a password with an appropriate wifi password policy
  • Mode - The Mode provides SMS authentification via the external provider or internal modem connected to RouterOS device
  • External string - The string (web-link)of autentification your on external sms provider. There is a requirement to use #phonenumber# and #smsmessage# inside text. The variable #phonenumber# is number that sms will sent. The variable #smsmessage# is text of Message field, text that will recieved by wifi users
  • RouterOS device - The RouterOS device that listed in Device module. The device will work as sms modem. There SMS model should be integrated or attached to RouterOS device
  • Modem type - If set to class-0, then send class 0 SMS message. It is displayed immedeately and not stored in phone
  • Modem port - The name of port from /port list that GSM modem is attached to
  • Modem channel - Which modem channel to use for sending.

The WIFI connection policy is the same as in creation user process:

  • Connection days - Number of connection days that wifi user will remain authorized to Hotspot RouterOS
  • Speed - The two-direction bandwidth for wifi users. There are predefined speed: 1M, 5M, 10M, unlim. It's possible use custom speed
  • Traffic - The traffic restriction for wifi users. There are predefined traffic restrictions: unlim, 1Gb, 2Gb, 5Gb, 10Gb. It's possible to use custom traffic restriction
  • Shared users - The number of users or wireless client devices what can work with one wifi user account

The Gateway provides preflight check options like status, balance, and trying to send test SMS.

The Status string provides check variable options from the SMS provider if it's available.

The Balance string provides check balance options from the SMS provider if it's available.

The Phone number string provides check trying to send test SMS.


Events

The Events tab provides historical information about wifi user, their mobile devices, etc.

Wifi events

  • ID - The event ID created by mupsbox
  • Application time - The time that on mupsbox machine
  • Router time - The time that on hotspot RouterOS
  • Action - The description of event
  • User Login - The name of User Login for the current event. The information will write if available for that event
  • User Name - The name of User for the current event. The information will write if available for that event
  • User Surname - The surname of User for the current event. The information will write if available for that event
  • User Mac Address / IP - The Mac Address or IP of a wifi client device. The information will write if available for that event
  • Point - The Point which event is present
  • Gateway - The Gateway which event is present

Reports

The Reports tab provides agrigate or combination information about wifi user, their mobile devices, etc. The information can be exported in Excel format.

Wifi reports

The first matrix provides information about wifi users with filtering options.

The second matrix provides information about the activity of wifi users with filtering time options.

Retrieved from "https://wiki.mupssoft.com/index.php?title=HotSpot&oldid=849"