Changes

Template:Networking rutos manual hotspot (view source)

Revision as of 17:25, 5 January 2022

4,532 bytes added ,  17:25, 5 January 2022
→‎Summary
Line 1: Line 1: −
{{Template:Networking_rutos_manual_fw_disclosure
+
{{Template: Networking_rutos_manual_fw_disclosure
−
| fw_version = {{{series}}}_R_00.02.06
+
| fw_version ={{Template: Networking_rutos_manual_latest_fw
−
| series = {{{series}}}
+
| series = {{{series}}}
 +
}}
 
}}
 
}}
−
 
+
{{#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_rutos_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_rutos_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 =
 +
<u><b>
 +
 +
Note:</b> Hotspot is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
 +
}}
    
==General==
 
==General==
Line 17: Line 26:  
     <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 60: Line 68:  
     <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 92:  
     </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 127: Line 145:  
     <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 203: Line 236:  
=====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 335:     
[[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.png|border|class=tlt-border]]
 +
 +
===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.
 +
 +
[[File:Networking_rutos_manual_hotspot_landing_page_themes_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]]
    
==User Groups==
 
==User Groups==
Line 261: Line 407:  
         <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
+
         <td> Maximum download bandwidth that the users assigned to this template can achieve. Bandwidth can be specified in Mbit/s.</td>
−
            in Kbit/s or 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
+
         <td>Maximum upload bandwidth that the users assigned to this template can achieve. Bandwidth can be specified in Mbit/s.</td>
−
            Kbit/s or Mbit/s.</td>
   
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 281: Line 425:  
         <td>A sent data limit that the users assigned to this template can reach. After the data limit is reached, the
 
         <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>
 
             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>
 
     <tr>
 
     <tr>
Line 296: Line 445:  
</table>
 
</table>
   −
==Landing Page==
+
==User Management==
−
 
  −
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 that will be used in the Landing Page and upload a custom Theme file.
  −
 
  −
[[File:Networking_rutos_manual_hotspot_landing_page_general_settings.png|border|class=tlt-border]]
  −
 
  −
===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.
  −
 
  −
[[File:Networking_rutos_manual_hotspot_landing_page_themes_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]]
  −
 
  −
==User management==
      
The <b>User management</b> section 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.
 
The <b>User management</b> section 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.
Retrieved from "https://wiki.teltonika-networks.com/view/Special:MobileDiff/75758...87428"

Navigation menu