HotSpot Section Management [Документация VAS Experts]

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot [2024/09/26 15:29] – created - external edit 127.0.0.1en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot [2024/11/20 10:51] (current) – [Configuration Management] elena.krasnobryzh
Line 1: Line 1:
-====== HotSpot management ====== 
 {{indexmenu_n>10}} {{indexmenu_n>10}}
 +====== HotSpot Section Management ======
 +Wi-Fi HotSpot is a system that provides public internet access after user authorization and identification via a phone number or SMS.
  
-  * [[#Web Server Configuration]] +User Authorization Process: 
-  * [[#Wi-Fi Authorization Configuration]] +  - The user (not yet a subscriber) connects to the public Wi-Fi hotspot. 
-  * [[#Click wrap configuration]] +  - The DHCP server assigns them an internal IP address, and the system triggers internet blocking through the "Whitelist" service, which restricts access to everything except the authorization page. Connection speed limitations are also applied. 
-  * [[#DHCP config]] +  - The client's device automatically redirects to the authorization page, where they need to enter their phone number and choose a verification method — via SMS or a call to the provided number. 
-  * [[#Tariff Configuration]] +  - After authorization, depending on the agreement terms, the system removes the restrictive policing and the "Whitelist" service.
-  * [[#Service Management]] +
-  * [[#Portal Appearance Settings]] +
-  * [[#Language settings]]+
  
-This section appeared in version 2.6.6.+If DPI is used, a subscriber profile is created with a login (phone number) and assigned IPThe profile becomes active, granting the subscriber internet access with the necessary policies and servicesWhen the "Session Lifetime" parameter expires, deauthorization occurs. DPI removes all services and policing, deletes the "login-IP" link, and reactivates the "Whitelist" service with access restrictions, requiring the subscriber to reauthorize.\\ 
 +If a billing system is used, it receives a request with the IP and phone number, then applies settings according to the billing parameters and timeouts.
  
-The description of the module that this section interacts with is available at [[en:dpi:dpi_components:module_wi-fi_hotspot|link]].+WiFi HotSpot configuration is carried out in the GUI section SSG Control → HotSpot.
  
-To go to the section, open the "Service Management" menu and click "Hotspot".+<note>This section was introduced in GUI v2.6.6. 
 +The module description interacting with this section is available via [[en:dpi:dpi_components:module_wi-fi_hotspot|this link]].</note>
  
-{{ :dpi:dpi_components:dpiui:scat_dpiui2_hotspot_section.png?400 |}}+The section contains tabs: 
 +  * [[en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot#common_settings|Common Settings]] 
 +  * [[en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot#view_settings|View Settings]] 
 +  * [[en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot#localization_settings|Localization Settings]] 
 +  * [[en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot#auth_and_click-wrap_settings|Auth and Click-Wrap Settings]] 
 +  * [[en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot#services_settings|Services Settings]] 
 +  * [[en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot#tariffs_settings|Tariffs Settings]] 
 +  * [[en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot#dhcp_configuration|DHCP configuration]] 
 +  * [[en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot#logs|Logs]]
  
-The section looks like the picture below.+{{:en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:hotspot.png?nolink&1200 |}}
  
-{{ :dpi:dpi_components:dpiui:scat_dpiui2_hotspot_section_view.png?600 |}}+===== Common Settings ===== 
 +  - In the "Web Server" parameter, select the HOTSPOT server linked to DPI.\\ If the corresponding equipment is not available, add it using the "Add New Device" button. A form for creating a new device will appear; in it, create a device with the "HOTSPOT server" type.\\ :!: [[en:dpi:dpi_components:dpiui:user_guide:admin_section:equipment_management:list|More about creating equipment]].\\ {{:en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:common_settings.png?nolink&700|}} 
 +  - In the "Captive portal URL" parameter, specify the URL to which the subscriber will be redirected for network authorization. Creates/updates the Whitelist service profile with the entered URL. The profile name is ''hotspot_white_list_profile''
 +  - In the "Redirect URL" parameter, specify the URL to which the subscriber will be redirected after successful authorization on the HotSpot portal. If the field is empty, the subscriber is redirected to https://google.com.
  
-=== Web Server Configuration ===+===== View Settings ===== 
 +In this section, you can change the favicon and logo displayed on the portal page.
  
-In this form, you must provide the following information: +{{:en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:view_settings.png?nolink&700|}}
-  * Select an existing device from the list, or create a new device for HotSpot. +
-In order to create new equipment, click on the "+" button to the right of the input field, after which a form for creating new equipment will appear (working with equipment is described in the section [[#equipment_management|Equipment management]]), in which you will need to create equipment with type "Dpi WiFi Web". After creation, select this equipment from the drop-down list. +
-The form for creating new equipment is presented below. +
-{{ :dpi:dpi_components:dpiui:scat_dpiui2_hotspot_equipment.png?400 |}} +
-  * Captive portal URL - A White List service profile will be created/modified with the entered URL. Profile name - hotspot_white_list_profile +
-  * Session lifetime - Used if Wi-Fi authorization is enabled. Time is indicated in seconds (default - 3600 sec (1 hour)) +
-  * URL for redirect - after authorization on the Hotspot portal, the subscriber will be redirected to this page (redirected to https://google.com if the field is empty)+
  
-=== Wi-Fi authorization configuration ===+===== Localization Settings ===== 
 +  - Add a language for localization settings by clicking **+**. Available languages list:\\ {{:en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:localizations_settings_1.png?nolink&300|}} 
 +  - Select the added language to configure parameter values. Change values by clicking on them.\\ {{:en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:localizations_settings_2.png?nolink&700|}} 
 +  - Any language can be set as the default by clicking the “Set as Default” button. By default, the first added language is set as the default.\\ {{:en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:localizations_settings_3.png?nolink&300|}}
  
-In this partyou can enable/disable the Wi-Fi authorization function. +If two or more languages are configured, the authorization page will have a button to select the language.
-The following authorization options are currently possible: +
-  * By receiving an authorization code via SMS (Setup form will be presented later). +
-  * By receiving an authorization code on an incoming call (The configuration form will be presented later). +
-  * Debug mode. Details are available by clicking the "?" to the right of the "switch" of the debug mode.+
  
-The form for setting up authorization by SMS and incoming call is presented below.+===== Auth and Click-Wrap Settings ===== 
 +==== WiFi Authorization Settings ==== 
 +Wi-Fi authorization is the process of connecting to a network with user identification via a phone number or SMS.\\ 
 +To configure this type of authorization, select “Yes” for the “WiFi authorization enabled” parameter. All WiFi authorization settings will then appear: 
 +  - “Session management enabled”\\ If “Yes” is selected, subscriber creation and management (authorization and deauthorization) occur through DPI, allowing for “Session lifetime” configuration (After the session lifetime expires, HotSpot will execute a script to delete the subscriber from DPI and apply the authorization tariff and the Whitelist service to their IP address).\\ If “No” is selected, subscriber management occurs via the billing system or another third-party service. Here, you need to configure an HTTP request sent to the billing API, which will apply and remove the appropriate policies for the subscriber. 
 +  - “Authorization type” Two options are available: 
 +    - “By auth code” — for this option, you need to configure HTTP requests to the service for sending SMS and calls.\\ You can also enable the “Sequential Authorization” parameter — this mode allows you to select the initial authorization method, and the “Debug Mode” — enables sending the authorization code to the email specified in the phone number field to test the subscriber authorization scenarios. 
 +    - “By outgoing call” — for this option, configure two parameters: 
 +      - “Outgoing call phones list” — enter phone numbers separated by commas. HotSpot will randomly select a phone number to authorize the subscriber by an outgoing call. 
 +      - “Secret key for hash generating” — configure the call service to send an HTTP request about receiving an outgoing call from the subscriber to HotSpot. A hint on setting up the HotSpot API method for receiving the signal and creating a hash is available by clicking the question mark icon next to the parameter.
  
-{{ :dpi:dpi_components:dpiui:scat_dpiui2_hotspot_requests.png?400 |}}+==== Click-Wrap Settings ==== 
 +Click-wrap displays the text of a public offer that subscribers must agree to in order to use the services.
  
-In this formyou must specify data on requests that initiate the sending of an SMS/call.+To configure this type of authorizationselect “Yes” for the “Click wrap enabled” parameter. Click-wrap settings will then appear: 
 +  - “Session management enabled”\\ If “Yes” is selected, subscriber creation and management (authorization and deauthorization) occur through DPI, allowing for “Session lifetime” configuration (After the session lifetime expires, HotSpot will execute a script to delete the subscriber from DPI and apply the authorization tariff and Captive Portal service to their IP address).\\ If “No” is selected, subscriber management occurs via the billing system or another third-party service. Here, you need to create an HTTP request sent to the billing API, which will apply and remove the appropriate policies for the subscriber.
  
-The appearance of the Hotspot portal with Wi-Fi authorization enabled (by incoming call and Debug modeis shown below.+<note>This scenario is only possible if the click-wrap works in conjunction with [[en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot#wifi_authorization_settings|WiFi Authorization]].  
 +If __only__ the click-wrap is active, restrictions (Whitelist serviceare removed upon confirmation.</note>
  
-{{ :dpi:dpi_components:dpiui:dpiui2_hotspot_debug_mode.png?400 |}}+The click-wrap text is configured in the “[[en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot#localization_settings|Localization Settings]]” section under parameters prefixed with “click_wrap”:\\ 
 +{{:dpi:dpi_components:dpiui:user_guide:ssg_control_section:localizations_settings_4.png?nolink&700|}}
  
-=== Click wrap configuration ===+===== Services Settings ===== 
 +<note important>Service settings are available only when “Session management enabled” = “Yes” in the “Auth and Click-Wrap Settings” section.</note> 
  
-Enabling this feature allows you to show subscribers the text of a public offer, with which they must agree in order to use your services.+This form provides settings for services available to subscribers after they authorize on the portal.
  
-The appearance of the portal with Click wrap enabled is shown below.+{{:en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:services_settings.png?nolink&800|}}
  
-{{ :dpi:dpi_components:dpiui:scat_dpiui2_hotspot_click_wrap.png?400 |}}+The following services are available for connection: 
 +  * 2. Advertising — no profile 
 +  * 3. Ad Blocking — no profile 
 +  * 4. Blacklist — with or without a profile 
 +  * 11. CGNAT — profile selection required 
 +  * 50Notification — no profile
  
-=== DHCP configuration ===+===== Tariffs Settings ===== 
 +<note important>Tariff settings are only available when the “Session management enabled” parameter is set to “Yes” in the “Auth and Click-Wrap Settings” section.</note>
  
-1Configure [[en:dpi:dpi_components:platform:subscriber_management:subsman_remote#remote_execution_of_ssh_commands|remote commands via SSH]]+This form allows configuring tariff plan parameters applicable to subscribers during Wi-Fi authorization  
 +The tariffs in the form correspond to the following names on the DPI: 
 +  * **Authorization Policing** — applied at the moment of network authorization. Corresponds to the named profile ''wifi_hotspot_auth_policing'' on the DPI. 
 +  * **Wi-Fi Policing** — applied after successful authorization. Corresponds to the named profile ''wifi_hotspot_policing'' on the DPI. It is assigned to the subscriber after completing authorization on the portal.
  
-2. Set on the trigger to issue a new IP: 
-* In case of using HotSpot as a portal for Wi-Fi authorization: <code>ssh dpi_user@dpi_host "/var/dpiui2/add_captive_portal_auth.sh <IP>"</code> 
-* In case of using HotSpot **ONLY** as a Click Offer portal: <code>ssh dpi_user@dpi_host "/var/dpiui2/add_captive_portal_click_wrap.sh <IP>"</code> 
  
-=== Tariff configuration ===+{{:en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:tariffs_settings.png?nolink&700|}}
  
-In this form, it is possible to configure the parameters of tariff plans applicable to subscribers during Wi-Fi authorization.+===== DHCP configuration ===== 
 +Supplementary information for connecting the DHCP server: 
 +  Configure [[en:dpi:dpi_components:platform:subscriber_management:subsman_remote|remote ssh commands]] 
 +  - Set up on the trigger for issuing a new IP:
  
-{{ :dpi:dpi_components:dpiui:skat_dpiui2_hotspot_rates.png?400 |}}+For Wi-Fi authorization use this trigger: 
 +<code>ssh dpi_user@dpi_host "/var/dpiui2/add_captive_portal_auth.sh <IP>"</code>
  
-The rates in the form correspond to the following DPI names+If you need only click-wrap function use this trigger
-  * Tariff for authorization - wifi_hotspot_auth_policing; +<code>ssh dpi_user@dpi_host "/var/dpiui2/add_captive_portal_click_wrap.sh <IP>"</code>
-  * Free Wi-Fi tariff - wifi_hotspot_policing. It is set to the subscriber after authorization on the portal; +
-  * Tariff for paid Wi-Fi - wifi_hotspot_payed_policing. Interaction with this tariff plan is under development.+
  
-=== Service Management ===+===== Logs ===== 
 +This subsection contains log files for the interface and Click-Wrap feature.\\ 
 +To update the list, click the "Refresh" button.
  
-In this form, it is possible to configure the services connected to the subscriber after he has been authorized on the portal.+===== Configuration Management ===== 
 +{{:en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:conf_mng.png?nolink&700|}}
  
-{{ :dpi:dpi_components:dpiui:scat_dpiui2_hotspot_services.png?400 |}}+  - Save configuration 
 +  - Refresh configuration 
 +  - Navigate to the documentation page for the HotSpot section 
 +  - Delete configuration
  
-The following services are currently available: 
-  * 2. Advertising - no profile 
-  * 3. Ad blocking - no profile 
-  * 4. Blacklist - with the ability to select a profile 
-  * 11. CGNAT - with the ability to select a profile 
-  * 50. Notification - no profile 
- 
- 
-=== Portal appearance settings === 
- 
-In this section it is possible to change the icon (favicon) and logo displayed on the portal page. 
- 
-{{ :dpi:dpi_components:dpiui:dpiui2_hotspot_view_settings.png?400 |}} 
- 
-=== Language settings === 
- 
-In this section, it is possible to add and configure localization languages ​​for the portal. 
- 
-{{ :dpi:dpi_components:dpiui:skat_dpiui2_hotspot_languages.png?400 |}} 
- 
-1. To add a new language, click on the "+" button. In the window that appears, select the required language and click the "Add" button. 
- 
-{{ :dpi:dpi_components:dpiui:scat_dpiui2_hotspot_add_language.png?400 |}} 
- 
-2. In order to edit the values ​​of the selected language, double-click on the line you need in the table with values ​​and Enter the line you need. 
- 
-{{ :dpi:dpi_components:dpiui:scat_dpiui2_hotspot_edit_language.png?400 |}}