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 when the user accesses regardless of whether users access the SmartServer through the SmartServer Configuration page, or directly through the CMS URL.
This section describes how to implement 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
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:
- Log into your SmartServer IoT using an SFTP client (e.g., WinSCP) and apollo credentials.
- 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. - Download the custom background image (also named bg-login.jpg) that includes the GSA-required warning banner from the SmartServer GitHub Repository.
- 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 - Open the SmartServer Configuration home page.
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.
Implementing a Warning Banner on the CMS Login Window
You can customize the SmartServer CMS login window by replacing the background image with a version that includes a warning banner. This customization is accomplished by first downloading a custom background image named cms-login-background.jpg from the SmartServer GitHub Repository, and then copying this alternate background image to a location in the SmartServer CMS directory. When the alternate image is placed in the CMS directory, the SmartServer will display the alternate background image, which includes the GSA-required warning banner.
To use the alternate background image with the GSA-required warning banner on the CMS login window, perform the following steps:
- Download the custom background image named cms-login-background.jpg that includes the GSA-required warning banner from the SmartServer GitHub Repository.
- Log into your SmartServer IoT using an SFTP client (e.g., WinSCP) and 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.
- Copy cms-login-background.jpg to the following SmartServer CMS directory:
usr/lib/apollo/www/cms-login-background.jpg - Right-click the newly copied cms-login-background.jpg file on the SmartServer IoT using your SFTP client and choose Properties.
- Modify the file permissions for Group and Others to include read access (Octal 0644) as shown below.
- Click OK.
- Open the SmartServer CMS.
- Verify that background image on the CMS login window 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.