RUT240 Hotspot: Difference between revisions

From Teltonika Networks Wiki
VisualWikitext
No edit summary
(Replaced content with "{{Template: Networking_device_manual_hotspot | name = RUT240 | series = RUT2 }}")
Tag: Replaced
Line 1: Line 1:
{{Template: Networking_rutxxx_manual_fw_disclosure
{{Template: Networking_device_manual_hotspot
| fw_version = RUT2XX_R_00.01.12
| name    = RUT240
| series  = RUT2
}}
}}
==Summary==
Wireless '''Hotspots''' are essentially Wireless Access Points - they provide network and/or internet access to other WiFi devices. The difference is that Hotspots are a lot more versatile when it comes to managing, monitoring and authenticating the wireless network's users. For example, while Wireless APs can be password protected, with Hotspots you can configure different users with different names, passwords, even data limits and data speeds and more. This chapter is an overview of the '''Wireless Hotspot''' function in RUT routers.
==General==
The '''General''' tab is where most of the Hotspot configurations take place. This section will be divided into six sub-sections - one for each '''Authentication mode''', since the chosen '''Authentication mode''' will define how the Hotspot will be configured in general.
===External Radius===
----
'''External Radius''' authentication mode uses an external Radius server, to which you have to provide an address to, instead of using the router's internal Radius server.
[[File:Services hotspot configuration external v 2.PNG]]
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>Configuration profile</td>
      <td>Custom | Cloud4wi | Hotspotsystem; default: '''Custom'''</td>
      <td>If not set to '''Custom''', Configuration profile selections will automatically fill all the fields in accordance with the chosen profile. It also automatically adds an exception for the chosen service in the '''Walled Garden''' section. Used only with '''External radius''' Authentication mode. </td>
    </tr>
    <tr>
      <td>Enable</td>
      <td>yes | no; default: '''no'''</td>
      <td>Toggles Wi-Fi Hotspot ON or OFF</td>
    </tr>
    <tr>
    <td>AP IP</td>
        <td>ip; default: '''192.168.2.254/24'''</td>
        <td>Access Point IP address defines the IP address of your Hotspot's network</td>
    </tr>
    <tr>
    <td>Logout address</td>
        <td>host | ip; default: '''1.1.1.1'''</td>
        <td>An address that can be used by users to logout from the Hotspot session</td>
    </tr>
    <tr>
      <td>Authentication mode</td>
      <td>External radius | Internal radius | Without radius | Advertisement | MAC auth | SMS OTP; default: '''Without radius'''</td>
      <td>Authentication mode defines how users will connect to the Hotspot</td>
    </tr>
    <tr>
      <td>Authentication protocol</td>
      <td>PAP | CHAP; default: '''PAP'''</td>
      <td>Authentication protocol used to authenticate new connections on the Hotspot</td>
    </tr>
    <tr>
    <td>Terms of service</td>
        <td>yes | no; default: '''no'''</td>
        <td>If enabled, users have to agree to the Terms of service before logging in. Custom Terms of service can be defined in the '''Landing Page''' section</td>
    </tr>
    <tr>
    <td>RADIUS server #1 | RADIUS server #2</td>
        <td>ip; default: <b>none</b></td>
        <td>The IP address of the RADIUS server that is to be used for Authenticating your wireless clients </td>
    </tr>
    <tr>
      <td>Authentication port</td>
      <td>integer [0..65535]; default: '''1812'''</td>
      <td>RADIUS server authentication port</td>
    </tr>
    <tr>
      <td>Accounting port</td>
      <td>integer [0..65535]; default: '''1813''' </td>
      <td>RADIUS server accounting port</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>UAM port</td>
      <td>integer [0..65535]; default: '''3990'''</td>
      <td>Port to bind for authenticating clients</td>
    </tr>
    <tr>
      <td>UAM UI port</td>
      <td>integer [0..65535]; default: '''4990'''</td>
      <td>UAM User Interface port</td>
    </tr>
    <tr>
    <td>UAM secret</td>
        <td>string; default: <b>none</b></td>
        <td>Shared secret between the UAM server and the Hotspot</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>Swap octets</td>
      <td>yes | no; default: '''no'''</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>External landing page</td>
        <td>yes | no; default: '''no'''</td>
        <td>Enables the use of an external landing page</td>
    </tr>
    <tr>
    <td>Landing page address</td>
        <td>string; default: <b>none</b></td>
        <td>A custom Hotspot's external landing page</td>
    </tr>
    <tr>
    <td>Success URL</td>
        <td>string; default: <b>none</b></td>
        <td>A custom redirect URL after successful Hotspot login</td>
    </tr>
    <tr>
      <td>Protocol</td>
      <td>HTTP | HTTPS; default: '''HTTP'''</td>
      <td>Connection protocol of your Hotspot</td>
    </tr>
    <tr>
    <td>HTTPS to landing page redirect</td>
        <td>yes | no; default: '''no'''</td>
        <td>Redirects HTTP pages to landing page</td>
    </tr>
    <tr>
    <td>SSL key file</td>
        <td>.key file; default: <b>none</b></td>
        <td>SSL key file used for authentication. This field becomes visible only if '''HTTPS to landing page redirect''' is enabled</td>
    </tr>
    <tr>
    <td>SSL certificate file</td>
        <td>.crt file; default: <b>none</b></td>
        <td>SSL certificate file used for authentication. This field becomes visible only if '''HTTPS to landing page redirect''' is enabled</td>
    </tr>
    <tr>
    <td>Use custom DNS</td>
        <td>yes | no; default: '''no'''</td>
        <td>Enables the use of custom DNS servers instead of your regular DNS</td>
    </tr>
    <tr>
    <td>DNS server 1 | DNS server 2</td>
        <td>ip; default: <b>none</b></td>
        <td>Additional DNS servers that are to be used by the Hotspot. These fields become visible only if '''Use custom DNS''' is enabled</td>
    </tr>
</table>
===Internal Radius===
----
'''Internal Radius''' is Authentication mode that uses the router's internal RADIUS server for authentication. Teltonika routers' RADIUS server has RFC 2866 RADIUS Accounting and RFC 2869 RADIUS Extensions implemented.
[[File:Services hotspot configuration internal v 2.PNG]]
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>Configuration profile</td>
      <td>Custom | Cloud4wi | Hotspotsystem; default: '''Custom'''</td>
      <td>If not set to '''Custom''', Configuration profile selections will automatically fill all the fields in accordance with the chosen profile. It also automatically adds an exception for the chosen service in the '''Walled Garden''' section. Used only with '''External radius''' Authentication mode.</td>
    </tr>
    <tr>
      <td>Enable</td>
      <td>yes | no; default: '''no'''</td>
      <td>Toggles Wi-Fi Hotspot ON or OFF</td>
    </tr>
    <tr>
    <td>AP IP</td>
        <td>ip; default: '''192.168.2.254/24'''</td>
        <td>Access Point IP address defines the IP address of your Hotspot's network</td>
    </tr>
    <tr>
    <td>Logout address</td>
        <td>host | ip; default: '''1.1.1.1'''</td>
        <td>An address that can be used by users to logout from the Hotspot session</td>
    </tr>
    <tr>
      <td>Authentication mode</td>
      <td>External radius | Internal radius | Without radius | Advertisement | MAC auth | SMS OTP; default: '''Without radius'''</td>
      <td>Authentication mode defines how users will connect to the Hotspot</td>
    </tr>
    <tr>
      <td>Terms of service</td>
      <td>yes | no; default: '''no'''</td>
      <td>If enabled, users have to agree to the Terms of service before logging in. Custom Terms of service can be defined in the '''Landing Page''' section</td>
    </tr>
    <tr>
    <td>External landing page</td>
        <td>yes | no; default: '''no'''</td>
        <td>Enables the use of an external landing page</td>
    </tr>
    <tr>
    <td>Landing page address</td>
        <td>string; default: <b>none</b></td>
        <td>A custom Hotspot's external landing page</td>
    </tr>
    <tr>
    <td>Success URL</td>
        <td>string; default: <b>none</b></td>
        <td>A custom redirect URL after successful Hotspot login</td>
    </tr>
    <tr>
      <td>HTTPS to landing page redirect</td>
      <td>yes | no; default: '''no'''</td>
      <td>Redirects HTTP pages to landing page</td>
    </tr>
    <tr>
      <td>SSL key file</td>
      <td>.key file; default: <b>none</b></td>
      <td>SSL key file used for authentication. This field becomes visible only if '''HTTPS to landing page redirect''' is enabled</td>
    </tr>
    <tr>
    <td>SSL certificate file</td>
        <td>.crt file; default: <b>none</b></td>
        <td>SSL certificate file used for authentication. This field becomes visible only if '''HTTPS to landing page redirect''' is enabled</td>
    </tr>
    <tr>
    <td>Use custom DNS</td>
        <td>yes | no; default: '''no'''</td>
        <td>Enables the use of custom DNS servers instead of your regular DNS</td>
    </tr>
    <tr>
    <td>DNS server 1 | DNS server 2</td>
        <td>ip; default: <b>none</b></td>
        <td>Additional DNS servers that are to be used by the Hotspot. These fields become visible only if '''Use custom DNS''' is enabled</td>
    </tr>
</table>
Information on how to configure Internal radius server can be found [[#Radius_Server|here]].
===Without Radius===
----
'''Without Radius''' Authentication doesn't use a Radius server to authenticate users connecting to the Hotspot, instead it gives you the possibility to configure different users with different password and session parameters.
[[File:Services hotspot configuration without v 2.PNG]]
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>Configuration profile</td>
      <td>Custom | Cloud4wi | Hotspotsystem; default: '''Custom'''</td>
      <td>If not set to '''Custom''', Configuration profile selections will automatically fill all the fields in accordance with the chosen profile. It also automatically adds an exception for the chosen service in the '''Walled Garden''' section. Used only with '''External radius''' Authentication mode.</td>
    </tr>
    <tr>
      <td>Enable</td>
      <td>yes | no; default: '''no'''</td>
      <td>Toggles Wi-Fi Hotspot ON or OFF</td>
    </tr>
    <tr>
    <td>AP IP</td>
        <td>ip; default: '''192.168.2.254/24'''</td>
        <td>Access Point IP address defines the IP address of your Hotspot's network</td>
    </tr>
    <tr>
    <td>Logout address</td>
        <td>host | ip; default: '''1.1.1.1'''</td>
        <td>An address that can be used by users to logout from the Hotspot session</td>
    </tr>
    <tr>
      <td>Authentication mode</td>
      <td>External radius | Internal radius | Without radius | Advertisement | MAC auth | SMS OTP; default: '''Without radius'''</td>
      <td>Authentication mode defines how users will connect to the Hotspot</td>
    </tr>
    <tr>
      <td>Terms of service</td>
      <td>yes | no; default: '''no'''</td>
      <td>If enabled, users have to agree to the Terms of service before logging in. Custom Terms of service can be defined in the '''Landing Page''' section</td>
    </tr>
    <tr>
    <td>External landing page</td>
        <td>yes | no; default: '''no'''</td>
        <td>Enables the use of an external landing page</td>
    </tr>
   
    <tr>
    <td>Landing page address</td>
        <td>string; default: <b>none</b></td>
        <td>A custom Hotspot's external landing page</td>
    </tr>
    <tr>
    <td>Success URL</td>
        <td>string; default: <b>none</b></td>
        <td>A custom redirect URL after successful Hotspot login</td>
    </tr>
    <tr>
    <td>Protocol</td>
        <td>HTTP | HTTPS; default: '''HTTP'''</td>
        <td>Connection protocol of your Hotspot</td>
    </tr>
    <tr>
      <td>HTTPS to landing page redirect</td>
      <td>yes | no; default: '''no'''</td>
      <td>Redirects HTTP pages to landing page</td>
    </tr>
    <tr>
      <td>SSL key file</td>
      <td>.key file; default: <b>none</b></td>
      <td>SSL key file used for authentication. This field becomes visible only if '''HTTPS to landing page redirect''' is enabled</td>
    </tr>
    <tr>
    <td>SSL certificate file</td>
        <td>.crt file; default: <b>none</b></td>
        <td>SSL certificate file used for authentication. This field becomes visible only if '''HTTPS to landing page redirect''' is enabled</td>
    </tr>
    <tr>
    <td>Use custom DNS</td>
        <td>yes | no; default: '''no'''</td>
        <td>Enables the use of custom DNS servers instead of your regular DNS</td>
    </tr>
    <tr>
    <td>DNS server 1 | DNS server 2</td>
        <td>ip; default: <b>none</b></td>
        <td> Additional DNS servers that are to be used by the Hotspot. These fields become visible only if '''Use custom DNS''' is enabled</td>
    </tr>
</table>
====Users Configuration====
----
The '''Users Configuration''' tab is used to create new, unique users that can connect to the Hotspot.
[[File:Services hotspot configuration user.PNG]]
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>Username</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>Session Template</td>
        <td>string; default: '''unlimited'''</td>
        <td>Session templates define session settings for different users. The '''unlimited''' Session Template is a default template with no restrictions. More on Session Template in the next section</td>
    </tr>
</table>
====Session Templates====
----
A '''Session Template''' is a set of rules that can be prescribed to a Hotspot user. A default template named '''unlimited''' is present in the router, but it has no configured restrictions. You can edit the default template or you can create a custom template and configure it.
[[File:Services hotspot configuration session template.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>Session timeout</td>
      <td>integer; default: <b>none</b></td>
      <td>A timeout in seconds after users are automatically disconnected from the Hotspot. The timeout countdown begins when a user is authenticated to the Hotspot and, after an amount of time specified in this field, the user gets disconnected from the Hotspot. 0 means 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 Kbit/s, Mbit/s, Gbit/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 Kbit/s, Mbit/s or Gbit/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>Period</td>
        <td>Month | Week | Day; default: '''Month'''</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 | Start hour</td>
        <td>integer [1..31] | Monday..Sunday | integer [1..24]; default: '''day 1'''</td>
        <td>Specifies which day of the month, week or hour of the day the limits will be reset</td>
    </tr>
</table>
===Advertisement===
----
The '''Advertisement''' Authentication mode doesn't use any kind of actual authentication. Instead when a user connects to the Hotspot he first gets redirected to a specified advertisement page. After that the user is free to use the Hotspot.
[[File:Services_hotspot_configuration_advertisement_v3.PNG|border|class=tlt-border]]
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>Configuration profile</td>
      <td>Custom | Cloud4wi | Hotspotsystem; default: '''Custom'''</td>
      <td>If not set to '''Custom''', Configuration profile selections will automatically fill all the fields in accordance with the chosen profile. It also automatically adds an exception for the chosen service in the '''Walled Garden''' section. Used only with '''External radius''' Authentication mode.</td>
    </tr>
    <tr>
      <td>Enable</td>
      <td>yes | no; default: '''no'''</td>
      <td>Toggles Wi-Fi Hotspot ON or OFF</td>
    </tr>
    <tr>
    <td>AP IP</td>
        <td>ip; default: '''192.168.2.254/24'''</td>
        <td>Access Point IP address defines the IP address of your Hotspot's network</td>
    </tr>
    <tr>
    <td>Authentication mode</td>
        <td>External radius | Internal radius | Without radius | Advertisement | MAC auth | SMS OTP; default: '''Without radius'''</td>
        <td>Authentication mode defines how users will connect to the Hotspot</td>
    </tr>
    <tr>
      <td>Advertisement address</td>
      <td>host | ip; default: <b>none</b></td>
      <td>The address of the advertisement page that newly connected users will be redirected to</td>
    </tr>
    <tr>
      <td>HTTPS to landing page redirect</td>
      <td>yes | no; default: '''no'''</td>
      <td>Redirects HTTP pages to landing page</td>
    </tr>
    <tr>
    <td>SSL key file</td>
        <td>.key file; default: <b>none</b></td>
        <td>SSL key file used for authentication. This field becomes visible only if '''HTTPS to landing page redirect''' is enabled </td>
    </tr>
    <tr>
    <td>SSL certificate file</td>
        <td>.crt file; default: <b>none</b></td>
        <td>SSL certificate file used for authentication. This field becomes visible only if '''HTTPS to landing page redirect''' is enabled</td>
    </tr>
    <tr>
    <td>Use custom DNS</td>
        <td>yes | no; default: '''no'''</td>
        <td>Enables the use of custom DNS servers instead of your regular DNS</td>
    </tr>
    <tr>
    <td>DNS server 1 | DNS server 2</td>
        <td>ip; default: <b>none</b></td>
        <td>Additional DNS servers that are to be used by the Hotspot. These fields become visible only if '''Use custom DNS''' is enabled</td>
    </tr>
</table>
===MAC auth===
----
'''MAC auth''' Authentication mode authenticates users by their MAC address. A list of accepted or unaccepted MAC addresses can be configured in the router's WebUI's Wireless section under Interface Configuration->[[Wireless#MAC_Filter|MAC Filter]]
[[File:Services hotspot configuration mac v 2.PNG| border | class=tlt-border]]
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>Configuration profile</td>
      <td>Custom | Cloud4wi | Hotspotsystem; default: '''Custom'''</td>
      <td>If not set to '''Custom''', Configuration profile selections will automatically fill all the fields in accordance with the chosen profile. It also automatically adds an exception for the chosen service in the '''Walled Garden''' section. Used only with '''External radius''' Authentication mode.</td>
    </tr>
    <tr>
      <td>Enable</td>
      <td>yes | no; default: '''no'''</td>
      <td>Toggles Wi-Fi Hotspot ON or OFF</td>
    </tr>
    <tr>
    <td>AP IP</td>
        <td>ip; default: '''192.168.2.254/24'''</td>
        <td>Access Point IP address defines the IP address of your Hotspot's network</td>
    </tr>
    <tr>
    <td>Logout address</td>
        <td>host | ip; default: '''1.1.1.1'''</td>
        <td>An address that can be used by users to logout from the Hotspot session</td>
    </tr>
    <tr>
      <td>Authentication mode</td>
      <td>External radius | Internal radius | Without radius | Advertisement | MAC auth | SMS OTP; default: '''Without radius'''</td>
      <td>Authentication mode defines how users will connect to the Hotspot</td>
    </tr>
    <tr>
      <td>Terms of service</td>
      <td>yes | no; default: '''no'''</td>
      <td>If enabled, users have to agree to the Terms of service before logging in. Custom Terms of service can be defined in the '''Landing Page''' section</td>
    </tr>
    <tr>
    <td>Password protection</td>
        <td>yes | no; default: '''no'''</td>
        <td>Enables Hotspot password protection</td>
    </tr>
    <tr>
    <td>Password</td>
        <td>string; default: <b>none</b></td>
        <td>A password used to authenticate connecting clients to the Hotspot</td>
    </tr>
    <tr>
      <td>Website access link</td>
      <td>Link | Auto redirect | Custom address; default: '''Link'''</td>
      <td>Requested website access mode</td>
    </tr>
    <tr>
      <td>Protocol</td>
      <td>HTTP | HTTPS; default: '''HTTP'''</td>
      <td>Connection protocol of your Hotspot</td>
    </tr>
    <tr>
    <td>HTTPS to landing page redirect</td>
        <td>yes | no; default: '''no'''</td>
        <td>Redirects HTTP pages to landing page</td>
    </tr>
    <tr>
    <td>SSL key file</td>
        <td>.key file; default: <b>none</b></td>
        <td>SSL key file used for authentication. This field becomes visible only if '''HTTPS to landing page redirect''' is enabled</td>
    </tr>
    <tr>
      <td>SSL certificate file</td>
      <td>.crt file; default: <b>none</b></td>
      <td>SSL certificate file used for authentication. This field becomes visible only if '''HTTPS to landing page redirect''' is enabled</td>
    </tr>
    <tr>
    <td>Use custom DNS</td>
        <td>yes | no; default: '''no'''</td>
        <td>Enables the use of custom DNS servers instead of your regular DNS</td>
    </tr>
    <tr>
    <td>DNS server 1 | DNS server 2</td>
        <td>ip; default: <b>none</b></td>
        <td>Additional DNS servers that are to be used by the Hotspot. These fields become visible only if '''Use custom DNS''' is enabled</td>
    </tr>
</table>
===SMS OTP===
----
With '''SMS OTP''' Authentication mode connecting users are prompted to enter their phone number. After that, the router sends and SMS message containing a code to the specified number. Users then authenticate themselves to the Hotspot using this code.
[[File:Services hotspot configuration sms v 2.PNG |border| class=tlt-border]]
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>Configuration profile</td>
      <td>Custom | Cloud4wi | Hotspotsystem; default: '''Custom'''</td>
      <td>If not set to '''Custom''', Configuration profile selections will automatically fill all the fields in accordance with the chosen profile. It also automatically adds an exception for the chosen service in the '''Walled Garden''' section. Used only with '''External radius''' Authentication mode.</td>
    </tr>
    <tr>
      <td>Enable</td>
      <td>yes | no; default: '''no'''</td>
      <td>Toggles Wi-Fi Hotspot ON or OFF</td>
    </tr>
    <tr>
    <td>AP IP</td>
        <td>ip; default: '''192.168.2.254/24'''</td>
        <td>Access Point IP address defines the IP address of your Hotspot's network</td>
    </tr>
    <tr>
    <td>Authentication mode</td>
        <td>External radius | Internal radius | Without radius | Advertisement | MAC auth | SMS OTP; default: '''Without radius'''</td>
        <td>Authentication mode defines how users will connect to the Hotspot</td>
    </tr>
    <tr>
      <td>Protocol</td>
      <td>HTTP | HTTPS; default: '''HTTP'''</td>
      <td>Connection protocol of your Hotspot</td>
    </tr>
    <tr>
      <td>HTTPS to landing page redirect</td>
      <td>yes | no; default: '''no'''</td>
      <td>Redirects HTTP pages to landing page</td>
    </tr>
    <tr>
    <td>SSL key file</td>
        <td>.key file; default: <b>none</b></td>
        <td>SSL key file used for authentication. This field becomes visible only if '''HTTPS to landing page redirect''' is enabled</td>
    </tr>
    <tr>
    <td>SSL certificate file</td>
        <td>.crt file; default: <b>none</b></td>
        <td>SSL certificate file used for authentication. This field becomes visible only if '''HTTPS to landing page redirect''' is enabled</td>
    </tr>
    <tr>
    <td>Use custom DNS</td>
        <td>yes | no; default: '''no'''</td>
        <td>Enables the use of custom DNS servers instead of your regular DNS</td>
    </tr>
    <tr>
    <td>DNS server 1 | DNS server 2</td>
        <td>ip; default: <b>none</b></td>
        <td>Additional DNS servers that are to be used by the Hotspot. These fields become visible only if '''Use custom DNS''' is enabled</td>
    </tr>
</table>
===Walled Garden===
----
You can configure a list of addresses that users connected to the Hotspot will be able to reach without any authentication. By default this list is empty. Click the '''Add''' button to add a new address.
[[File:Services hotspot configuration walled garden.png| border| class=tlt-border]]
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>Enable</td>
      <td>yes | no; default: '''yes'''</td>
      <td>Enables or disables an entry of the list</td>
    </tr>
    <tr>
      <td>Address</td>
      <td>host | ip; default: <b>none</b></td>
      <td>An address that users connected to the Hotspot can reach without authentication</td>
    </tr>
    <tr>
    <td>Port</td>
        <td>integer [0..65535]; default: <b>none</b></td>
        <td>Specifies the port through which the user can connect to the provided address. This field becomes visible only if '''Allow subdomains''' is disabled</td>
    </tr>
    <tr>
    <td>Allow subdomains</td>
        <td>yes | no; default: '''no'''</td>
        <td>If checked, users can connect to the specified address and all of its subdomains</td>
    </tr>
</table>
==Restricted Internet Access==
The '''Restricted Internet Access''' page provides you with the possibility to restrict internet access on Hotspot on specified hours. Blue squares represent restricted access, white squares - allowed access. Bellow is an example of a configuration that restricts internet access outside of working hours.
[[File:Services hotspot restricted list.PNG|border|class=tlt-border]]
==Logging==
The Hotspot '''Logging''' section is used to send Hotspot or Wireless information to an FTP or Syslog server.
[[File:Services hotspot logging configuration logging.PNG|border| class=tlt-border]]
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>Enable</td>
      <td>yes | no; default: '''no'''</td>
      <td> Enables or disables whole logging section's fuctionality  </td>
    </tr>
</table>
[[File:Services hotspot logging configuration syslog.PNG|border| class=tlt-border]]
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>Enable</td>
      <td>yes | no; default: '''no'''</td>
      <td>Toggles logging to Syslog ON or OFF  </td>
    </tr>
    <tr>
      <td>Server address</td>
      <td>host | ip; default: '''" "'''</td>
      <td>Syslog server address</td>
    </tr>
    <tr>
    <td>Port</td>
        <td>integer [0..65535]; default: '''" "'''</td>
        <td>Syslog server port</td>
    </tr>
    <tr>
    <td>Protocol</td>
        <td>UDP|TCP default: '''TCP'''</td>
        <td>Protocol of the syslog server</td>
    </tr>
    <tr>
    <td>Prefix text</td>
        <td>string; default: '''" "''' </td>
        <td>Prefix custom text to streamed messages</td>
    </tr>
    <tr>
    <td>Protocol filter</td>
        <td>UDP|TCP|Any; default: '''Any'''</td>
        <td>Filter log messages depending on protocol</td>
    </tr>
    <tr>
    <td>Port filter </td>
        <td>integer [0..65535]; default: '''" "'''</td>
        <td>Filter log messages depending on port of port range</td>
    </tr>
</table>
[[File:Services hotspot logging configuration ftp.PNG|border| class=tlt-border]]
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>Enable</td>
      <td>yes | no; default: '''no'''</td>
      <td>Toggles logging to FTP ON or OFF</td>
    </tr>
    <tr>
      <td>Server address</td>
      <td>host | ip; default: '''your.ftp.server'''</td>
      <td>FTP server address.</td>
    </tr>
    <tr>
    <td>User name</td>
        <td>string; default: '''username'''</td>
        <td>User name used for authentication when logging into an FTP server</td>
    </tr>
    <tr>
    <td>Password</td>
        <td>string; default: '''password'''</td>
        <td>Password used for authentication when logging into an FTP server</td>
    </tr>
    <tr>
    <td>Port</td>
        <td>integer [0..65535]; default: '''21''' </td>
        <td>FTP server port</td>
    </tr>
    <tr>
    <td>File name extras</td>
        <td>No extra information | MAC address | Serial number | Custom string; default: '''No extra information'''</td>
        <td>Extra information to be added to the log filename</td>
    </tr>
</table>
===FTP Upload Settings===
----
Here you can configure your timing settings for the log upload via FTP feature.
[[File:Services hotspot logging configuration ftp set.PNG|border|class=tlt-border]]
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>Mode</td>
      <td>Fixed | Interval; default: '''Fixed'''</td>
      <td>The scheduling mode to be used for uploading to FTP server</td>
    </tr>
    <tr>
      <td>Hours</td>
      <td>time; default: '''8 hours'''</td>
      <td>Time interval when the uploads will take place</td>
    </tr>
    <tr>
    <td>Minutes</td>
    <td>time;default: '''15 minutes'''</td>
    <td>Time interval when the uploads will take place</td>
    </tr>
    <td>Days</td>
    <td>time;default: '''Monday, Tuesday, Wednesday, Thursday, Friday'''</td>
    <td>On which day upload will take place</td>
    <tr>
    </tr>
</table>
===Wifi Log/SMS OTP Log===
----
WiFi and SMS OTP logs show information about connections to your WiFi Hotspot. FTP logging has to be enabled.
[[File:Services hotspot logging configuration Wifi log.PNG|border|class=tlt-border]]
[[File:Services hotspot logging configuration SMS OTP log.PNG|border|class=tlt-border]]
==Landing Page==
This section is used to define how your Hotspot's Landing Page will look like.
[[File:Services hotspot landing page general.PNG|border|class=tlt-border]]
===Template===
----
This is a template based on the default landing page. You can edit its HTML code to make it look however you want!
[[File:Services hotspot landing page template.PNG|border|class=tlt-border]]
===Custom Landing Page===
----
==Radius Server==
This section is used to configure your '''Radius Server''' for use with '''[[#Internal_Radius|Internal radius]]''' Authentication mode
[[File:Services hotspot radius server.PNG|border|class=tlt-border]]
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>Enable</td>
      <td>yes | no; default: '''no'''</td>
      <td>Toggles Radius Server ON or OFF</td>
    </tr>
    <tr>
      <td>Remote access</td>
      <td>yes | no; default: '''no'''</td>
      <td>Toggles remote access to the Radius Server ON or OFF.</td>
    </tr>
    <tr>
    <td>Accounting port</td>
        <td>integer [0..65535]; default: '''1813'''</td>
        <td>Radius server accounting port </td>
    </tr>
    <tr>
    <td>Authentication port</td>
        <td>integer [0..65535]; default: '''1812'''</td>
        <td>Radius server authentication port</td>
    </tr>
</table>
===Session Settings===
----
A '''Session Template''' is a set of rules that can be prescribed to a Hotspot user. A default template named '''unlimited''' is present in the router, but it has no configured restriction. You can edit the default template or you can create a custom template and configure it.
[[File:Services hotspot configuration session template.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>Session timeout</td>
      <td>integer; default: <b>none</b></td>
      <td>A timeout in seconds after users are automatically disconnected from the Hotspot. The timeout countdown begins when a user is authenticated to the Hotspot and, after an amount of time specified in this field, the user gets disconnected from the Hotspot. 0 means 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 Kbit/s, Mbit/s or Gbit/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 Kbit/s, Mbit/s or Gbit/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>Period</td>
        <td>Month | Week | Day; default: '''Month'''</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 | Start hour</td>
        <td>integer [1..31] | Monday..Sunday | integer [1..24]; default: '''day 1'''</td>
        <td>Specifies which day of the month, week or hour of the day the limits will be reset</td>
    </tr>
</table>
===Users Configuration Settings===
----
The '''Users Configuration''' tab is used to create new, unique users that can connect to the Hotspot.
[[File:Services hotspot configuration user.PNG]]
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>Username</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>Session Template</td>
        <td>string; default: '''unlimited'''</td>
        <td>Session templates define session settings for different users. The '''unlimited''' Session Template is a default template with no restrictions. More on Session Template in the next section</td>
    </tr>
</table>
===Clients Configuration Settings===
----
[[File:Services hotspot radius server clients.PNG|border|class=tlt-border]]
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>Enable</td>
      <td>yes | no; default: '''yes'''</td>
      <td>Toggles Clients Configuration ON or OFF</td>
    </tr>
    <tr>
      <td>Client 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>IP address</td>
        <td>ip; default: <b>none</b></td>
        <td>The IP address of the client </td>
    </tr>
    <tr>
    <td>Netmask</td>
        <td>integer [0..32]; default: <b>none</b></td>
        <td>The netmask of the client</td>
    </tr>
    <tr>
    <td>Radius shared secret</td>
        <td>string; default: <b>none</b></td>
        <td>Radius  shared  secret  used  for  communication  between the client/NAS and the radius server</td>
    </tr>
</table>
==Statistics==
The '''Statistics''' page shows statistics about connections to the hotspot. '''Reminder: Statistics page becomes visible only when device is connected to the hotspot.'''
[[File:Services hotspot stats.PNG|border|class=tlt-border]]
==Manage==
With the help of the '''Manage''' page you manage the users that are connected to your Hotspot. To reach the '''Manage''' window, go to Services->Hotspot. The '''Manage''' button will be located next to your Hotspot instance.
[[File:Services hotspot manage reach.PNG|border|class=tlt-border]]
[[File:Services hotspot manage.PNG|border|class=tlt-border]]
[[Category:RUT240 Services section]]

Revision as of 07:22, 21 October 2020

Main Page > EOL Products > RUT240 > RUT240 Manual > RUT240 WebUI > RUT240 Services section > RUT240 Hotspot

Template:Networking device manual hotspot

Retrieved from "https://wiki.teltonika-networks.com/index.php?title=RUT240_Hotspot&oldid=73659"