Configuring a Captive Portal with Ubiquiti Unifi
Ubiquiti offers hardware that creates and manages Wi-Fi networks for guests. Our integration with Ubiquiti allows you to manage the captive portal experience and collect guest data from every guest visiting the property.
Benefits of the Ubiquiti Integration
- Fully Customizable Sign-In Screen: Create a branded portal experience for your guests
- Guest Data Collection: Capture guest information to assist with future direct bookings
- Personalized Greetings: Greet guests by name when they connect to your network
Compatibility Requirements
Important: Please ensure your setup meets these requirements before proceeding:
- You must be using either a Cloud Gateway device or Official Ubiquiti Hosting
- Your controller must be reachable from the internet on port 443
- Ubiquiti Network application version 9.0.108 or higher required
- Self-hosted controllers are not currently supported
Step-by-Step Setup Instructions
Part 1: Porter Dashboard Setup
1. Access Integration Settings
- Navigate to your Porter Dashboard
- Select Account from the main menu
- Click on Integrations
- Under Network Infrastructure, click Add Ubiquiti Unifi
2. Configure API Connection
- Create and paste in the API Key from your Ubiquiti Dashboard (Settings > Control Plane > Integrations tab)
- Enter the IP address or domain name of your controller (do not include https://)
- Ensure your controller is reachable on port 443
- If you use an allowlist for incoming connections, add 34.42.34.43
3. Perform Initial Sync
- Click Perform initial sync to import your network configuration
- Wait for the sync to complete
Screenshot: Example of the Porter Dashboard integration setup
Part 2: Ubiquiti Dashboard Configuration
1. Access Hotspot Settings
- Visit Insights > Hotspot > Landing Page tab
- Select the gear tab on the right
2. Reset Configuration
- Use the red "Restore Default Settings" button to reset your configuration to a known state
3. Configure Portal Domain
- Select the "Domain" option
- Paste in the domain displayed in the Porter Dashboard integration
- It should look similar to: vd9kboctgy6ek2lg0guw36mpbn2bs2ua.portal.prtr.us
4. Set Authorization Access
- Under Authorization Access, select "Add Hostname, IP or subnet"
- Paste in prtr.us
5. Configure External Portal Server
- Select the lock icon tab at the top
- Select the checkbox for external portal server
- Paste in 34.111.55.34 and save
- Select the “Save” button a second time on the bottom
6. Save Configuration
- Save your settings using the button at the bottom
Screenshot: Example of the Ubiquiti Dashboard hotspot configuration
Configuring Your Captive Portal
1. Map Access Points to Locations
- In your Porter Dashboard Ubiquiti integration, select Access Point to Location Map
- View and set the Location(s) that will be used for each access point
- The default Location will be used unless overridden by an additional mapping
2. Configure Information Collection
- Select your Location’s name in the side menu
- Select Captive Portal from the side menu
- If the Location is correctly mapped, you will see a notice at the top of the page
- Select Collect Info, then configure what information you’d like to collect
Note: Google and Facebook authentication options are not available for captive portals due to vendor restrictions.
Testing Your Captive Portal
1. Initial Connection Test
- Open the list of Wi-Fi networks on your phone
- Select the guest network
- The portal page should appear automatically within a few seconds
- On Android, you may need to tap the notification to sign in
2. Re-testing After Previous Connections
If you have previously joined the network and need to test again:
- Navigate to the Ubiquiti dashboard under Insights > Hotspot
- Select your phone from the device list
- Select "Unauthorize"
- Re-join the network with your phone to view the portal sign-in page again
Troubleshooting Tips
Issue | Solution |
---|---|
Portal Not Appearing | Check that your controller is reachable on port 443 and the external portal server IP is configured correctly |
API Connection Failed | Verify your API key is correct and that you're using Network application version 9.0.108 or higher |
Domain Configuration Issues | Double-check that the portal domain from Porter Dashboard is correctly pasted in Ubiquiti settings |
Guest Data Not Collecting | Ensure the Wi-Fi Layout item is properly configured with the desired information collection fields |
Need Additional Help?
If you encounter any issues during setup or have questions about the captive portal integration, please contact our support team (info@tenonedesign.com) with details about your specific situation and network configuration.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article