Ubiquiti UniFi with Cloud Key

The compatibility of the Ubiquiti UniFi system with the SOCIFI platform was tested on the controller version 5.4.11 (Build: atag_5.4.11_9184) and UniFi AP version 3.7.49.6201. This manual presumes a preconfigured controller with associated APs.

1. Guest Control

1.1 Guest Policies

Login to the UniFi Controller and Click on "Settings" - "Guest Control"

Set the Guest Policies options with the following values:

Portal IP selection table according to geolocation:

1.2 Access Control

Under the Access Control section click "Add Hostname or Subnet" and enter the allowed subnet. Repeat this for all SOCIFI and CDN required subnets. Even if entering a hostname is allowed, the DNS translation functionality is limited and not recommended by SOCIFI.

List of IP addresses needed for SOCIFI service

2.1 Profiles

2.1 RADIUS Profiles

Click on "Profiles". Under the section "Radius Profiles" click on "Create New Radius Profile". Set the RADIUS Auth Servers with following options:

Click on "Add Auth Server" and repeat procedure for the secondary Auth server.

Check the option "Enable Accounting". Set the RADIUS Accounting Servers with following options:

Click on "Add Accounting Server" and repeat procedure for the secondary Accounting server.

Click on "Save"

3. Wireless Networks

Click on "Settings" - "Wireless Networks"

Select the SSID intended for use with SOCIFI and click on "Edit". 

Configure the network with the following values:

4. Admins

Click on "Admins" and create a new admin profile for API communication. This account must be set in the SOCIFI Dashboard when adding a new Ubiquity hotspot

Click on "Add New Admin" and enter the following values:

Click on "Create"

IMPORTANT NOTICE:

Enablig API Access

It is necessary to forward the TCP port 8443 to UniFi controller on your NAT service or to assign a public IP to the UniFi controller. This will allow to communicate the SOCIFI portal with UniFi API.

The access to the port shall be allowed for the following list of IP addresses:

VPC:
use-1: 52.44.148.136
euw-1: 52.18.131.55
aps-1: 52.77.200.241
sae-1: 54.233.193.15

non-VPC:
euw-1: 54.246.88.74
use-1: 54.204.47.201    
aps-1: 54.251.110.178    
sae-1: 54.232.124.137

5. Registering in Dashboard

5.1 Locating the MAC for the registration in SOCIFI Dashboard.

Click on "Devices". The MAC address for registration is in the column "Device Name". All listed AP devices must be registered in SOCIFI Dashboard.

5.2 Hotspot Registering

Step 1: Login to SOCIFI Dashboard

Step 2: Click on the "Hotspots" tab on the left sidebar

Step 3: Click on the “Add a new hotspot” button located on the top right corner on the screen (pictured below)

Note: A pop-up window will appear (below)

Step 4: Select the Wi-Fi hardware manufacturer from the drop down menu

Step 5: Enter the serial number or MAC address (depending on the specific equipment manual) of your equipment. You can add multiple hotspots at once.

Step 6: Set your Network location (this step is essential for correct ad targeting)

Step 7: Set the API endpoint. Switch the API Set-up on and enter the API endpoint formated as https://(CreatedAdminUsername):(Password)@(yourWANIP):8443

Step 8: In the pop-up window type your location or just move the marker on the map and click on the save button to confirm the selection. This address is used for ad GEO targeting.

Step 9: Click Save

Note: Newly added hotspot are marked as  (Hotspot pending). After the first user connects to the hotspot via SOCIFI, the status will automatically change and appear as  (Active) within an hour. Get your first connections to test if it works properly.