31,703
edits
Changes
Template:Networking rutos manual hotspot (view source)
Revision as of 12:00, 19 May 2020
, 12:00, 19 May 2020Created page with "{{Template:Networking_rutos_manual_fw_disclosure | fw_version = {{{series}}}_R_00.02.03.1 | series = {{{series}}} }} ==Summary== '''Hotspot''' is a service that provides..."
{{Template:Networking_rutos_manual_fw_disclosure
| fw_version = {{{series}}}_R_00.02.03.1
| series = {{{series}}}
}}
==Summary==
'''Hotspot''' is a service that provides authentication, authorization and accounting for a network.
{{#ifeq:{{{wifi}}}|1
|
{{{name}}} devices are able to create Hotspot on either Wireless or LAN interface.
Wireless <b>Hotspots</b> 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 {{{name}}} routers. In Services > Hotspot > General tab first choose interface on which you want Hotspot to operate, press '''Add''' and after new hotspot instance appears click on [[File:Networking_rutx_manual_edit_button_v1.png]] to start configuration.
[[File:Network_rutxxx_manual_hotspot_hotspot_instances.png]]
|
{{{name}}} devices are able to create Hotspot on LAN interface.
[[File:Network_rutx10_manual_hotspot_hotspot_instances_v1.png|border|class=tlt-border]]
}}
==General Settings==
The '''General Settings''' window is where most of the Hotspot configurations take place. This section will be divided into sub-sections because configuration for Local authentication and with Radius Server are almost identical, just when Radius is chosen extra tab appears.
====General====
----
[[File:Network_rutxxx_manual_hotspot_general_settings_radius.png]]
<table class="nd-mantable">
<tr>
<th>field name</th>
<th>value</th>
<th>description</th>
</tr>
<tr>
<td>Enable</td>
<td>off {{!}} on; Default: '''on'''</td>
<td>Toggles WiFi Hotspot instance ON or OFF.</td>
</tr>
<tr>
<td>Hotspot Network</td>
<td>IP; Default: '''192.168.2.0/24'''</td>
<td>Defines IP and subnet of Hotspot Network</td>
</tr>
<tr>
<td>IP Adress</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 {{!}}}} MAC auth ; Default: '''Local users'''</td>
<td>Authentication mode defines how users will connect to the Hotspot</td>
</tr><tr><td>Allow signup
</td><td>off | on; Default: '''off'''</td><td>Allows users to sign up to hotspot via landing page.</td></tr><tr>
<td>Landing Page</td>
<td>Internal {{!}} External; Default: '''Internal'''</td>
<td>If external Landing Page is chosen, new section, to enter website address, will appear, e.g. http://www.example.com</td>
</tr>
<tr>
<td>UAM Port</td>
<td>integer; Default: '''3990'''</td>
<td>Port to bind for authenticating clients</td>
</tr>
<tr>
<td>UAM Secret</td>
<td>string; Default: " "</td>
<td>Shared secret between uamserver and hotspot.</td>
</tr>
<tr>
<td>Success page</td>
<td>Success Page {{!}} Original URL {{!}} Custom; Default: '''Success page'''</td>
<td>Location to return to after successful authentication</td>
</tr>
</table>
====Advanced====
----
[[File:Network_rutxxx_manual_hotspot_advanced_settings_radius.png]]
<table class="nd-mantable">
<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: '''HTTP'''</td>
<td>Protocol to be used for landing page</td>
</tr><tr><td>Enable TOS</td><td>off {{!}} on; Default '''off'''</td><td>Enables Terms of Service (ToS) requirement. Cient device will be able to access the Internet only after agreeing ToS.
</td></tr><tr>
<td>HTTPS to landing page redirect</td>
<td>off {{!}} on; Default '''off'''</td>
<td>Redirect initial pre-landing page HTTPS requests to hotspot landing page</td>
</tr>
<tr>
<td>DNS server 1</td>
<td>ip; Default: '''8.8.8.8'''</td>
<td>Additional DNS servers that are to be used by the Hotspot.</td>
</tr>
<tr>
<td>DNS server 2</td>
<td>ip; Default: '''8.8.4.4'''</td>
<td>Additional DNS servers that are to be used by the Hotspot.</td>
</tr></table>
====Radius====
----
'''Radius''' authentication mode uses an external Radius servers, to which you have to provide an address to, instead of using the router's Local Authentication. If you are using Local authentication, you can skip straight to [[{{{name}}}_Hotspot#Walled_Garden|Walled Garden]].
[[File:Network_rutxxx_manual_hotspot_radius_settings_radius.png]]
<table class="nd-mantable">
<tr>
<td>RADIUS server #1</td>
<td>ip; Default: " "</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: " "</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: '''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>NAS identifier</td>
<td>string; Default: " "</td>
<td>NAS-Identifier is one of the basic RADIUS attributes</td>
</tr>
<tr>
<td>Radius secret key</td>
<td>string; Default: " "</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: '''off'''</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: " "</td>
<td>Custom location name for your Hotspot</td>
</tr>
<tr>
<td>Location ID</td>
<td>string; Default: " "</td>
<td>Custom location ID for your Hotspot</td>
</tr>
</table>
====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 in to Address List.
[[File:Network_rutxxx_manual_hotspot_general_walled_garden.png]]
====User Scripts====
----
In this tab you can add Scripts that will be executed after a session is authorized in '''Session up''' section and Scripts that will be executed after session has moved from authorized state to unauthorized in '''Session down''' section.
[[File:Network_rutxxx_manual_hotspot_user_scripts_radius.png]]
==Local Users==
The '''Users Configuration''' tab is used to create new, unique users that can connect to the Hotspot.
[[File:Network_rutxxx_manual_hotspot_local_users.png]]
<table class="nd-mantable">
<tr>
<th>field name</th>
<th>value</th>
<th>description</th>
</tr>
<tr>
<td>Name</td>
<td>string; Default: " "</td>
<td>A custom user name used to authenticate clients connecting to the Hotspot</td>
</tr>
<tr>
<td>Password</td>
<td>string; Default: " "</td>
<td>A custom password for the specified user name</td>
</tr>
<tr>
<td>Group</td>
<td>string; Default: '''default'''</td>
<td>After adding user select group that it will be assigned to. Group describes connection speeds and dowload/upload limits. The '''default''' group settings have no restrictions. More on User Groups in the next section</td>
</tr>
</table>
==User Groups==
'''User Groups''' lets set different connection limitats for different users. Group '''default''' is already created and does not have any limitations set. To create new group simply enter the name and press Add.
[[File:Network_rutxxx_manual_hotspot_user_groups.png]]
After adding a group it will not have any limits set, so press edit [[File:Networking rutx manual edit button v1.png]]. In following window you will be able to configure yours User Group.
[[File:Network_rutxxx_manual_hotspot_user_group_settings.png]]
<table class="nd-mantable">
<tr>
<th>field name</th>
<th>value</th>
<th>description</th>
</tr>
<tr>
<td>Idle timeout</td>
<td>integer; Default: " "</td>
<td>A timeout in seconds after which idle users are automatically disconnected from the Hotspot. (0 means unlimited)</td>
</tr>
<tr>
<td>Time limit</td>
<td>integer; Default: " "</td>
<td>Disables hotspot user after time limit in sec is reached. (0, meaning unlimited)</td>
</tr>
<tr>
<td>Download bandwidth</td>
<td>integer; Default: " "</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>
</tr>
<tr>
<td>Upload bandwidth</td>
<td>integer; Default: " "</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>
</tr>
<tr>
<td>Download limit</td>
<td>integer; Default: " "</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: " "</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</td>
<td>integer [1..31] {{!}} Monday..Sunday {{!}} integer [1..24]; Default: '''1'''</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>
<td>Expiration time</td>
<td>integer; Default: '''0'''</td>
<td>Expiration time in sec (0 means unlimited). Only for dynamically created users.</td>
</tr>
</table>
==Landing Page==
This section is used to define how your Hotspot's Landing Page will look like.
===General Settings===
----
'''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>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]]
====Images====
----
The <b>Images</b> section allows you to upload custom images to different objects.
[[File:Network_rutxxx_manual_hotspot_landing_page_themes_images_v1.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: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]]
| fw_version = {{{series}}}_R_00.02.03.1
| series = {{{series}}}
}}
==Summary==
'''Hotspot''' is a service that provides authentication, authorization and accounting for a network.
{{#ifeq:{{{wifi}}}|1
|
{{{name}}} devices are able to create Hotspot on either Wireless or LAN interface.
Wireless <b>Hotspots</b> 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 {{{name}}} routers. In Services > Hotspot > General tab first choose interface on which you want Hotspot to operate, press '''Add''' and after new hotspot instance appears click on [[File:Networking_rutx_manual_edit_button_v1.png]] to start configuration.
[[File:Network_rutxxx_manual_hotspot_hotspot_instances.png]]
|
{{{name}}} devices are able to create Hotspot on LAN interface.
[[File:Network_rutx10_manual_hotspot_hotspot_instances_v1.png|border|class=tlt-border]]
}}
==General Settings==
The '''General Settings''' window is where most of the Hotspot configurations take place. This section will be divided into sub-sections because configuration for Local authentication and with Radius Server are almost identical, just when Radius is chosen extra tab appears.
====General====
----
[[File:Network_rutxxx_manual_hotspot_general_settings_radius.png]]
<table class="nd-mantable">
<tr>
<th>field name</th>
<th>value</th>
<th>description</th>
</tr>
<tr>
<td>Enable</td>
<td>off {{!}} on; Default: '''on'''</td>
<td>Toggles WiFi Hotspot instance ON or OFF.</td>
</tr>
<tr>
<td>Hotspot Network</td>
<td>IP; Default: '''192.168.2.0/24'''</td>
<td>Defines IP and subnet of Hotspot Network</td>
</tr>
<tr>
<td>IP Adress</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 {{!}}}} MAC auth ; Default: '''Local users'''</td>
<td>Authentication mode defines how users will connect to the Hotspot</td>
</tr><tr><td>Allow signup
</td><td>off | on; Default: '''off'''</td><td>Allows users to sign up to hotspot via landing page.</td></tr><tr>
<td>Landing Page</td>
<td>Internal {{!}} External; Default: '''Internal'''</td>
<td>If external Landing Page is chosen, new section, to enter website address, will appear, e.g. http://www.example.com</td>
</tr>
<tr>
<td>UAM Port</td>
<td>integer; Default: '''3990'''</td>
<td>Port to bind for authenticating clients</td>
</tr>
<tr>
<td>UAM Secret</td>
<td>string; Default: " "</td>
<td>Shared secret between uamserver and hotspot.</td>
</tr>
<tr>
<td>Success page</td>
<td>Success Page {{!}} Original URL {{!}} Custom; Default: '''Success page'''</td>
<td>Location to return to after successful authentication</td>
</tr>
</table>
====Advanced====
----
[[File:Network_rutxxx_manual_hotspot_advanced_settings_radius.png]]
<table class="nd-mantable">
<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: '''HTTP'''</td>
<td>Protocol to be used for landing page</td>
</tr><tr><td>Enable TOS</td><td>off {{!}} on; Default '''off'''</td><td>Enables Terms of Service (ToS) requirement. Cient device will be able to access the Internet only after agreeing ToS.
</td></tr><tr>
<td>HTTPS to landing page redirect</td>
<td>off {{!}} on; Default '''off'''</td>
<td>Redirect initial pre-landing page HTTPS requests to hotspot landing page</td>
</tr>
<tr>
<td>DNS server 1</td>
<td>ip; Default: '''8.8.8.8'''</td>
<td>Additional DNS servers that are to be used by the Hotspot.</td>
</tr>
<tr>
<td>DNS server 2</td>
<td>ip; Default: '''8.8.4.4'''</td>
<td>Additional DNS servers that are to be used by the Hotspot.</td>
</tr></table>
====Radius====
----
'''Radius''' authentication mode uses an external Radius servers, to which you have to provide an address to, instead of using the router's Local Authentication. If you are using Local authentication, you can skip straight to [[{{{name}}}_Hotspot#Walled_Garden|Walled Garden]].
[[File:Network_rutxxx_manual_hotspot_radius_settings_radius.png]]
<table class="nd-mantable">
<tr>
<td>RADIUS server #1</td>
<td>ip; Default: " "</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: " "</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: '''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>NAS identifier</td>
<td>string; Default: " "</td>
<td>NAS-Identifier is one of the basic RADIUS attributes</td>
</tr>
<tr>
<td>Radius secret key</td>
<td>string; Default: " "</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: '''off'''</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: " "</td>
<td>Custom location name for your Hotspot</td>
</tr>
<tr>
<td>Location ID</td>
<td>string; Default: " "</td>
<td>Custom location ID for your Hotspot</td>
</tr>
</table>
====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 in to Address List.
[[File:Network_rutxxx_manual_hotspot_general_walled_garden.png]]
====User Scripts====
----
In this tab you can add Scripts that will be executed after a session is authorized in '''Session up''' section and Scripts that will be executed after session has moved from authorized state to unauthorized in '''Session down''' section.
[[File:Network_rutxxx_manual_hotspot_user_scripts_radius.png]]
==Local Users==
The '''Users Configuration''' tab is used to create new, unique users that can connect to the Hotspot.
[[File:Network_rutxxx_manual_hotspot_local_users.png]]
<table class="nd-mantable">
<tr>
<th>field name</th>
<th>value</th>
<th>description</th>
</tr>
<tr>
<td>Name</td>
<td>string; Default: " "</td>
<td>A custom user name used to authenticate clients connecting to the Hotspot</td>
</tr>
<tr>
<td>Password</td>
<td>string; Default: " "</td>
<td>A custom password for the specified user name</td>
</tr>
<tr>
<td>Group</td>
<td>string; Default: '''default'''</td>
<td>After adding user select group that it will be assigned to. Group describes connection speeds and dowload/upload limits. The '''default''' group settings have no restrictions. More on User Groups in the next section</td>
</tr>
</table>
==User Groups==
'''User Groups''' lets set different connection limitats for different users. Group '''default''' is already created and does not have any limitations set. To create new group simply enter the name and press Add.
[[File:Network_rutxxx_manual_hotspot_user_groups.png]]
After adding a group it will not have any limits set, so press edit [[File:Networking rutx manual edit button v1.png]]. In following window you will be able to configure yours User Group.
[[File:Network_rutxxx_manual_hotspot_user_group_settings.png]]
<table class="nd-mantable">
<tr>
<th>field name</th>
<th>value</th>
<th>description</th>
</tr>
<tr>
<td>Idle timeout</td>
<td>integer; Default: " "</td>
<td>A timeout in seconds after which idle users are automatically disconnected from the Hotspot. (0 means unlimited)</td>
</tr>
<tr>
<td>Time limit</td>
<td>integer; Default: " "</td>
<td>Disables hotspot user after time limit in sec is reached. (0, meaning unlimited)</td>
</tr>
<tr>
<td>Download bandwidth</td>
<td>integer; Default: " "</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>
</tr>
<tr>
<td>Upload bandwidth</td>
<td>integer; Default: " "</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>
</tr>
<tr>
<td>Download limit</td>
<td>integer; Default: " "</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: " "</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</td>
<td>integer [1..31] {{!}} Monday..Sunday {{!}} integer [1..24]; Default: '''1'''</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>
<td>Expiration time</td>
<td>integer; Default: '''0'''</td>
<td>Expiration time in sec (0 means unlimited). Only for dynamically created users.</td>
</tr>
</table>
==Landing Page==
This section is used to define how your Hotspot's Landing Page will look like.
===General Settings===
----
'''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>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]]
====Images====
----
The <b>Images</b> section allows you to upload custom images to different objects.
[[File:Network_rutxxx_manual_hotspot_landing_page_themes_images_v1.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: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]]
