| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot [2024/11/20 08:14] – elena.krasnobryzh | en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot [2024/11/20 10:51] (current) – [Configuration Management] elena.krasnobryzh |
|---|
| - The user (not yet a subscriber) connects to the public Wi-Fi hotspot. | - The user (not yet a subscriber) connects to the public Wi-Fi hotspot. |
| - 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. | - 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. |
| - 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. | - 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. |
| - After authorization, depending on the agreement terms, the system removes the restrictive policing and the "Whitelist" service. | - After authorization, depending on the agreement terms, the system removes the restrictive policing and the "Whitelist" service. |
| |
| 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. | 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. |
| |
| WiFi HotSpot configuration is carried out in the GUI section DPI Management → HotSpot. | WiFi HotSpot configuration is carried out in the GUI section SSG Control → HotSpot. |
| |
| <note>This section was introduced in GUI v2.6.6. | <note>This section was introduced in GUI v2.6.6. |
| The module description interacting with this section is available via [[dpi:dpi_components:module_wi-fi_hotspot|this link]].</note> | The module description interacting with this section is available via [[en:dpi:dpi_components:module_wi-fi_hotspot|this link]].</note> |
| |
| The section contains tabs: | The section contains tabs: |
| * [[dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot#general_settings|General Settings]] | * [[en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot#common_settings|Common Settings]] |
| * [[dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot#appearance_settings|Appearance Settings]] | * [[en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot#view_settings|View Settings]] |
| * [[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#localization_settings|Localization Settings]] |
| * [[dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot#authorization_and_click_wrap_settings|Authorization and Click-Wrap Settings]] | * [[en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot#auth_and_click-wrap_settings|Auth and Click-Wrap Settings]] |
| * [[dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot#service_settings|Service Settings]] | * [[en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot#services_settings|Services Settings]] |
| * [[dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot#tariff_settings|Tariff Settings]] | * [[en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot#tariffs_settings|Tariffs Settings]] |
| * [[dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot#dhcp_settings|DHCP Settings]] | * [[en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot#dhcp_configuration|DHCP configuration]] |
| * [[dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot#logs|Logs]] | * [[en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot#logs|Logs]] |
| |
| {{:en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:hotspot.png?nolink&1200 |}} | {{:en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:hotspot.png?nolink&1200 |}} |
| |
| ===== General Settings ===== | ===== 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.\\ :!: [[dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot#equipment_management|More about creating equipment]].\\ {{:en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:common_settings.png?nolink&700|}} | - 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 "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. | - 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. |
| |
| ===== Appearance Settings ===== | ===== View Settings ===== |
| In this section, you can change the favicon and logo displayed on the portal page. | In this section, you can change the favicon and logo displayed on the portal page. |
| |
| If two or more languages are configured, the authorization page will have a button to select the language. | If two or more languages are configured, the authorization page will have a button to select the language. |
| |
| ===== Authorization and Click-Wrap Settings ===== | ===== Auth and Click-Wrap Settings ===== |
| ==== WiFi Authorization Settings ==== | ==== WiFi Authorization Settings ==== |
| Wi-Fi authorization is the process of connecting to a network with user identification via a phone number or SMS.\\ | 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 “Enable Wi-Fi Authorization” parameter. All WiFi authorization settings will then appear: | To configure this type of authorization, select “Yes” for the “WiFi authorization enabled” parameter. All WiFi authorization settings will then appear: |
| - “Enable Session Management.”\\ 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. | - “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: | - “Authorization type” Two options are available: |
| - “By 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 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: | - “By outgoing call” — for this option, configure two parameters: |
| - “Phone Numbers for Outgoing Calls” — enter phone numbers separated by commas. HotSpot will randomly select a phone number to authorize the subscriber by an outgoing call. | - “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 Generation” — 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. | - “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 Settings ==== |
| Click-wrap displays the text of a public offer that subscribers must agree to in order to use the services. | Click-wrap displays the text of a public offer that subscribers must agree to in order to use the services. |
| |
| To configure this type of authorization, select “Yes” for the “Enable Click-Wrap” parameter. Click-wrap settings will then appear: | To configure this type of authorization, select “Yes” for the “Click wrap enabled” parameter. Click-wrap settings will then appear: |
| - “Enable Session Management.”\\ 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. | - “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. |
| |
| <note>This scenario is only possible if the click-wrap works in conjunction with [[dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot#wifi_authorization_settings|WiFi Authorization]]. | <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 service) are removed upon confirmation.</note> | If __only__ the click-wrap is active, restrictions (Whitelist service) are removed upon confirmation.</note> |
| |
| The click-wrap text is configured in the “[[dpi:dpi_components:dpiui:user_guide:ssg_control_section:management_hotspot#localization_settings|Localization Settings]]” section under parameters prefixed with “click_wrap”:\\ | 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|}} | {{:dpi:dpi_components:dpiui:user_guide:ssg_control_section:localizations_settings_4.png?nolink&700|}} |
| |
| ===== Service Settings ===== | ===== Services Settings ===== |
| <note important>Service settings are available only when “Enable Session Management” = “Yes” in the “Authorization and Click-Wrap Settings” section.</note> | <note important>Service settings are available only when “Session management enabled” = “Yes” in the “Auth and Click-Wrap Settings” section.</note> |
| |
| This form provides settings for services available to subscribers after they authorize on the portal. | This form provides settings for services available to subscribers after they authorize on the portal. |
| The following services are available for connection: | The following services are available for connection: |
| * 2. Advertising — no profile | * 2. Advertising — no profile |
| * 3. Ad Block — no profile | * 3. Ad Blocking — no profile |
| * 4. Blacklist — with or without a profile | * 4. Blacklist — with or without a profile |
| * 11. CGNAT — profile selection required | * 11. CGNAT — profile selection required |
| * 50. Notification — no profile | * 50. Notification — no profile |
| |
| ===== Tariff Settings ===== | ===== Tariffs Settings ===== |
| <note important>Tariff settings are available only when “Enable Session Management” = “Yes” in the “Authorization and Click-Wrap Settings” section.</note> | <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> |
| | |
| | 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. |
| |
| This form provides settings for the tariffs available for subscribers after authorization on the portal. | |
| |
| {{:en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:tariffs_settings.png?nolink&700|}} | {{:en:dpi:dpi_components:dpiui:user_guide:ssg_control_section:tariffs_settings.png?nolink&700|}} |
| |
| ===== DHCP Settings ===== | ===== DHCP configuration ===== |
| Supplementary information for connecting the DHCP server: | Supplementary information for connecting the DHCP server: |
| - [[dpi:dpi_components:platform:subscriber_management:subsman_remote|Configuring remote execution of SSH commands]] | - Configure [[en:dpi:dpi_components:platform:subscriber_management:subsman_remote|remote ssh commands]] |
| - Set up a trigger for assigning a new IP: | - Set up on the trigger for issuing a new IP: |
| For Wi-Fi authorization, use this trigger: | |
| | For Wi-Fi authorization use this trigger: |
| <code>ssh dpi_user@dpi_host "/var/dpiui2/add_captive_portal_auth.sh <IP>"</code> | <code>ssh dpi_user@dpi_host "/var/dpiui2/add_captive_portal_auth.sh <IP>"</code> |
| |
| If you only need the Click-Wrap feature, use this trigger: | If you need only click-wrap function use this trigger: |
| <code>ssh dpi_user@dpi_host "/var/dpiui2/add_captive_portal_click_wrap.sh <IP>"</code> | <code>ssh dpi_user@dpi_host "/var/dpiui2/add_captive_portal_click_wrap.sh <IP>"</code> |
| |
| |
| - Save configuration | - Save configuration |
| - Update configuration | - Refresh configuration |
| - Navigate to the documentation page for the HotSpot section | - Navigate to the documentation page for the HotSpot section |
| - Delete configuration | - Delete configuration |
| |
