Template:Networking rutos manual hotspot

Summary

Hotspot is a service that provides authentication, authorization and accounting for a network.

{{{name}}} devices are able to create Hotspot on LAN interface.

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

---

field name	value	description
Enable	off | on; default: on	Toggles WiFi Hotspot instance ON or OFF.
Hotspot Network	IP; default: 192.168.2.0/24	Defines IP and subnet of Hotspot Network.
IP Adress	ip; default: 192.168.2.254	Defines the IP address of your Hotspot router in network.
Authentication mode	Radius | Local user | MAC auth ; default: Local users	Authentication mode defines how users will connect to the Hotspot.
Allow signup	off | on; default: off	Allows users to sign up to hotspot via landing page.
Landing Page	Internal | External; default: Internal	If external Landing Page is chosen, new section, to enter website address, will appear, e.g. http://www.example.com
UAM Port	integer; default: 3990	Port to bind for authenticating clients.
UAM Secret	string; default: none	Shared secret between uamserver and hotspot.
Success page	Success Page | Original URL | Custom; default: Success page	Location to return to after successful authentication.

Advanced

---

Additional interfaces	Available interfaces; default: none	Shows additional interfaces that can be attached to hotspot instance.
Logout address	ip; default: 1.0.0.0	An address that can be used by users to logout from the Hotspot session.
Protocol	HTTP | HTTPS; default: HTTP	Protocol to be used for landing page.
Enable TOS	off | on; default: off	Enables Terms of Service (ToS) requirement. Cient device will be able to access the Internet only after agreeing ToS.
Trial access	off | on; default: off	Enables trial internet access for a specific group.
Trial access: Group	User group; default: default	Group of trial users.
HTTPS to landing page redirect	off | on; default: off	Redirect initial pre-landing page HTTPS requests to hotspot landing page.
DNS server 1	ip; default: 8.8.8.8	Additional DNS servers that are to be used by the Hotspot.
DNS server 2	ip; default: 8.8.4.4	Additional DNS servers that are to be used by the Hotspot.

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

RADIUS server #1	ip; default: none	The IP address of the RADIUS server #1 that is to be used for Authenticating your wireless clients.
RADIUS server #2	ip; default: none	The IP address of the RADIUS server #2 that is to be used for Authenticating your wireless clients.
Authentication port	integer [0..65535]; default: 1812	RADIUS server authentication port.
Accounting port	integer [0..65535]; default: 1813	RADIUS server accounting port.
NAS identifier	string; default: none	NAS-Identifier is one of the basic RADIUS attributes.
Radius secret key	string; default: none	The secret key is a password used for authentication with the RADIUS server.
Swap octets	off | on; default: off	Swaps the meaning of input octets and output as it relates to RADIUS attributes.
Location name	string; default: none	Custom location name for your Hotspot.
Location ID	string; default: none	Custom location ID for your Hotspot.

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.

User Scripts

---

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

Local Users

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

field name	value	description
Name	string; default: none	A custom user name used to authenticate clients connecting to the Hotspot.
Password	string; default: none	A custom password for the specified user name.
Group	string; default: default	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.

User Groups

User Groups lets set different connection limits 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.

After adding a group it will not have any limits set, so press edit . In following window you will be able to configure yours User Group.

field name	value	description
Idle timeout	integer; default: none	A timeout in seconds after which idle users are automatically disconnected from the Hotspot. (0 means unlimited)
Time limit	integer; default: none	Disables hotspot user after time limit in sec is reached. (0, meaning unlimited)
Download bandwidth	integer; default: none	Maximum download bandwidth that the users assigned to this template can achieve. Bandwidth can be specified in Kbit/s or Mbit/s.
Upload bandwidth	integer; default: none	Maximum upload bandwidth that the users assigned to this template can achieve. Bandwidth can be specified in Kbit/s or Mbit/s.
Download limit	integer; default: none	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.
Upload limit	integer; default: none	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.
Period	Month | Week | Day; default: Month	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.
Start day	integer [1..31] | Monday..Sunday | integer [1..24]; default: 1	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.
Expiration time	integer; default: 0	Expiration time in sec (0 means unlimited). Only for dynamically created users.

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.

Themes

---

The Themes section shows all available landing page themes and allows you to edit them.

Images

---

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

Style settings

---

Pressing edit button next to style settings lets you edit how your landing page will look visually using CSS syntax.

View settings

---

In view settings you can access and modify default templates for various parts of landing page and edit their HTML code.

User management

The User management section allows you to manage currently logged in users.

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