7,851
edits
Changes
Template:Networking rutos manual hotspot (view source)
Revision as of 14:18, 26 February 2024
, 26 Februaryno edit summary
{{Template:Networking_rutos_manual_fw_disclosure
{{Template: Networking_device_manual_fw_disclosure
| series = {{{series}}}
| series = {{{series}}}
| name = {{{name}}}
| fw_version ={{Template: Networking_device_manual_latest_fw
| series = {{{series}}}
| name = {{{name}}}
}}
}}
}}
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} Hotspot (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.</i>|}}
{{#ifeq: {{{series}}} | RUT2 |<br><i><b>Note</b>: <b>[[{{{name}}} Hotspot (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT2XX}} and earlier) user manual page.</i>|}}
==Summary==
==Summary==
On Teltonika Networks devices a <b>Hotspot</b> is a service that provides authentication, authorization and accounting for a network. This chapter is an overview of the Hotspot section for {{{name}}} devices.
On Teltonika Networks devices a <b>Hotspot</b> is a service that provides authentication, authorization and accounting for a network. This chapter is an overview of the Hotspot section for {{{name}}} devices.
{{#switch: {{{series}}}
| #default =
| RUT36X|RUT9|TCR1|RUT2|RUT2M|RUT9M|TRB1|TRB2|TRB5|TRB2M|OTD140|RUT361 =
<u><b>
Note:</b> Hotspot is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
}}
==General==
==General==
<li>select an 'Interface';</li>
<li>select an 'Interface';</li>
<li>click the 'Add' button;</li>
<li>click the 'Add' button;</li>
</ol>
</ol>
[[File:Networking_rutos_manual_hotspot_hotspot_instances_add_button_edit_buton_wifi_{{{wifi}}}.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_hotspot_hotspot_instances_add_button_edit_buton_wifi_{{{wifi}}}.png|border|class=tlt-border]]
After this you should be redirected to the Hotspot's configuration page.
After this, a new Hotspot configuration window will appear.
====General Settings====
====General Settings====
=====General=====
=====General=====
----
----
[[File:Networking_rutos_manual_hotspot_general_hotspot_instances_general_settings_general.png|border|class=tlt-border]]
{{#switch: {{{series}}}
| #default = [[File:Networking_rutos_manual_hotspot_general_hotspot_instances_general_settings_general_v2.png|border|class=tlt-border]]
| TRB1 | TRB2 | TRB5 | TRB2M = [[File:Networking_rutos_manual_hotspot_general_hotspot_instances_general_settings_general_trb.png|border|class=tlt-border]]}}
<table class="nd-mantable">
<table class="nd-mantable">
<th>Value</th>
<th>Value</th>
<th>Description</th>
<th>Description</th>
</tr>
<tr>
<td>Configuration profile</td>
<td>Cloud4wi | Default | Hotspotsystems | Purple portal; default: <b>Default</b></td>
<td>Pre-configures Hotspot settings according to the selected service provider.</td>
</tr>
</tr>
<tr>
<tr>
<tr>
<tr>
<td>Hotspot Network</td>
<td>Hotspot Network</td>
<td>ip/netmask; default: <b>192.168.2.0/24</b></td>
<td>ip/netmask; default: <b>{{#switch: {{{series}}} | #default = 192.168.2.0/24 | TRB1 | TRB2 | TRB5 | TRB2M = 192.168.3.0/24}}</b></td>
<td>IP address and subnet of the Hotspot network.</td>
<td>IP address and subnet of the Hotspot network.</td>
</tr>
</tr>
<tr>
<tr>
<td>IP Address</td>
<td>IP Address</td>
<td>ip; default: '''192.168.2.254'''</td>
<td>ip; default: '''{{#switch: {{{series}}} | #default = 192.168.2.254 | TRB1 | TRB2 | TRB5 | TRB2M = 192.168.3.254}}'''</td>
<td>Defines the IP address of your Hotspot router in network.</td>
<td>Defines the IP address of your Hotspot router in network.</td>
</tr>
</tr>
<tr>
<tr>
<td>Allow signup</td>
<td>Allow signup</td>
<td>off | on; default: <b>off</b></td>
<td>off | <span style="color: #20C0D7;"><b>on</b></span>; default: <b>off</b></td>
<td>Allows users to sign up to hotspot via landing page.</td>
<td>Allows users to sign up to hotspot via landing page.</td>
</tr>
<tr>
<td><span style="color: #20C0D7;">Expiration time</span></td>
<td>integer; default: <b>0</b></td>
<td>User credential expiration time. Applies to users who signed up via landing page.</td>
</tr>
<tr>
<td><span style="color: #20C0D7;">Users group</span></td>
<td>user group; default: <b>default</b></td>
<td>The user group to which users signed up via landing page should be assigned to.</td>
</tr>
</tr>
<tr>
<tr>
<td>Landing Page</td>
<td>Landing Page</td>
<td>Internal | External; default: <b>Internal</b></td>
<td>Internal | <span style="color: #f43b1a;">External</span>; default: <b>Internal</b></td>
<td>If external Landing Page is chosen, new section, to enter website address, will appear, e.g., <i><nowiki>http://www.example.com</nowiki></i></td>
<td>If external Landing Page is chosen, new section, to enter website address, will appear, e.g., <i><nowiki>http://www.example.com</nowiki></i></td>
</tr>
</tr>
</tr>
</tr>
<tr>
<tr>
<td>UAM Secret</td>
<td><span style="color: #f43b1a;">UAM Secret</span></td>
<td>string; default: <b>none</b></td>
<td>string; default: <b>none</b></td>
<td>Shared secret between uamserver and hotspot.</td>
<td>Shared secret between uamserver and hotspot.</td>
<tr>
<tr>
<td>Trial access</td>
<td>Trial access</td>
<td>off | on; default: <b>off</b></td>
<td>off | <span style="color: #f43b1a; font-weight: bold;">on</span>; default: <b>off</b></td>
<td>Enables trial internet access for a specific group.</td>
<td>Enables trial internet access for a specific group.</td>
</tr>
</tr>
<tr>
<tr>
<td><span style="color: tomato;">Trial access: </span>Group</td>
<td><span style="color: #f43b1a;">Trial access</span>: Group</td>
<td>User group; default: <b>default</b>td>
<td>User group; default: <b>default</b></td>
<td>Group of trial users.</td>
<td>Group of trial users.</td>
</tr>
</tr>
<tr>
<tr>
<td>HTTPS to landing page redirect</td>
<td>HTTPS to landing page redirect</td>
<td>off | <span style="color: #20C0D7;"><b>on</b></span>; default: <b>off</b></td>
<td>Redirect initial pre-landing page HTTPS requests to hotspot landing page.</td>
</tr>
<tr>
<td><span style="color: #20C0D7;"><b>Certificate files from device</b></span></td>
<td>off | on; default: <b>off</b></td>
<td>off | on; default: <b>off</b></td>
<td>Redirect initial pre-landing page HTTPS requests to hotspot landing page.</td>
<td>Specified whether to upload key & certificate files from computer or to use files generated on this device via the <i>System → Administration → <b>[[{{{name}}} Administration#Certificates|Certificates]]</b></i> page.</td>
</tr>
<tr>
<td><span style="color: #20C0D7;">SSL key file</span></td>
<td>key file; default: <b>none</b></td>
<td>Upload/select SSL key.</td>
</tr>
<tr>
<td><span style="color: #20C0D7;">SSL certificate file</span></td>
<td>certificate file; default: <b>none</b></td>
<td>Upload/select SSL certificate.</td>
</tr>
</tr>
<tr>
<tr>
=====Radius=====
=====Radius=====
----
----
</b>Radius</b> authentication mode uses an external RADIUS server, to which you have to provide an address to, instead of using the router's Local Authentication. If you are using Local authentication, this section is not visible.
<b>Radius</b> authentication mode uses an external RADIUS server, to which you have to provide an address to, instead of using the router's Local Authentication. If you are using Local authentication, this section is not visible.
[[File:Networking_rutos_manual_hotspot_general_hotspot_instances_general_settings_radius.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_hotspot_general_hotspot_instances_general_settings_radius.png|border|class=tlt-border]]
=====Walled Garden=====
=====Walled Garden=====
----
----
You can add a list of addresses that users connected to the Hotspot will be able to reach without any authentication. By default this list is empty. Simply write addresses into the Address List.
You can add a list of addresses that users connected to the Hotspot will be able to reach without any authentication.
By default this list is empty. Simply write addresses into the Address List.
Format of address is <b>website.com</b> (does not include https://www).
[[File:Networking_rutos_manual_hotspot_general_hotspot_instances_general_settings_walled_garden.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_hotspot_general_hotspot_instances_general_settings_walled_garden.png|border|class=tlt-border]]
=====User Scripts=====
=====URL Parameters=====
----
----
The <b>URL parameters</b> section becomes visible when <b>Landing page</b> is selected as <b>External</b> in [[{{{name}}}_Hotspot#General_2|General settings]] section.
[[File:Networking_rutos_manual_hotspot_general_hotspot_instances_general_settings_user_scripts.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_hotspot_local_users_add_button_edit_button.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_hotspot_general_hotspot_instances_general_settings_urlparams.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
</tr>
</tr>
<tr>
<tr>
<td>Idle timeout</td>
<td>UAM IP</td>
<td>integer; default: <b>none</b></td>
<td>string; default: <b>none</b></td>
<td>A timeout in seconds after which idle users are automatically disconnected from the Hotspot. (0 means unlimited.)</td>
<td>The IP Address of the Captive Portal gateway.</td>
</tr>
<tr>
<td>UAM port</td>
<td>string; default: <b>none</b></td>
<td>The port on which the Captive Portal will serve web content.</td>
</tr>
<tr>
<td>Called</td>
<td>string; default: <b>none</b></td>
<td>The MAC address of the IP Address of the Captive Portal gateway.</td>
</tr>
<tr>
<td>MAC</td>
<td>string; default: <b>none</b></td>
<td>The MAC address of the client trying to gain Internet access.</td>
</tr>
</tr>
<tr>
<tr>
<td>Time limit</td>
<td>NAS id</td>
<td>integer; default: <b>none</b></td>
<td>string; default: <b>none</b></td>
<td>Disables hotspot user after time limit in sec is reached. (0, meaning unlimited)</td>
<td>An identification for the Captive Portal used in the RADIUS request.</td>
</tr>
</tr>
<tr>
<tr>
<td>Download bandwidth</td>
<td>Session id</td>
<td>integer; default: <b>none</b></td>
<td>string; default: <b>none</b></td>
<td> Maximum download bandwidth that the users assigned to this template can achieve. Bandwidth can be specified in Kbit/s or Mbit/s.</td>
<td>The unique identifer for session.</td>
</tr>
</tr>
<tr>
<tr>
<td>Upload bandwidth</td>
<td>User url</td>
<td>integer; default: <b>none</b></td>
<td>string; default: <b>none</b></td>
<td>Maximum upload bandwidth that the users assigned to this template can achieve. Bandwidth can be specified in Kbit/s or Mbit/s.</td>
<td>The URL which the user tried to access before he were redirected to the Captive Portal's URL's pages.</td>
</tr>
</tr>
<tr>
<tr>
<td>Download limit</td>
<td>Challenge</td>
<td>integer; default: <b>none</b></td>
<td>string; default: <b>none</b></td>
<td>A received data limit that the users assigned to this template can reach. After the data limit is reached, the user will lose data connection. Download limit is specified in MB.</td>
<td>A challenge that should be used together with the user's password to create an encrypted phrase used to log on.</td>
</tr>
</tr>
<tr>
<tr>
<td>Upload limit</td>
<td>Custom 1</td>
<td>integer; default: <b>none</b></td>
<td>string; default: <b>none</b></td>
<td>A sent data limit that the users assigned to this template can reach. After the data limit is reached, the user will lose data connection. Upload limit is specified in MB.</td>
<td>Add custom name and custom value which will be displayed in url parameters.</td>
</tr>
</tr>
<tr>
<tr>
<td>Period</td>
<td>-</td>
<td>Month | Week | Day; default: <b>Month</b></td>
<td>SSID | Hostname | FW version | --Custom--; default: <b>SSID</b></td>
<td>The beginning of the period during which the restriction specified in this section will apply. After the period is over, all specified limits are reset. </td>
<td>-</td>
</tr>
</tr>
<tr>
<tr>
<td>Start day</td>
<td>Custom 2</td>
<td>integer [1..31] | Monday..Sunday | integer [1..24]; default: <b>1</b></td>
<td>string; default: <b>none</b></td>
<td>Choices changes depending on what 'Period' was chosen. Specifies which day of the month, week or hour of the day the limits will be reset.</td>
<td>Add custom name and custom value which will be displayed in url parameters.</td>
</tr>
</tr>
<tr>
<tr>
<td>Expiration time</td>
<td>-</td>
<td>integer; default: <b>0</b></td>
<td>SSID | Hostname | FW version | --Custom--; default: <b>SSID</b></td>
<td>Expiration time in sec (0 means unlimited). Only for dynamically created users.</td>
<td>-</td>
</tr>
</tr>
</table>
</table>
=====User Scripts=====
----
In this section you can add custom <b>Scripts</b> that will be executed after a session is authorized in the <b>Session up</b> section, after session has moved from authorized state to unauthorized in the <b>Session down</b> section and after a new user has been signed up in the <b>User signup</b> section.
[[File:Networking_rutos_manual_hotspot_general_hotspot_instances_general_settings_user_scripts.png|border|class=tlt-border]]
==Local Users==
The <b>Local Users</b> section is used to create and manage users that can connect to the Hotspot. The elements comprising the Local Users page are explained in the list and figure below.
<ol>
<li>Entering a Username, Password and clicking the 'Add' button creates a new user.</li>
<li>The 'Group' dropdown menu assigns a user to another group.</li>
<li>The 'Edit' button lets you change a user's password or assign the user to another group.</li>
<li>The 'Delete[X]' button deletes a user.</li>
</ol>
[[File:Networking_rutos_manual_hotspot_local_users_add_button_edit_button.png|border|class=tlt-border]]
==Landing Page==
==Landing Page==
===General Settings===
===General Settings===
----
----
<b>General Settings</b> section lets you choose the authentication protocol that will be used in the Landing Page and upload a custom Theme file.
<b>General Settings</b> section lets you choose the authentication protocol and theme that will be used in the Landing Page. You can download more themes using the [[{{{name}}}_Package_Manager|Package Manager]]
[[File:Networking_rutos_manual_hotspot_landing_page_general_settings.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_hotspot_landing_page_general_settings_v1.png|border|class=tlt-border]]
===Themes===
===Themes===
----
----
The <b>Themes</b> section displays all available Landing Page themes. In order to edit a theme, click the 'Edit' button next to it.
The <b>Themes</b> section displays all available Landing Page themes. In order to download a theme, click the 'Download' button, in order to edit a theme, click the 'Edit' button next to it.
[[File:Networking_rutos_manual_hotspot_landing_page_themes_edit_button.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_hotspot_landing_page_themes__download_edit_button.png|border|class=tlt-border]]
====Images====
====Images====
[[File:Networking_rutos_manual_hotspot_landing_page_themes_view_settings.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_hotspot_landing_page_themes_view_settings.png|border|class=tlt-border]]
==User management==
====Custom Theme====
----
To use custom theme you can download default theme and edit it's content. Then use upload button to upload it.
[[File:Networking rutos manual hotspot landing page themes upload custom v1.png|border|class=tlt-border]]
==User Groups==
<b>User Groups</b> provides the possibility to set different connection limits for different users. A group called 'default' is already created and does not have any limitations set by default. You can
<ol>
<li>create a new group by entering a custom Name and clicking 'Add'</li>
<li>or configure the existing rule by clicking the 'Edit' button next to it.</li>
</ol>
[[File:Networking_rutos_manual_hotspot_user_groups_edit_button.png|border|class=tlt-border]]
A group's settings page will look similar to this:
[[File:Networking_rutos_manual_hotspot_user_management.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_hotspot_user_groups_group_default_settings_v2.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Idle timeout</td>
<td>integer; default: <b>none</b></td>
<td>A timeout in seconds after which idle users are automatically disconnected from the Hotspot. (0 means
unlimited.)</td>
</tr>
<tr>
<td>Time limit</td>
<td>integer; default: <b>none</b></td>
<td>Disables hotspot user after time limit in sec is reached. (0, meaning unlimited)</td>
</tr>
<tr>
<td>Download bandwidth</td>
<td>integer; default: <b>none</b></td>
<td> Maximum download bandwidth that the users assigned to this template can achieve. Bandwidth can be specified in Mbit/s.</td>
</tr>
<tr>
<td>Upload bandwidth</td>
<td>integer; default: <b>none</b></td>
<td>Maximum upload bandwidth that the users assigned to this template can achieve. Bandwidth can be specified in Mbit/s.</td>
</tr>
<tr>
<td>Download limit</td>
<td>integer; default: <b>none</b></td>
<td>A received data limit that the users assigned to this template can reach. After the data limit is reached,
the user will lose data connection. Download limit is specified in MB.</td>
</tr>
<tr>
<td>Upload limit</td>
<td>integer; default: <b>none</b></td>
<td>A sent data limit that the users assigned to this template can reach. After the data limit is reached, the
user will lose data connection. Upload limit is specified in MB.</td>
</tr>
<tr>
<td>Warning</td>
<td>integer; default: <b>none</b></td>
<td>Send an SMS warning to hotspot user after warning value of download or upload data in MB is reached. Only works with SMS OTP authentication.</td>
</tr>
<tr>
<td>Period</td>
<td>Month | Week | Day; default: <b>Month</b></td>
<td>The beginning of the period during which the restriction specified in this section will apply. After the
period is over, all specified limits are reset. </td>
</tr>
<tr>
<td>Start day</td>
<td>integer [1..31] | Monday..Sunday | integer [1..24]; default: <b>1</b></td>
<td>Choices changes depending on what 'Period' was chosen. Specifies which day of the month, week or hour of the
day the limits will be reset.</td>
</tr>
</table>
==User Management==
The <b>Current Hotspot Users</b> tab displays the status and session statistics of currently logged in users. You can also "kick" (deauthenticate) a user by clicking the 'Logout' button next to it.
[[File:Networking_rutos_manual_hotspot_user_management_current_hotspot_users.png|border|class=tlt-border]]
The <b>Registered Hotspot Users</b> tab displays the data of unique users that have registered to the hotspot before.
[[File:Networking_rutos_manual_hotspot_user_management_registered_hotspot_users.png|border|class=tlt-border]]
{{#switch: {{{series}}} | TRB1 | TRB2 | TRB5 | RUT30X | TAP100 | TAP200 | OTD140 | TRB2M | RUT301 =
| RUTX | RUTM | RUT36X | TCR1 | RUT9 | RUT9M | RUT2 | RUT2M | RUT361 | #default = {{#switch: {{{name}}} | RUTX08 | RUTX09 | RUTM08 | RUTM09 = | #default =
{{Template:Networking_rutos_manual_hotspot_2.0
| series = {{{series}}}
| name = {{{name}}}
| wifi = {{{wifi}}}
}}}}}}
[[Category:{{{name}}} Services section]]
[[Category:{{{name}}} Services section]]
