Adding an Access Warning Banner

Owned by Nina Cardillo
Last updated: 17-Jul-2024
3 min read

For SmartServer 4.2 and prior, see Adding an Access Warning Banner (Release 4.2 and Prior).

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. In this way, the GSA-required warning banner will be displayed when the user accesses the SmartServer through the SmartServer Configuration pages. This section describes how to implement a custom home page with a warning banner.

You can implement support for GSA warning banner requirements using a custom background image on the standard configuration home page. For this application, the standard background image needs to be replaced with an updated version of the background image that includes the required GSA warning 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. Back up the standard background image named bg-login.jpg, located in the following directory on the SmartServer IoT, to your PC:

    /usr/share/cockpit/branding/enocean/bg-login.jpg



    This backup can be used in case you need to restore to the original.

  3. Download the custom background image (also named bg-login.png) that includes the GSA-required warning banner from the SmartServer GitHub Repository. 

  4. Replace the standard background image on the SmartServer IoT with a copy of the custom background image of the same name, which was downloaded in step #3, into the following directory (also specified step #2).

    /usr/share/cockpit/branding/enocean/bg-login.jpg



  5. Open the SmartServer Configuration home page.

  6. Verify that the SmartServer Configuration home page displays the GSA-required warning banner as shown in the example below. You may need to clear your browser’s cache to prevent the old image from being displayed. To clear the browser's cache, see Clearing the Browser's Cache.