User Manual

125
UniFi Controller User Guide
Ubiquiti Networks, Inc.
Appendix A: Portal Customization with LegacyJSP
Appendix A: Portal
Customization with
LegacyJSP
Before You Begin
Starting with UniFi v5, you have two options for portal
customization: AngularJS and Legacy JSP.
AngularJS
AngularJS is the new option for client-side rendering. We
recommend AngularJS unless you are using old templates.
Note: AngularJS is not compatible with old
templates because the old templates were
designed to work with JSP (Java Server Pages).
The UniFi Controller offers a built-in editor to customize
AngularJS; however, it is not fully customizable at
thistime.
AngularJS is a single-page app, so it should work more
quickly. However, AngularJS uses JS (JavaScript), which
may not work with some really old web browsers or newer
browsers with JS support disabled.
AngularJS uses responsive design, so it will adapt to the
size of a mobile device, such as a tablet or smartphone.
Appendix A: Portal Customization with Legacy JSP is for
Legacy JSP implementation only. See “Settings > Guest
Control” on page 32 for more information about the
built-in editor for AngularJS.
Legacy JSP
Legacy JSP is the pre-existing option for server-side
rendering. Legacy JSP is fully customizable and uses old
HTML, so it should work with any web browser. You can
customize Legacy JSP only by overriding files. Legacy JSP
works more slowly and is not responsive by default.
Overview
With Legacy JSP, the UniFi Controller software allows
complete branding of a portal implementation, allowing
you to “white label” your wireless Internet service as if you
had developed it yourself.
In order to provide the maximum flexibility in your
branding effort, the UniFi Controller software provides
total access to the portal directory on the system in which
it is installed.
This open architecture allows you to include unlimited
content while keeping development simple through the
use of plain .html (hand code or use any editor of your
choice). Testing is simple and immediate; simply reload
changes from any browser.
Configuring Portal Customization
To enable the guest portal with custom Legacy JSP
branding, perform the following steps:
1. Go to Settings and click Guest Control.
2. Select Enable Guest Portal to enable it, and then
select an authentication method.
Note: See “Settings > Guest Control” on page
32 for more information on enabling the
Guest Portal for the following authentication and
landing page options: No authentication, Simple
Password, and Hotspot.
3. For the Template Engine setting, keep the default,
Legacy JSP.
4. For the Override Default Templates setting, select
Override templates with custom changes.
5. Click Apply Changes.