Differences
This shows you the differences between two versions of the page.
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.1 | en: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> | {{indexmenu_n> | ||
+ | ====== 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: |
- | | + | |
- | | + | |
- | * [[#DHCP config]] | + | |
- | | + | |
- | | + | |
- | * [[#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 IP. The profile becomes active, granting the subscriber internet access with the necessary policies and services. When the " |
+ | 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 | + | WiFi HotSpot configuration is carried out in the GUI section |
- | To go to the section, open the " | + | < |
+ | The module description interacting with this section is available via [[en: | ||
- | {{ : | + | The section contains tabs: |
+ | * [[en: | ||
+ | * [[en: | ||
+ | * [[en: | ||
+ | * [[en: | ||
+ | * [[en: | ||
+ | * [[en: | ||
+ | * [[en: | ||
+ | * [[en: | ||
- | The section looks like the picture below. | + | {{: |
- | {{ : | + | ===== Common Settings ===== |
+ | - In the "Web Server" | ||
+ | - In the " | ||
+ | - In the " | ||
- | === 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: |
- | * Select an existing device from the list, or create a new device for HotSpot. | + | |
- | In order to create new equipment, click on the " | + | |
- | The form for creating new equipment is presented below. | + | |
- | {{ : | + | |
- | * Captive portal URL - A White List service profile will be created/ | + | |
- | * 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:// | + | |
- | === Wi-Fi authorization configuration | + | ===== Localization Settings |
+ | - Add a language for localization settings by clicking **+**. Available languages list:\\ {{: | ||
+ | - Select the added language to configure parameter values. Change values by clicking on them.\\ {{: | ||
+ | - 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.\\ {{: | ||
- | In this part, you can enable/ | + | If two or more languages are configured, the authorization |
- | 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 "?" | + | |
- | The form for setting up authorization | + | ===== 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, | ||
+ | - “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 | ||
+ | - “By outgoing | ||
+ | - “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. | ||
- | {{ : | + | ==== 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 form, you must specify data on requests that initiate | + | To configure |
+ | - “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 | ||
- | The appearance of the Hotspot portal | + | < |
+ | If __only__ the click-wrap is active, restrictions | ||
- | {{ : | + | The click-wrap text is configured in the “[[en: |
+ | {{: | ||
- | === Click wrap configuration | + | ===== Services Settings |
+ | <note important> | ||
- | 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 |
- | The appearance of the portal with Click wrap enabled is shown below. | + | {{: |
- | {{ :dpi: | + | 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 | ||
+ | * 50. Notification — no profile | ||
- | === DHCP configuration | + | ===== Tariffs Settings |
+ | <note important> | ||
- | 1. Configure [[en:dpi: | + | 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 '' | ||
+ | * **Wi-Fi Policing** — applied after successful authorization. Corresponds to the named profile '' | ||
- | 2. Set on the trigger to issue a new IP: | ||
- | * In case of using HotSpot as a portal for Wi-Fi authorization: | ||
- | * In case of using HotSpot **ONLY** as a Click Offer portal: < | ||
- | === Tariff configuration === | + | {{: |
- | In this form, it is possible to configure | + | ===== DHCP configuration ===== |
+ | Supplementary information for connecting | ||
+ | | ||
+ | - Set up on the trigger for issuing a new IP: | ||
- | {{ :dpi: | + | For Wi-Fi authorization use this trigger: |
+ | < | ||
- | 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; | + | < |
- | * 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 " | ||
- | In this form, it is possible to configure the services connected to the subscriber after he has been authorized on the portal. | + | ===== Configuration Management ===== |
+ | {{: | ||
- | {{ : | + | - 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. | ||
- | |||
- | {{ : | ||
- | |||
- | === Language settings === | ||
- | |||
- | In this section, it is possible to add and configure localization languages for the portal. | ||
- | |||
- | {{ : | ||
- | |||
- | 1. To add a new language, click on the " | ||
- | |||
- | {{ : | ||
- | |||
- | 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. | ||
- | |||
- | {{ : |