Teltonika Networks Wiki

Changes

Template:Networking rutos manual hotspot (view source)

Revision as of 14:18, 26 February 2024

6,574 bytes added ,  26 February
no edit summary
Line 1: Line 1: −
{{Template:Networking_rutos_manual_fw_disclosure
+
{{Template: Networking_device_manual_fw_disclosure
−
| fw_version = {{{series}}}_R_00.02.04.1
   
| 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==
Line 17: Line 29:  
     <li>select an 'Interface';</li>
 
     <li>select an 'Interface';</li>
 
     <li>click the 'Add' button;</li>
 
     <li>click the 'Add' button;</li>
−
    <li>click the 'Edit' button next to the newly added Hotspot instance.</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====
Line 30: Line 41:  
=====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">
Line 37: Line 50:  
<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>
Line 45: Line 63:  
     <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>
Line 60: Line 78:  
     <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>
Line 74: Line 102:  
     </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>
Line 117: Line 145:  
     <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>
Line 144: Line 187:  
=====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]]
Line 203: Line 246:  
=====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]]
 +
 +
=====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_urlparams.png|border|class=tlt-border]]
 +
 +
<table class="nd-mantable">
 +
    <tr>
 +
<th>Field</th>
 +
<th>Value</th>
 +
<th>Description</th>
 +
    </tr>
 +
    <tr>
 +
<td>UAM IP</td>
 +
<td>string; default: <b>none</b></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>
 +
<td>NAS id</td>
 +
<td>string; default: <b>none</b></td>
 +
<td>An identification for the Captive Portal used in the RADIUS request.</td>
 +
    </tr>
 +
    <tr>
 +
<td>Session id</td>
 +
<td>string; default: <b>none</b></td>
 +
<td>The unique identifer for session.</td>
 +
    </tr>
 +
    <tr>
 +
<td>User url</td>
 +
<td>string; default: <b>none</b></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>
 +
<td>Challenge</td>
 +
<td>string; default: <b>none</b></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>
 +
<td>Custom 1</td>
 +
<td>string; default: <b>none</b></td>
 +
<td>Add custom name and custom value which will be displayed in url parameters.</td>
 +
    </tr>
 +
    <tr>
 +
<td>-</td>
 +
<td>SSID | Hostname | FW version | --Custom--; default: <b>SSID</b></td>
 +
<td>-</td>
 +
    </tr>
 +
    <tr>
 +
<td>Custom 2</td>
 +
<td>string; default: <b>none</b></td>
 +
<td>Add custom name and custom value which will be displayed in url parameters.</td>
 +
    </tr>
 +
    <tr>
 +
<td>-</td>
 +
<td>SSID | Hostname | FW version | --Custom--; default: <b>SSID</b></td>
 +
<td>-</td>
 +
    </tr>
 +
</table>
    
=====User Scripts=====
 
=====User Scripts=====
Line 225: Line 345:     
[[File:Networking_rutos_manual_hotspot_local_users_add_button_edit_button.png|border|class=tlt-border]]
 
[[File:Networking_rutos_manual_hotspot_local_users_add_button_edit_button.png|border|class=tlt-border]]
 +
 +
==Landing Page==
 +
 +
This section is used to define how your Hotspot's <b>Landing Page</b> will look like to connecting users.
 +
 +
===General Settings===
 +
----
 +
<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_v1.png|border|class=tlt-border]]
 +
 +
===Themes===
 +
----
 +
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__download_edit_button.png|border|class=tlt-border]]
 +
 +
====Images====
 +
----
 +
The <b>Images</b> section allows you to upload custom images to different objects.
 +
 +
[[File:Networking_rutos_manual_hotspot_landing_page_themes_images.png|border|class=tlt-border]]
 +
 +
====Style Settings====
 +
----
 +
 +
Pressing edit button [[File:Networking rutx manual edit button v1.png]] next to style settings lets you edit how your
 +
landing page will look visually using CSS syntax.
 +
 +
[[File:Networking_rutos_manual_hotspot_landing_page_themes_style_settings.png|border|class=tlt-border]]
 +
 +
====View Settings====
 +
----
 +
In <b>View Settings</b> you can access and modify default templates for various parts of landing page and edit their HTML code.
 +
 +
[[File:Networking_rutos_manual_hotspot_landing_page_themes_view_settings.png|border|class=tlt-border]]
 +
 +
====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==
 
==User Groups==
Line 239: Line 401:  
A group's settings page will look similar to this:
 
A group's settings page will look similar to this:
   −
