Template:Networking rutos manual hotspot: Difference between revisions

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.

The <b>Hotspot Instances</b> section displays the main parameters of your Hotspot. By default, a Hotspot instance does not exist on the device. To create a new instance and begin configuration:

    <li>click the 'Edit' button next to the newly added Hotspot instance.</li>

[[File:Networking_rutos_manual_hotspot_hotspot_instances_add_button_edit_buton_wifi_{{{wifi}}}.png|border|class=tlt-border]]

The <b>General Settings</b> window is where most of the Hotspot configuration takes place. Look to the sub-sections below for information on configuration fields found in the General Settings sections.

=====General=====

[[File:Networking_rutos_manual_hotspot_general_hotspot_instances_general_settings_general.png|border|class=tlt-border]]

    <tr>

<th>Field</th>

<th>Value</th>

<th>Description</th>

    </tr>

    <tr>

<td>Enable</td>

<td>off | on; default: <b>on</b></td>

<td>Turns the Hotspot instance on or off.</td>

    </tr>

    <tr>

<td>Hotspot Network</td>

<td>ip/netmask; default: <b>192.168.2.0/24</b></td>

<td>IP address and subnet of the Hotspot network.</td>

    </tr>

    <tr>

<td>IP Address</td>

<td>ip; default: '''192.168.2.254'''</td>

<td>Defines the IP address of your Hotspot router in network.</td>

    </tr>

    <tr>

<td>Authentication mode</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>

    </tr>

    <tr>

<td>Allow signup</td>

<td>off | on; default: <b>off</b></td>

<td>Allows users to sign up to hotspot via landing page.</td>

    </tr>

    <tr>

<td>Landing Page</td>

<td>Internal | External; 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>

    </tr>

    <tr>

<td>UAM Port</td>

<td>integer; default: <b>3990</b></td>

<td>Port to bind for authenticating clients.</td>

    </tr>

    <tr>

<td>UAM Secret</td>

<td>string; default: <b>none</b></td>

<td>Shared secret between uamserver and hotspot.</td>

    </tr>

    <tr>

<td>Success page</td>

<td>Success Page | Original URL | Custom; default: <b>Success page</b></td>

<td>Location to return to after successful authentication.</td>

    </tr>

=====Advanced=====

[[File:Networking_rutos_manual_hotspot_general_hotspot_instances_general_settings_advanced.png|border|class=tlt-border]]

<th>Field</th>

    </tr>

<td>Additional interfaces</td>

<td>Available interfaces; default: '''none'''</td>

<td>Shows additional interfaces that can be attached to hotspot instance.</td>

    </tr>

    <tr>

<td>Logout address</td>

<td>ip; default: '''1.0.0.0'''</td>

<td>An address that can be used by users to logout from the Hotspot session.</td>

    </tr>

    <tr>

<td>Protocol</td>

<td>HTTP | HTTPS; default: <b>HTTP</b></td>

<td>Protocol to be used for landing page.</td>

    </tr>

    <tr>

<td>Enable TOS</td>

<td>off | on; default: <b>off</b></td>

<td>Enables Terms of Service (ToS) requirement. Client device will be able to access the Internet only after agreeing ToS.</td>

    </tr>

    <tr>

<td>Trial access</td>

<td>off | on; default: <b>off</b></td>

<td>Enables trial internet access for a specific group.</td>

    </tr>

    <tr>

<td><span style="color: tomato;">Trial access: </span>Group</td>

<td>User group; default: <b>default<b/>td>

<td>Group of trial users.</td>

    </tr>

    <tr>

<td>HTTPS to landing page redirect</td>

<td>off | on; default: <b>off</b></td>

<td>Redirect initial pre-landing page HTTPS requests to hotspot landing page.</td>

    </tr>

    <tr>

<td>DNS server 1</td>

<td>ip; default: <b>8.8.8.8</b></td>

<td>Additional DNS servers that are to be used by the Hotspot.</td>

    </tr>

    <tr>

<td>DNS server 2</td>

<td>ip; default: <b>8.8.4.4</b></td>

<td>Additional DNS servers that are to be used by the Hotspot.</td>

    </tr>

=====Radius=====

[[File:Networking_rutos_manual_hotspot_general_hotspot_instances_general_settings_radius.png|border|class=tlt-border]]

    <tr>

<td>RADIUS server #1</td>

<td>ip; default: <b>none</b></td>

<td>The IP address of the RADIUS server #1 that is to be used for Authenticating your wireless clients.</td>

    </tr>

    <tr>

<td>RADIUS server #2</td>

<td>ip; default: <b>none</b></td>

<td>The IP address of the RADIUS server #2 that is to be used for Authenticating your wireless clients.</td>

    </tr>

    <tr>

<td>Authentication port</td>

<td>integer [0..65535]; default: <b>1812</b></td>

<td>RADIUS server authentication port.</td>

    </tr>

    <tr>

<td>Accounting port</td>

<td>integer [0..65535]; default: <b>1813</b> </td>

<td>RADIUS server accounting port.</td>

    </tr>

    <tr>

<td>NAS identifier</td>

<td>string; default: <b>none</b></td>

<td>NAS-Identifier is one of the basic RADIUS attributes.</td>

    </tr>

    <tr>

<td>Radius secret key</td>

<td>string; default: <b>none</b></td>

<td>The secret key is a password used for authentication with the RADIUS server.</td>

    </tr>

    <tr>

<td>Swap octets</td>

<td>off | on; default: <b>off</b></td>

<td>Swaps the meaning of input octets and output as it relates to RADIUS attributes.</td>

    </tr>

    <tr>

<td>Location name</td>

<td>string; default: <b>none</b></td>

<td>Custom location name for your Hotspot.</td>

    </tr>

    <tr>

<td>Location ID</td>

<td>string; default: <b>none</b></td>

<td>Custom location ID for your Hotspot.</td>

    </tr>

=====Walled Garden=====

[[File:Networking_rutos_manual_hotspot_general_hotspot_instances_general_settings_walled_garden.png|border|class=tlt-border]]

=====User Scripts=====

[[File:Networking_rutos_manual_hotspot_general_hotspot_instances_general_settings_user_scripts.png|border|class=tlt-border]]

The <b>Users Configuration</b> tab is used to create new, unique users that can connect to the Hotspot.

    <tr>

<th>Field</th>

<th>Value</th>

<th>Description</th>

    </tr>

    <tr>

<td>Name</td>

<td>string; default: <b>none</b></td>

<td>A custom user name used to authenticate clients connecting to the Hotspot.</td>

    </tr>

    <tr>

<td>Password</td>

<td>string; default: <b>none</b></td>

<td>A custom password for the specified user name.</td>

    </tr>

    <tr>

<td>Group</td>

<td>string; default: <b>default</b></td>

<td>After adding user select group that it will be assigned to. Group describes connection speeds and download/upload limits. The 'default' group settings have no restrictions. More on User Groups in the next section.</td>

    </tr>

<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 edit this group or create a new by entering a custom name and clicking the 'Add' button.