php-helper

Configures a PHP helper to serve the PHP splash pages to guest users logging in to the captive portal using social-media credentials. Configure a PHP helper only if the following criteria are fulfilled:
  • OAuth-based authentication is enabled on the captive portal.
  • The captive-portal server mode is “self”.
  • The access point, hosting the captive-portal server, has low memory space.
  • A hotspot server, hosting the captive-portal PHP splash pages, is up and running.

The WiNG software introduces HybridAuth support on captive portals. HybridAuth is an open-source, social-sign on PHP Library. In addition to Google and Facebook, it allows a variety of third-party social authentications, such as LinkedIn, Twitter, Live, Yahoo, OpenID, etc. However, HybridAuth uses space-consuming PHP splash pages that cannot be loaded on access points with low memory space. These access points can only serve the initial landing page, where guests clicking on a social login button are redirected by the php-helper to a PHP page hosted on the PHP-helper.

To create PHP splash pages, use the splash template configuration tool available on the EGuest (ExtremeGuest) dashboard. Upload the generated tar to both the hotspot server and the php helper.

For more information on enabling the EGuest server, see eguest-server (VX9000 only).

For more information on configuring an EGuest captive portal, see configuring ExtremeGuest captive portal.

Supported in the following platforms:

Syntax

php-helper [controller|domain-manager]
php-helper controller <IP/HOSTNAME> hosting-vlan-interface <0-4096>
php-helper domain-manager <IP/HOSTNAME>

Parameters

php-helper controller <IP/HOSTNAME> hosting-vlan-interface <0-4096>
php-helper Configures the php-helper parameters
controller <IP/HOSTNAME> Configures the controller adopting the captive-portal access point as the php-helper
  • <IP/HOSTNAME> – Specify the adopting controller‘s IP address or host name.
hosting-vlan-interface <0-4096> Optional. Configures the VLAN on which the php-helper is reachable
  • <0-4096> – Specify the VLAN hosting the php-helper from 0 - 4096.
 
php-helper domain-manager <IP/HOSTNAME>
php-helper Configures the php-helper parameters
domain-manager <IP/HOSTNAME> Configures the captive-portal access point‘s RF Domain manager as the php-helper
  • <IP/HOSTNAME> – Specify the RF Domain manager‘s IP address or host name.

Examples

To enable php-helper configure the following parameters in the captive-portal context:

ap505-13403B(config-captive-portal-php-helper)#oauth
ap505-13403B(config-captive-portal-php-helper)#php-helper controller nx9500-6C8809
ap505-13403B(config-captive-portal-php-helper)#server mode self
ap505-13403B(config-captive-portal-php-helper)#server host cpsocial.extreme.com

Note, when configuring the server, specify the server‘s hostname and not the IP address, because some social media do not allow IP address as a redirect URI.

ap505-13403B(config-captive-portal-php-helper)#show running-config captive-portal php-helper
captive-portal php-helper
 server host cpsocial.extreme.com
 php-helper controller nx9500-6C8809
 oauth
 webpage internal registration field city type text enable label "City" placeholder "Enter City"
 webpage internal registration field street type text enable label "Address" placeholder "123 Any Street"
 webpage internal registration field name type text enable label "Full Name" placeholder 
--More--
ap505-13403B(config-captive-portal-php-helper)#

Related Commands

no Removes the PHP helper configuration
9036514-01 Rev AA