[[File:Networking_rutos_manual_hotspot_user_groups_group_default_settings.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">
 
<table class="nd-mantable">
 
     <tr>
 
     <tr>
−
<th>Field</th>
+
        <th>Field</th>
−
<th>Value</th>
+
        <th>Value</th>
−
<th>Description</th>
+
        <th>Description</th>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
<td>Idle timeout</td>
+
        <td>Idle timeout</td>
−
<td>integer; default: <b>none</b></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>
+
        <td>A timeout in seconds after which idle users are automatically disconnected from the Hotspot. (0 means
 +
            unlimited.)</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
<td>Time limit</td>
+
        <td>Time limit</td>
−
<td>integer; default: <b>none</b></td>
+
        <td>integer; default: <b>none</b></td>
−
<td>Disables hotspot user after time limit in sec is reached. (0, meaning unlimited)</td>
+
        <td>Disables hotspot user after time limit in sec is reached. (0, meaning unlimited)</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
<td>Download bandwidth</td>
+
        <td>Download bandwidth</td>
−
<td>integer; default: <b>none</b></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 Kbit/s or Mbit/s.</td>
+
        <td> Maximum download bandwidth that the users assigned to this template can achieve. Bandwidth can be specified in Mbit/s.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
<td>Upload bandwidth</td>
+
        <td>Upload bandwidth</td>
−
<td>integer; default: <b>none</b></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 Kbit/s or Mbit/s.</td>
+
        <td>Maximum upload bandwidth that the users assigned to this template can achieve. Bandwidth can be specified in Mbit/s.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
<td>Download limit</td>
+
        <td>Download limit</td>
−
<td>integer; default: <b>none</b></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>
+
        <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>
 
     <tr>
 
     <tr>
−
<td>Upload limit</td>
+
        <td>Upload limit</td>
−
<td>integer; default: <b>none</b></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>
+
        <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>
 
     <tr>
 
     <tr>
−
<td>Period</td>
+
        <td>Warning</td>
−
<td>Month | Week | Day; default: <b>Month</b></td>
+
        <td>integer; default: <b>none</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>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>
 
     <tr>
 
     <tr>
−
<td>Start day</td>
+
        <td>Period</td>
−
<td>integer [1..31] | Monday..Sunday | integer [1..24]; default: <b>1</b></td>
+
        <td>Month | Week | Day; default: <b>Month</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>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>
 
     <tr>
 
     <tr>
−
<td>Expiration time</td>
+
        <td>Start day</td>
−
<td>integer; default: <b>0</b></td>
+
        <td>integer [1..31] | Monday..Sunday | integer [1..24]; default: <b>1</b></td>
−
<td>Expiration time in sec (0 means unlimited). Only for dynamically created users.</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>
 
     </tr>
 
</table>
 
</table>
   −
==Landing Page==
+
==User Management==
   −
This section is used to define how your Hotspot's Landing Page will look like.
+
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.
   −
===General Settings===
+
[[File:Networking_rutos_manual_hotspot_user_management_current_hotspot_users.png|border|class=tlt-border]]
−
----
  −
'''General Settings''' section lets you choose authentication protocol that will be used in Landing Page.
     −
[[File:Network_rutxxx_manual_hotspot_landing_page_general_v1.png|border|class=tlt-border]]
     −
===Themes===
+
The <b>Registered Hotspot Users</b> tab displays the data of unique users that have registered to the hotspot before.  
−
----
  −
The <b>Themes</b> section shows all available landing page themes and allows you to edit them.
     −
[[File:Network_rutxxx_manual_hotspot_landing_page_themes_v1.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_hotspot_user_management_registered_hotspot_users.png|border|class=tlt-border]]
   −
====Images====
+
{{#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 =
−
The <b>Images</b> section allows you to upload custom images to different objects.
+
{{Template:Networking_rutos_manual_hotspot_2.0
−
 
+
| series = {{{series}}}
−
[[File:Network_rutxxx_manual_hotspot_landing_page_themes_images_v1.png|border|class=tlt-border]]
+
| name = {{{name}}}
−
 
+
| wifi = {{{wifi}}}
−
====Style settings====
+
}}}}}}
−
----
  −
 
  −
Pressing edit button [[File:Networking rutx manual edit button v1.png]] next to style settings lets you edit how your
  −
landing page will look visually using CSS syntax.
  −
 
  −
[[File:Network_rutxxx_manual_hotspot_landing_page_themes_style_v1.png|border|class=tlt-border]]
  −
 
  −
====View settings====
  −
----
  −
 
  −
In view settings you can access and modify default templates for various parts of landing page and edit their HTML code.
  −
 
  −
[[File:Network_rutxxx_manual_hotspot_landing_page_themes_view_settings_v1.png|border|class=tlt-border]]
  −
 
  −
==User management==
  −
 
  −
The <b>User management</b> section allows you to manage currently logged in users.
  −
 
  −
[[File:Network_rutxxx_manual_hotspot_landing_page_user_management_v1.png|border|class=tlt-border]]
      
[[Category:{{{name}}} Services section]]
 
[[Category:{{{name}}} Services section]]
Retrieved from "https://wiki.teltonika-networks.com/view/Special:MobileDiff/70180...120914"