Versions Compared

Old Version 6

changes.mady.by.user Nina Cardillo

Saved on

compared with

New Version Current

changes.mady.by.user Nina Cardillo

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...


Info

For SmartServer 4.2 Update 1 to 4.4, see Adding an Access Warning Banner (Release 4.2 Update 1 to 4.4).

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. 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 users access the SmartServer through the SmartServer Configuration pagespage, 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:

Table of Contents
maxLevel
3


Implementing a

...

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

    /usr/share/libcockpit/apollobranding/wwwenocean/homebg-login.html/var/apollo/www/user/home.html
    Image Removedjpg
    Image Removed
    Move the standard home.html page to the custom web page directory on the SmartServer IoT as shown below.

    Image Added

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

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

  4. Copy Replace the custom standard background image to on the SmartServer custom web page directory as shown below.
    /var/apollo/www/user/home.png
    Image RemovedIoT 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

    Image Added

  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.  

    Info
    titleClearing 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:

    Image Removed To clear the browser's cache, see Clearing the Browser's Cache.

    Image Added

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.

...

Window

You can customize the SmartServer CMS login window by replacing the company logo with background image with a version that includes a warning banner. This customization is accomplished by first downloading a custom logo named warningLogo.svgbackground image named cms-login-background.jpg from the SmartServer GitHub Repository, and then copying this alternate logo file background image to a location in the SmartServer CMS directory.   When this the alternate logo image is in place placed in the CMS directory, the SmartServer will display this the alternate logobackground image, which includes the GSA-required warning banner.

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


  1. Download the custom logo named warningLogo.svgbackground image named cms-login-background.jpg that includes the GSA-required warning banner from the SmartServer GitHub Repository. 

  2. Log into your SmartServer IoT using  using an SFTP client (e.g., WinSCP) and apollo credentials.
    Copy warningLogo.svg into the SmartServer CMS directory shown below.
    /var/apollo/data/cms/warningLogo.svg
    Image Removed
    Open the SmartServer IoT CMS.
    Verify that root credentials. If enhanced security is enabled on your system, then you may need to temporarily disable this feature in order to log into the SmartServer with root privileges. See Enhancing Security for more information.

  3. Copy cms-login-background.jpg to the following SmartServer CMS directory:

    usr/lib/apollo/www/cms-login-background.jpg

    Image Added

  4. Right-click the newly copied cms-login-background.jpg file on the SmartServer IoT using your SFTP client and choose Properties.

  5. Modify the file permissions for Group and Others to include read access (Octal 0644) as shown below.

    Image Added

  6. Click OK.

  7. Open the SmartServer CMS.

  8. Verify that background image on the CMS login window displays the GSA-required warning banner as shown in the example below. 
    Image Removed
    Info
    titleClearing our browser's cache
    You  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:
  9. For Chrome:
    https://support.google.com/accounts/answer/32050?co=GENIE.Platform%3DDesktop&hl=en
  10. For Edge:
    https://support.microsoft.com/en-us/help/10607/microsoft-edge-view-delete-browser-history
    11. For Firefox:
    https://support.mozilla.org/en-US/kb/how-clear-firefox-cache To clear the browser's cache, see Clearing the Browser's Cache.

    Image Added