• Overview
• Background image in login page
• Logo in login page and Portal session
• Logo in email digests

Branding the Portal

Overview

To customize the visual appearance of the Portal and adapt it to your corporate image, brand the following elements:

• The background image in the login page.
• The logo in the login page and in the top left corner of a Portal session.
• The logo in email digests.

Background image in login page

To replace the image that is displayed as background in the login page:

1. Upload your background image (in JPEG format) to the home directory of the nexthink account (/home/nexthink) in the Appliance using your favorite SCP client.
2. Log in to the CLI of the Appliance that hosts the Portal.
3. Move the uploaded background image to the folder where the Portal expects to find it and rename it to portal-signin-bg.jpg:

   sudo mv <your_background_image>.jpg \
/var/nexthink/portal/custom/portal-signin-bg.jpg

4. Make Portal the owner of the file:

   sudo chown nxportal:nexthink \
/var/nexthink/portal/custom/portal-signin-bg.jpg

The background image is displayed centered with respect to the login page, preserving its original aspect ratio. To cover the full display area of the web browser, the image is automatically stretched and cropped. For an optimal result, use an image with a minimum resolution of 1280x850 pixels.

Logo in login page and Portal session

To replace the Nexthink logo that appears both in the login page and in the top left corner of the browser during a Portal session:

1. Upload your logo image (in GIF format) to the home directory of the nexthink account (/home/nexthink) in the Appliance using your favorite SCP client.
2. Log in to the CLI of the Appliance that hosts the Portal.
3. Move the uploaded logo to the folder where the Portal expects to find it and rename it to logo.gif:

   sudo mv <your_logo>.gif /var/nexthink/portal/custom/logo.gif

4. Make Portal the owner of the file:

   sudo chown nxportal:nexthink \
/var/nexthink/portal/custom/logo.gif

5. Log in to the Portal to verify that your logo is displayed correctly.

Provide an image with a height of 48 pixels and a width up to 200 pixels (200x48 pixels):

• If the image has a different height, it is scaled such that the resulting image is 48 pixels tall.
• If the resulting image is more than 200 pixels wide, it is horizontally scaled down to fit 200 pixels. Otherwise, if the width of the resulting image is 200 pixels or less, the aspect ratio is preserved.

Logo in email digests

Mail clients retrieve the logo displayed in email digests from a public online location. Therefore, to replace the logo in email digests:

1. Upload your logo image to a publicly accessible location. Use a common web image format (PNG, GIF, or JPEG) so that most mail clients can display it.
2. Log in to the CLI of the Appliance that hosts the Portal.
3. Optional: If the Portal has no configuration file yet, that is, if portal.conf does not exist in folder /var/nexthink/portal/conf, create it by copying the defaults from the sample configuration file:

   sudo -u nxportal cp /var/nexthink/portal/conf/portal.conf.sample \
/var/nexthink/portal/conf/portal.conf

4. Edit the configuration file of the Portal:

   sudo vi /var/nexthink/portal/conf/portal.conf

5. Add the following line to the configuration:

   globalconfig.portal.digest.logo-url = "http://<URL_of_your_logo>"

6. Save your changes and quit the editor by typing:

   :wq

7. Restart the Portal:

   sudo systemctl restart nxportal

The logo image is displayed in the email digest with a resolution of 128x34 pixels. For an optimal result, use a logo image of this exact size or with the same aspect ratio.