Important: Please ensure your setup meets these requirements before proceeding:

• TP-Link Omada system with a hardware or software controller, or with a Licensed Cloud-Based-Controller (CBC)
• Note: The "Essentials" Cloud-Based-Controller is not compatible
• Your controller must be reachable from the internet on port 443 (or custom port)
• Omada controller software version 5.15 or higher recommended

1. Create Omada Integration Credentials

• In your Omada controller dashboard, select "Global View" from the dropdown
• Navigate to Settings > Platform Integration > Add New App
• Enter App Name: Porter
• Select Mode: Client
• Select Role: Admin
• Select all Sites or limit to specific Sites if needed
• Click Create

Screenshot: Example of the Omada Add New App dialog

2. Create Porter Integration

• Navigate to your Porter Dashboard
• Select Account from the main menu
• Click on Integrations
• Under Network Infrastructure, click Add > TP-Link Omada

3. Configure API Connection

• From the Omada dashboard, copy the Client ID and Client Secret into the Porter Dashboard
• Select the view icon on the row to show the interface address and Omada ID
• Copy and paste the Interface address and Omada ID into the Porter Dashboard
• Adjust the interface address if necessary (e.g., if using a different public IP/port: xxx.xxx.xxx.xxx:port)
• If you use an allowlist for incoming connections, add 34.42.34.43

Screenshot: Example of the Porter Dashboard integration setup

4. Perform Initial Sync

• Click Connect and Sync to Omada to import your network configuration
• Wait for the sync to complete

1. Create Guest Wi-Fi Network

• On your Omada controller, change the dropdown from "Global" to your specific controller
• Navigate to Settings > WLAN > Create New Wireless Network
• Add network name (e.g., "Guest Wi-Fi")
• Select the "Guest Network" checkbox
• Change security to None
• Select Apply

Screenshot: Example of the Omada Create New Wireless Network screen

2. Configure Authentication Portal

• Navigate to Settings > Authentication > Portal > Create New Portal
• Portal Name: Guest Portal
• SSID & Network: Select the guest network name you just created
• Authentication Type: External Portal Server
• Custom Portal Server: Select URL, Select https, then paste the domain from your Porter Dashboard integration
• It should look similar to: vd9kboctgy6ek2lg0guw36mpbn2bs2ua.portal.prtr.us
• Select Apply

Screenshot: Example of the Omada create New Portal screen

3. Configure Access Control

• Select the Access Control tab at the top
• Check the box to Enable Pre-Authentication Access
• Click the Add button
• Select URL instead of IP Range
• Paste the portal domain again from your Porter Dashboard integration
• Select Save
• Repeat this process to add prtr.us as well
• Select Apply

1. Map Access Points to Locations

• In your Porter Dashboard’s TP-Link Omada 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 specific 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.

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 Omada controller 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