• Quick Start
  • Booting
  • Platform
  • Portals
  • References
    • API Reference TOI3
    • IIP Reference
  • Resources
ARRIS Enterprises, Inc. Confidential Information

Loading Portals

Having installed the SDK enables the possibility to load and display portals on the box. The SDK contains example portals for WebKit and this guide describes how to load them.

Install the Example Portals

Begin by locating the example portals in your unpacked SDK. They should be stored in the <sdk_root>/examples directory.

You will need a functioning web server to serve the portal pages. This guide assumes you have Apache installed on your server and that the document root directory is /var/www/html.

  1. Make a copy of the appropriate portal and place it in your document root directory

    
    cd /var/www/html
    
    cp -r <sdk_root>/examples/example-html-portal .
    
    
  2. Check that your Apache server is running. If it is not, start it:

    sudo service httpd start
  3. Verify that Apache is running by using your browser to surf to 127.0.0.1, or the IP of the machine which you are using as web server. If it is not running, consult the manual of your web server to get it running.

Load the Example Portals on the STB

Once the example portals have been installed on your web server it is time to load them on your STB. Begin by establishing an SSH connection to your STB. Once the connection is established, you need to use the command line interface to verify certain settings.

The STB stores settings in information objects, which can be retrieved, inspected and modified with the toish command. Of particular interest are the CFG_PORTAL_PROXYLIST and CFG_PORTAL_WHITELISTURLS objects. The values of these objects are set by your infocast server, but they also can be modified temporarily in runtime or permanently by saving the values to flash memory.

To retrieve the values of the CFG_PORTAL_PROXYLIST and CFG_PORTAL_WHITELISTURLS objects, enter the following commands in your ssh command prompt:


toish is GetObject cfg.portal.proxylist
toish is GetObject cfg.portal.whitelisturls

The proxylist may be empty if you are not using a proxy. Otherwise, refer to the chapter on proxylist.

The whitelisturls, however, should contain an entry with the IP or hostname of your webserver. If you have not already done so, refer to the chapter on whitelisturls for information of how to configure this information object.

There is also a convenient way to temporarily add an entry to whitelisturls. This is done by adding a parameter named "whitelist" to the LoadUri command which loads a particular URL. The examples below illustrates how to do that for a Webkit bootimage.



toish LoadUri http://<webserver IP>/example-html-portal/index.html text/html whitelist

At this point, the test portals should be visible on the STB.

5.0.1

Copyright (c) 2016 ARRIS Enterprises, LLC. All Rights Reserved. ARRIS Enterprises, LLC. Confidential Information.