Changes

Template:Networking rutos manual hotspot (view source)

Revision as of 12:55, 16 April 2024

4,256 bytes added , 16 April

no edit summary

Line 1: Line 1: −

{{Template: ~~Networking_rutos_manual_fw_disclosure~~

+

{{Template: Networking_device_manual_fw_disclosure

−

| fw_version ={{Template: ~~Networking_rutos_manual_latest_fw~~

+

| series = {{{series}}}

+

| name = {{{name}}}

+

| fw_version ={{Template: Networking_device_manual_latest_fw

| series = {{{series}}}

| name = {{{name}}}

}}

−

{{#ifeq: {{{series}}} | RUT9 | Note: [[{{{name}}} Hotspot (legacy WebUI)|click here]] for the old style WebUI (FW version {{Template: ~~Networking_rutos_manual_latest_fw~~ | series = RUT9XX}} and earlier) user manual page.|}}

+

{{#ifeq: {{{series}}} | RUT9 | Note: [[{{{name}}} Hotspot (legacy WebUI)|click here]] for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.|}}

−

{{#ifeq: {{{series}}} | RUT2 | Note: [[{{{name}}} Hotspot (legacy WebUI)|click here]] for the old style WebUI (FW version {{Template: ~~Networking_rutos_manual_latest_fw~~ | series = RUT2XX}} and earlier) user manual page.|}}

+

{{#ifeq: {{{series}}} | RUT2 | Note: [[{{{name}}} Hotspot (legacy WebUI)|click here]] for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT2XX}} and earlier) user manual page.|}}

==Summary==

Line 12: Line 14:

{{#switch: {{{series}}}

| #default =

−

| RUT36X|RUT9|TCR1|RUT2|RUT2M|RUT9M =

+

| RUT36X|RUT9|TCR1|RUT2|RUT2M|RUT9M|TRB1|TRB2|TRB5|TRB2M|OTD140|RUT361 =

−

Note: Hotspot is additional software that can be installed from the ~~Services~~ → [[{{{name}}} Package Manager|Package Manager]] page.

+

Note: Hotspot is additional software that can be installed from the System → [[{{{name}}} Package Manager|Package Manager]] page.

}}

Line 29: Line 31:

</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.png|border|class=tlt-border]]

After this, a new Hotspot configuration window will appear.

Line 39: Line 41:

=====General=====

----

−

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

+

{{#switch: {{{series}}}

+

| #default = [[File:Networking_rutos_manual_hotspot_general_hotspot_instances_general_settings_general_v3.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]]}}

Line 49: Line 53:

<tr>

<td>Configuration profile</td>

−

<td>Cloud4wi | Default | Hotspotsystems; default: Default</td>

+

<td>Cloud4wi | Default | Hotspotsystems | Purple portal; default: Default</td>

<td>Pre-configures Hotspot settings according to the selected service provider.</td>

</tr>

Line 59: Line 63:

<tr>

<td>Hotspot Network</td>

−

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

+

<td>ip/netmask; default: {{#switch: {{{series}}} | #default = 192.168.2.0/24 | TRB1 | TRB2 | TRB5 | TRB2M = 192.168.3.0/24}}</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>ip; default: '''{{#switch: {{{series}}} | #default = 192.168.2.254 | TRB1 | TRB2 | TRB5 | TRB2M = 192.168.3.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: Local users</td>

+

<td>Local users | Radius | MAC authentication | Single sign-on{{#ifeq:{{{mobile}}}|1| {{!}} SMS OTP}}; default: Local users</td>

<td>Authentication mode defines how users will connect to the Hotspot.</td>

</tr>

<tr>

−

<td>Allow signup</td>

+

<td>Local users: Allow signup</td>

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

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

</tr>

<tr>

−

<td>Expiration time</td>

+

<td>Local users: Expiration time</td>

<td>integer; default: 0</td>

<td>User credential expiration time. Applies to users who signed up via landing page.</td>

</tr>

<tr>

−

<td>Users group</td>

+

<td>Local users: Users group</td>

<td>user group; default: default</td>

<td>The user group to which users signed up via landing page should be assigned to.</td>

</tr>

+

<tr>

+

<td>Radius: Enable MAC authentication</td>

+

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

+

<td>Enable MAC address authentication.</td>

+

</tr>

+

<tr>

+

<td>MAC authentication: Require password</td>

+

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

+

<td>Enables password requirement for MAC authentication.</td>

+

</tr>

+

<tr>

+

<td>MAC authentication: MAC auth password</td>

+

<td>string; default: none</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: default</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: off</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: 0</td>

+

<td>User expiration time in sec (0 means unlimited).</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., <nowiki>http://www.example.com</nowiki>~~</td>

+

<td>Location of the landing page.</td>

</tr>

<tr>

Line 96: Line 130:

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

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

+

</tr>

+

<tr>

+

<td>Password encoding</td>

+

<td>off {{!}} on; default: none</td>

+

<td>Password encoding with the challenge.</td>

+

</tr>

+

<tr>

+

<td>Landing page address</td>

+

<td>url; default: none</td>

+

<td>External landing page address (http://www.example.com).</td>

</tr>

<tr>

Line 104: Line 148:

<tr>

<td>Success page</td>

−

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

+

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

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

+

</tr>

+

<tr>

+

<td>Custom</td>

+

<td>url; default: none</td>

+

<td>Address must contain protocol (http://www.example.com).</td>

</tr>

</table>

Line 111: Line 160:

=====Advanced=====

----

−

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

+

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

Line 122: Line 171:

<td>Additional interfaces</td>

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

−

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

+

<td>Choose additional the interfaces you want to attach to this 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>

<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>

+

<td>IP address to instantly logout a client accessing it.</td>

</tr>

<tr>

<td>Protocol</td>

−

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

+

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

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

</tr>

Line 145: Line 199:

</tr>

<tr>

−

<td>~~Trial access~~~~: Group~~</td>

+

<td>Group</td>

−

<td>User group; default: default

+

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

−

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

+

<td>Specifies the group of trial users.</td>

+

</tr>

+

<tr>

+

<td>Subdomain</td>

+

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

+

<td>Combined with Domain to make a DNS alias for the Hotspot IP address.</td>

+

</tr>

+

<tr>

+

<td>Domain</td>

+

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

+

<td>Combined with Subdomain to make a DNS alias for the Hotspot IP address.</td>

</tr>

<tr>

Line 170: Line 234:

</tr>

<tr>

−

<td>DNS server 1</td>

+

<td>Primary DNS server</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>Secondary DNS server</td>

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

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

Line 183: Line 247:

=====Radius=====

----

−

Radius 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.

+

Radius 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~~.png|border|class=tlt-border]]

+

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

Line 247: Line 311:

Format of address is website.com (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_v1.png|border|class=tlt-border]]

+

+

<tr>

+

<th>Field</th>

+

<th>Value</th>

+

<th>Description</th>

+

</tr>

+

<tr>

+

<td>Address list</td>

+

<td>domain names (one record per line); default: none</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=====

Line 253: Line 330:

The URL parameters section becomes visible when Landing page is selected as External in [[{{{name}}}_Hotspot#General_2|General settings]] section.

−

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

+

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

Line 280: Line 357:

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

<td>The MAC address of the client trying to gain Internet access.</td>

+

</tr>

+

<tr>

+

+

<td>ip default: none</td>

+

<td>The IP Address of the client trying to gain Internet access.</td>

</tr>

<tr>

Line 327: Line 409:

In this section you can add custom Scripts that will be executed after a session is authorized in the Session up section, after session has moved from authorized state to unauthorized in the Session down section and after a new user has been signed up in the User signup section.

−

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

+

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

+

+

<tr>

+

<th>Field</th>

+

<th>Value</th>

+

<th>Description</th>

+

</tr>

+

<tr>

+

<td>Session up</td>

+

<td>bash script; default: none</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: none</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: none</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==

Line 340: Line 445:

</ol>

−

[[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_v1.png|border|class=tlt-border]]

==Landing Page==

Line 350: Line 455:

General Settings 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]]

+

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

===Themes===

Line 356: Line 461:

The Themes 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~~.png|border|class=tlt-border]]

+

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

====Images====

Line 362: Line 467:

The Images section allows you to upload custom images to different objects.

−

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

+

[[File:Networking_rutos_manual_hotspot_landing_page_themes_images_v2.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

+

Pressing 'Edit' button 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]]

+

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

====View Settings====

Line 376: Line 481:

In View Settings 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]]

+

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

====Custom Theme====

----

−

To use custom theme you can download default theme and edit it's content. Then use ~~upload~~ button to upload it.

+

To use custom theme you can download default theme and edit it's content. Then use 'Browse' button to upload it.

−

[[File:Networking rutos manual hotspot landing page themes upload custom v1.png|border|class=tlt-border]]

+

[[File:Networking rutos manual hotspot landing page themes upload custom v2.png|border|class=tlt-border]]

==User Groups==

Line 393: Line 498:

</ol>

−

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

+

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

A group's settings page will look similar to this:

−

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

+

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

Line 459: Line 564:

==User Management==

−

The ~~Current Hotspot Users~~ 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 User sessions 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~~.png|border|class=tlt-border]]

+

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

The Registered Hotspot Users tab displays the data of unique users that have registered to the hotspot before.

−

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

+

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

+

{{#switch: {{{series}}} | TRB1 | TRB2 | TRB5 | RUT30X | TAP100 | TAP200 | OTD140 | TRB2M | RUT301 =

+

| RUTX | RUTM | RUT36X | TCR1 | RUT9 | RUT9M | RUT2 | RUT2M | RUT361 | #default = {{#switch: {{{name}}} | RUTX08 | RUTX09 | RUTM08 | RUTM09 = | #default =

+

{{Template:Networking_rutos_manual_hotspot_2.0

+

| series = {{{series}}}

+

| name = {{{name}}}

+

| wifi = {{{wifi}}}

+

}}}}}}

[[Category:{{{name}}} Services section]]

MartynasL

Administrators

219

edits