Adding an Access Warning Banner

Some organizations, like the General Services Administration (GSA), require a warning banner with specific, approved language at IT access points to the SmartServer IoT. The SmartServer IoT supports updating or replacing the SmartServer home page in order to customize the web interface that is displayed to the user. It also provides the ability to replace the company logo on the SmartServer CMS login window with the GSA-required warning banner. In this way, you can be assured that the GSA-required warning banner will be displayed regardless of whether the user accesses the SmartServer through the SmartServer Configuration pages, or directly through the CMS URL. 

This section describes how to replace the SmartServer home page with a custom home page that includes a warning banner, as well as how to replace the company logo on the CMS login window with a warning banner, and consists of the following:

Implementing a Custom Home Page with a Warning Banner

The home page customization is accomplished as the SmartServer IoT searches for a custom home page that is named home.html in a specific user directory. If a custom home page is found, then it will be displayed instead of the standard, built-in home page. If a custom home page is not found, then the SmartServer will display the standard home page. Storing custom web pages in the specified user directory also ensures that these pages will not be deleted during a SmartServer software upgrade.

Support for GSA warning banner requirements is implemented using a custom background image on the standard home page. For this application, the standard home page needs to be copied to the custom web page directory, along with an updated version of the home page background image that includes the required GSA banner. This updated background image can be downloaded from the SmartServer GitHub Repository

To implement a custom home page that includes GSA-required warning language, perform the following steps:

  1. Log into your SmartServer IoT using an SFTP client (e.g., WinSCP) and apollo credentials.

  2. Copy the standard, built-in home page named home.html from the following directory on the SmartServer IoT to your PC:

    /usr/lib/apollo/www/home.html



  3. Move the standard home.html page to the custom web page directory on the SmartServer IoT as shown below.

    /var/apollo/www/user/home.html



  4. Download the custom background image (named home.png) that includes the GSA-required warning banner from the SmartServer GitHub Repository

  5. Copy the custom background image to the SmartServer custom web page directory as shown below.

    /var/apollo/www/user/home.png



  6. Open the SmartServer Configuration home page.

  7. Verify that the Configuration home page displays the GSA-required warning banner as shown in the example below. 

    Clearing our browser's cache

    You may need to clear your browser’s cache to prevent the old image from being displayed. For information on how to clear cached data, refer to the links below:


Implementing a Warning Banner on the CMS Login Window 

Implementing a warning banner on the CMS Login window requires smartServer 3.5 Update 2 or higher.

Customizing the SmartServer CMS login window by replacing the company logo with a warning banner is accomplished by first downloading a custom logo named warningLogo.svg from the SmartServer GitHub Repository, and then copying this alternate logo file to a location in the SmartServer CMS directory.  When this alternate logo is in place in the CMS directory, the SmartServer will display this alternate logo, which includes the GSA-required warning banner.

To use the alternate logo on the CMS login window with the GSA-required warning banner, perform the following steps:

  1. Download the custom logo named warningLogo.svg that includes the GSA-required warning banner from the SmartServer GitHub Repository

  2. Log into your SmartServer IoT using an SFTP client (e.g., WinSCP) and apollo credentials.

  3. Copy warningLogo.svg into the SmartServer CMS directory shown below.

    /var/apollo/data/cms/warningLogo.svg



  4. Open the SmartServer IoT CMS.

  5. Verify that the CMS login window displays the GSA-required warning banner as shown in the example below. 



    Clearing our browser's cache

    You may need to clear your browser’s cache to prevent the old image from being displayed. For information on how to clear cached data, refer to the links below: