Teltonika Networks Wiki

Changes

Template:Networking rutos manual hotspot (view source)

Revision as of 14:18, 26 February 2024

3,610 bytes removed ,  26 February
no edit summary
Line 31: Line 31:  
</ol>
 
</ol>
   −
[[File:Networking_rutos_manual_hotspot_hotspot_instances_add_button_edit_buton_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, a new Hotspot configuration window will appear.
 
After this, a new Hotspot configuration window will appear.
Line 42: Line 42:  
----
 
----
 
{{#switch: {{{series}}}
 
{{#switch: {{{series}}}
−
   | #default = [[File:Networking_rutos_manual_hotspot_general_hotspot_instances_general_settings_general_v3.png|border|class=tlt-border]]
+
   | #default = [[File:Networking_rutos_manual_hotspot_general_hotspot_instances_general_settings_general_v2.png|border|class=tlt-border]]
−
   | TRB1 | TRB5 = [[File:Networking_rutos_manual_hotspot_general_hotspot_instances_general_settings_general_trb_v1.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 73: Line 73:  
     <tr>
 
     <tr>
 
<td>Authentication mode</td>
 
<td>Authentication mode</td>
−
<td>Local users | Radius | MAC authentication | Single sign-on{{#ifeq:{{{mobile}}}|1| {{!}} SMS OTP}}; default: <b>Local users</b></td>
+
<td>Radius | Local user | {{#ifeq:{{{mobile}}}|1|SMS OTP <nowiki>|</nowiki> |}}MAC auth ; default: <b>Local users</b></td>
 
<td>Authentication mode defines how users will connect to the Hotspot.</td>
 
<td>Authentication mode defines how users will connect to the Hotspot.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
<td>Local users: Allow signup</td>
+
<td>Allow signup</td>
 
<td>off | <span style="color: #20C0D7;"><b>on</b></span>; 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>
 
     <tr>
 
     <tr>
−
<td>Local users: <span style="color: #20C0D7;">Expiration time</span></td>
+
<td><span style="color: #20C0D7;">Expiration time</span></td>
 
<td>integer; default: <b>0</b></td>
 
<td>integer; default: <b>0</b></td>
 
<td>User credential expiration time. Applies to users who signed up via landing page.</td>
 
<td>User credential expiration time. Applies to users who signed up via landing page.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
<td>Local users: <span style="color: #20C0D7;">Users group</span></td>
+
<td><span style="color: #20C0D7;">Users group</span></td>
 
<td>user group; default: <b>default</b></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>
 
<td>The user group to which users signed up via landing page should be assigned to.</td>
 
     </tr>
 
     </tr>
−
    <tr>
  −
<td>Radius: Enable MAC authentication</td>
  −
<td>off | on; default: <b>off</b></td>
  −
<td>Enable MAC address authentication.</td>
  −
    </tr>
  −
    <tr>
  −
<td>MAC authentication: Require password</td>
  −
<td>off | <span style="color:brown">on</span>; default: <b>off</b></td>
  −
<td>Enables password requirement for MAC authentication.</td>
  −
    </tr>
  −
    <tr>
  −
<td>MAC authentication: <span style="color:brown">MAC auth password</span></td>
  −
<td>string; default: <b>none</b></td>
  −
<td>Password for MAC authentication.</td>
  −
    </tr>
  −
    <tr>
  −
<td>MAC authentication / Single sign-on{{#ifeq:{{{mobile}}}|1| / SMS OTP}}: User group</td>
  −
<td>select; default: <b>default</b></td>
  −
<td>Specifies the group of dynamically created users.</td>
  −
    </tr>{{#ifeq:{{{mobile}}}|1|
  −
    <tr>
  −
<td>SMS OTP: Allow password duplicates</td>
  −
<td>off {{!}} on; default: <b>off</b></td>
  −
<td>Allows more than one user to login with a same password.</td>
  −
    </tr>
  −
    <tr>
  −
<td>SMS OTP: Expiration time</td>
  −
<td>unsingned integer; default: <b>0</b></td>
  −
<td>User expiration time in sec (0 means unlimited).</td>
  −
    </tr>|}}
   
     <tr>
 
     <tr>
 
<td>Landing Page</td>
 
<td>Landing Page</td>
 
<td>Internal | <span style="color: #f43b1a;">External</span>; default: <b>Internal</b></td>
 
<td>Internal | <span style="color: #f43b1a;">External</span>; default: <b>Internal</b></td>
−
<td>Location of the landing page.</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>
  −
<td> <span style="color: #f43b1a;">Landing Page Address</span></td>
  −
<td>string; default: <b>none</b></td>
  −
<td>External landing page address (http://www.example.com/example).</td>
   
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 135: Line 100:  
<td>integer; default: <b>3990</b></td>
 
<td>integer; default: <b>3990</b></td>
 
<td>Port to bind for authenticating clients.</td>
 
<td>Port to bind for authenticating clients.</td>
−
    </tr>
  −
    <tr>
  −
<td><span style="color: #f43b1a;">Password encoding</span></td>
  −
<td>off {{!}} on; default: <b>none</b></td>
  −
<td>Password encoding with the challenge.</td>
  −
    </tr>
  −
    <tr>
  −
<td><span style="color: #f43b1a;">Landing page address</span></td>
  −
<td>url; default: <b>none</b></td>
  −
<td>External landing page address (http://www.example.com).</td>
   
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 153: Line 108:  
     <tr>
 
     <tr>
 
<td>Success page</td>
 
<td>Success page</td>
−
<td>Success Page | Original URL | <span style="color:blue">Custom</span>; default: <b>Success page</b></td>
+
<td>Success Page | Original URL | Custom; default: <b>Success page</b></td>
 
<td>Location to return to after successful authentication.</td>
 
<td>Location to return to after successful authentication.</td>
−
    </tr>
  −
    <tr>
  −
<td><span style="color:blue">Custom</span></td>
  −
<td>url; default: <b>none</b></td>
  −
<td>Address must contain protocol (http://www.example.com).</td>
   
     </tr>
 
     </tr>
 
</table>
 
</table>
Line 165: Line 115:  
=====Advanced=====
 
=====Advanced=====
 
----
 
----
−
[[File:Networking_rutos_manual_hotspot_general_hotspot_instances_general_settings_advanced_v1.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_hotspot_general_hotspot_instances_general_settings_advanced.png|border|class=tlt-border]]
    
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 176: Line 126:  
<td>Additional interfaces</td>
 
<td>Additional interfaces</td>
 
<td>Available interfaces; default: '''none'''</td>
 
<td>Available interfaces; default: '''none'''</td>
−
<td>Choose additional the interfaces you want to attach to this hotspot instance.</td>
+
<td>Shows additional interfaces that can be attached to hotspot instance.</td>
−
    </tr>
  −
    <tr>
  −
<td>Enable MAC blocking</td>
  −
<td>off {{!}} on; default: off</td>
  −
<td>Blocks access to MAC addresses that have reached set amount of failed login attempts.</td>
   
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
<td>Logout address</td>
 
<td>Logout address</td>
 
<td>ip; default: '''1.0.0.0'''</td>
 
<td>ip; default: '''1.0.0.0'''</td>
−
<td>IP address to instantly logout a client accessing it.</td>
+
<td>An address that can be used by users to logout from the Hotspot session.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
<td>Protocol</td>
 
<td>Protocol</td>
−
<td>HTTP | <span style="color: #20C0D7;">HTTPS</span>; default: <b>HTTP</b></td>
+
<td>HTTP | HTTPS; default: <b>HTTP</b></td>
 
<td>Protocol to be used for landing page.</td>
 
<td>Protocol to be used for landing page.</td>
 
     </tr>
 
     </tr>
Line 204: Line 149:  
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
<td><span style="color: #f43b1a;">Group</span></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>Specifies the group of trial users.</td>
+
<td>Group of trial users.</td>
−
    </tr>
  −
    <tr>
  −
<td>Subdomain</td>
  −
<td>string; default: <b>none</b></td>
  −
<td>Combined with Domain to make a DNS alias for the Hotspot IP address.</td>
  −
    </tr>
  −
    <tr>
  −
<td>Domain</td>
  −
<td>string; default: <b>none</b></td>
  −
<td>Combined with Subdomain to make a DNS alias for the Hotspot IP address.</td>
   
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 239: Line 174:  
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
<td>Primary DNS server</td>
+
<td>DNS server 1</td>
 
<td>ip; default: <b>8.8.8.8</b></td>
 
<td>ip; default: <b>8.8.8.8</b></td>
 
<td>Additional DNS servers that are to be used by the Hotspot.</td>
 
<td>Additional DNS servers that are to be used by the Hotspot.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
<td>Secondary DNS server</td>
+
<td>DNS server 2</td>
 
<td>ip; default: <b>8.8.4.4</b></td>
 
<td>ip; default: <b>8.8.4.4</b></td>
 
<td>Additional DNS servers that are to be used by the Hotspot.</td>
 
<td>Additional DNS servers that are to be used by the Hotspot.</td>
Line 254: Line 189:  
<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_v1.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_hotspot_general_hotspot_instances_general_settings_radius.png|border|class=tlt-border]]
    
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 316: Line 251:  
Format of address is <b>website.com</b> (does not include https://www).
 
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_v1.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_hotspot_general_hotspot_instances_general_settings_walled_garden.png|border|class=tlt-border]]
−
 
  −
<table class="nd-mantable">
  −
    <tr>
  −
<th>Field</th>
  −
<th>Value</th>
  −
<th>Description</th>
  −
    </tr>
  −
    <tr>
  −
<td>Address list</td>
  −
<td>domain names (one record per line); default: <b>none</b></td>
  −
<td>List of addresses the client can access without first authenticating. One record per line. See placeholder for accepted formats.</td>
  −
    </tr>
  −
</table>
      
=====URL Parameters=====
 
=====URL Parameters=====
Line 335: Line 257:  
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.
 
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_v1.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">
Line 362: Line 284:  
<td>string; default: <b>none</b></td>
 
<td>string; default: <b>none</b></td>
 
<td>The MAC address of the client trying to gain Internet access.</td>
 
<td>The MAC address of the client trying to gain Internet access.</td>
−
    </tr>
  −
    <tr>
  −
<td>IP</td>
  −
<td>ip default: <b>none</b></td>
  −
<td>The IP Address of the client trying to gain Internet access.</td>
   
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 414: Line 331:  
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.
 
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_v2.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_hotspot_general_hotspot_instances_general_settings_user_scripts.png|border|class=tlt-border]]
−
 
  −
<table class="nd-mantable">
  −
    <tr>
  −
<th>Field</th>
  −
<th>Value</th>
  −
<th>Description</th>
  −
    </tr>
  −
    <tr>
  −
<td>Session up</td>
  −
<td>bash script; default: <b>none</b></td>
  −
<td>Script executed after a session is authorized. Executed with the environment variables (Please refer to the wiki).</td>
  −
    </tr>
  −
    <tr>
  −
<td>Session down</td>
  −
<td>bash script; default: <b>none</b></td>
  −
<td>Script executed after a session has moved from authorized state to unauthorized. Executed with the environment variables (Please refer to the wiki).</td>
  −
    </tr>
  −
    <tr>
  −
<td>User signup</td>
  −
<td>bash script; default: <b>none</b></td>
  −
<td>Script executed after a new user has been created during signup process. Executed with the environment variables (Please refer to the wiki).</td>
  −
    </tr>
  −
</table>
      
==Local Users==
 
==Local Users==
Line 450: Line 344:  
</ol>
 
</ol>
   −
[[File:Networking_rutos_manual_hotspot_local_users_add_button_edit_button_v1.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_hotspot_local_users_add_button_edit_button.png|border|class=tlt-border]]
    
==Landing Page==
 
==Landing Page==
Line 466: Line 360:  
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.
 
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_v1.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_hotspot_landing_page_themes__download_edit_button.png|border|class=tlt-border]]
    
====Images====
 
====Images====
Line 472: Line 366:  
The <b>Images</b> section allows you to upload custom images to different objects.
 
The <b>Images</b> section allows you to upload custom images to different objects.
   −
[[File:Networking_rutos_manual_hotspot_landing_page_themes_images_v2.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_hotspot_landing_page_themes_images.png|border|class=tlt-border]]
    
====Style Settings====
 
====Style Settings====
 
----
 
----
   −
Pressing 'Edit' button next to style settings lets you edit how your
+
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.
 
landing page will look visually using CSS syntax.
   −
[[File:Networking_rutos_manual_hotspot_landing_page_themes_style_settings_v1.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_hotspot_landing_page_themes_style_settings.png|border|class=tlt-border]]
    
====View Settings====
 
====View Settings====
Line 486: Line 380:  
In <b>View Settings</b> you can access and modify default templates for various parts of landing page and edit their HTML code.
 
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_v1.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_hotspot_landing_page_themes_view_settings.png|border|class=tlt-border]]
    
====Custom Theme====
 
====Custom Theme====
 
----
 
----
−
To use custom theme you can download default theme and edit it's content. Then use 'Browse' button to upload it.
+
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 v2.png|border|class=tlt-border]]
+
[[File:Networking rutos manual hotspot landing page themes upload custom v1.png|border|class=tlt-border]]
    
==User Groups==
 
==User Groups==
Line 503: Line 397:  
</ol>
 
</ol>
   −
[[File:Networking_rutos_manual_hotspot_user_groups_edit_button_v1.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_hotspot_user_groups_edit_button.png|border|class=tlt-border]]
    
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_v3.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">
Line 569: Line 463:  
==User Management==
 
==User Management==
   −
The <b>User sessions</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.
+
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_v1.png|border|class=tlt-border]]
+
[[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.  
 
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_v1.png|border|class=tlt-border]]
+
[[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 =
 
{{#switch: {{{series}}} | TRB1 | TRB2 | TRB5 | RUT30X | TAP100 | TAP200 | OTD140 | TRB2M | RUT301 =
Retrieved from "https://wiki.teltonika-networks.com/view/Special:MobileDiff/123797...120914"