How to set up ACS 3 as an external Hotspot Portal Server?

The Hotspot Web Portal function in the Vigor Router enables using an External Portal Server, such as Purple WIFI, to authenticate guests. Starting from version 3.0.0, VigorACS 3 can serve as an External Portal Server to authorize guest Internet access by sending the API(see the step 4 in the diagram) to the Vigor Router.

This application note demonstrates how to set up VigorACS 3 as an External Hotspot Portal Server.

How does VigorACS 3 function as an external hotspot portal server?

A RADIUS server and a portal server are required when an external portal server is needed for the portal method in the Vigor Router.

FreeRADIUS is recommended for authenticating guest devices, while VigorACS 3 is the portal server that provides guests with a login page for authorising internet access.

The diagram below illustrates how VigorACS 3 works as an external Hotspot Portal Server. A summary of the steps involved are:

a screenshot of Hotspot flow

Benefits of using VigorACS 3 as a Hotspot Portal Server

As a portal server, VigorACS 3 can authorise guests' Internet access and provide other benefits. It is a comprehensive network management system.

Supposing there is a holiday park with multiple routers at different locations. The network manager wants to provide Internet connections with limited PIN codes at each location and promote the park's paid services for customers.

The network manager can choose PIN with Voucher as the login method and design a page in the hotspot profile for guests' login. Once the guests log in successfully, they will be redirected to the web page with the sale information. After finishing the hotspot profile, we can provision it to multiple routers simultaneously. Clients' numbers and visit times at each place can also be monitored on the ACS WUI.

Set up VigorACS 3 as a Hotspot Portal Server

  1. Before starting, please refer to the following notes when setting up FreeRADIUS with a MySQL database.
    • The MySQL database is used for the RADIUS server, not the one on the VigorACS 3.
    • VigorACS 3 is set to add/update the database named "radius". Please create the database called "radius" in MySQL database on the FreeRADIUS server.
    • Please add the client entry for Vigor ACS 3 and Vigor Router in client.conf to allow remote access to the FreeRADIUS server.
    • Vigor ACS 3 must be allowed to access the database "radius" with the account for the FreeRADIUS server.
    • Vigor Router restricts hotspot users' bandwidth and sessions with Draytek self-defined attributes. Please follow the steps below to add the Draytek attributes to the FreeRADIUS server.
      • Download "dictionary.draytek".
      • Move the file to /usr/share/freeradius
      • Include the reference of "dictionary.draytek" in the file "dictionary". The file "dictionary" can be found in the path /etc/freeradius/, /etc/freeradius/ or /etc/raddb.
      • Restart the FreeRADIUS server.
  2. On ACS 3 Dashboard
    1. Tap the Network box which is located at the top.
    2. Click the network group.

    a screenshot of network group

  3. Go to Hotspot Web Portal >> Profile.
  4. a screenshot of profile page

  5. Click Add and name the new profile
  6. a screenshot of new profile naming

  7. Click Edit at the new profile
  8. a screenshot of new profile editing

  9. On the profile setup page,
    • Basic Settings & Applied Interfaces
      1. Enable this profile
      2. Enter comments (It will be applied to the Hotspot Web Portal profile of CPE site.)
      3. Select the interfaces to apply this profile

      a screenshot of Basic Settings & Applied Interfaces

    • External RADIUS Server
      1. Click Edit at External RADIUS Server
      2. Enter the address of RADIUS server
      3. Set 1812 as Destination Port
      4. Enter the secret of RADIUS server
      5. Enter the username of MySQL
      6. Enter the password of MySQL
      7. Click Confirm
      8. (Optional)Enable RADIUS MAC Authentication and select AABBCCDDEEFF as MAC Format.
    • Note:
      • Enable MAC Authentication is optional. When this option is enabled, Vigor Router will send the request to the RADIUS server first to check if this guest has connected.
      • If yes (Access-Accept), the guest can access the Internet directly.
      • If not (Access-Reject), the guest will be redirected to the portal login page for the hotspot authentication.
      a screenshot of external RADIUS server setup
    • Portal Server
      1. Select login methods (multiple selections)
      2. Enter the Captive Portal URL(ACS server)
      3. (Optional) Enable Captive Portal Detection to trigger the unauthenticated clients to automatically pop-up the Web Portal page when connect to the selected interfaces
      4. (Optional) Edit the default Landing Page URL to make the clients visit a specific website after a successful authentication.
      5. a screenshot of Portal Server & Quota Policy
    • Quota Policy
      1. Select a Quota Profile in the hotspot profile.
      2. Click Continue
    • Note:
      • The Quota Profile can be created in Hotspot Web Portal >> Quota Management. We can customize the validity, number of devices allowed, and bandwidth/session limit per account.
  10. After customizing the Splash page, please add RADIUS server IP and ACS IP to Destination IP on Whitelist Setup page, so that the CPE will pass the traffic to the RADIUS server and ACS.
  11. Note:

    • If the login method is Google or Facebook, please also add the required domains in the whitelist.
  12. Apply the profile: Go to Hotspot Web Portal >> Network & Device. a screenshot of Network device page
  13. At Network & Device page,
    1. Select the User Group
    2. Select the Hotspot Web Portal profile for the device(s).
    3. Click Save a screenshot of Network Device page
  14. Go to Hotspot Web Portal >> Profile, click View Log a screenshot of View Log
  15. Status Overview is available to observe the applied process. a screenshot of profile information & Overview
  16. On CPE site, the hotspot profile will be provisioned after the next Inform from the CPE. The CPE will reboot after the hotspot profile is applied. a screenshot of Hotspot profile
  17. Once new clients connect to the selected interface of the router, they need to use one of the authentications to access the Internet. a screenshot of Login_Page
  18. Go to Hotspot >> Web Portal Analytics, this page will demonstrate all clients’ information. a screenshot of Analytics page
  19. For detailed information, click View Detail at Action. a screenshot of View Detial a screenshot of detail of clients

Published On:2021-05-19 

Was this helpful?