12 Rebranding

Overview

There are several ways in which you can customize and rebrand your Zabbix frontend installation:

  • replace the Zabbix logo with a desired one;
  • hide the links to the Zabbix Support and Zabbix Integrations pages;
  • set a custom link to the Help page;
  • change the copyright notice in the footer.

How to

First you need to create a PHP file and save it as local/conf/brand.conf.php. The contents of the file should be as follows:

  1. <?php
  3.        return [];

This will hide the links to the Zabbix Support and Zabbix Integrations pages.

To use a custom logo, add the following line to the array from the previous listing:

  1. 'BRAND_LOGO' => '{Path to an image on the disk or URL}',

Note that the path to the image on the disk should be relative to the Zabbix frontend root directory. So, for example, if the image is located in the same directory as the brand.conf.php file, then the path to the image should be: './local/conf/custom_logo.png'.

There are two additional images of the Zabbix logo that can be overridden:

  • BRAND_LOGO_SIDEBAR - displayed when the sidebar is expanded;
  • BRAND_LOGO_SIDEBAR_COMPACT - displayed when the sidebar is collapsed.

To override:

  1. 'BRAND_LOGO_SIDEBAR' => '{Path to an image on the disk or URL}',
  2.        'BRAND_LOGO_SIDEBAR_COMPACT' => '{Path to an image on the disk or URL}',

Any image format supported by modern browsers can be used: JPG, PNG, SVG, BMP, WebP, and GIF.

Custom logos will not be scaled, resized or modified in any other way, and will be displayed in their original size and proportions, except for the BRAND_LOGO_SIDEBAR_COMPACT that will be cropped (width: 24px; height: the same as BRAND_LOGO_SIDEBAR) to fit the collapsed sidebar. For reference, the following dimensions are used for Zabbix logos:

  • BRAND_LOGO: 114x30px
  • BRAND_LOGO_SIDEBAR: 91x24px
  • BRAND_LOGO_SIDEBAR_COMPACT: 24x24px

To set a custom copyright notice, add BRAND_FOOTER to the array from the first listing. Please be aware that HTML is not supported here. Setting BRAND_FOOTER to an empty string will hide the copyright notice completely (but the footer will stay in place).

  1. 'BRAND_FOOTER' => '{text}',
Custom help location

To replace the default Help link with a link of your choice, add BRAND_HELP_URL to the array from the first listing.

  1. 'BRAND_HELP_URL' => '{URL}'
File example
  1. <?php
  3.        return [
  4.            'BRAND_LOGO' => './my_images/custom_logo.png',
  5.            'BRAND_LOGO_SIDEBAR' => './my_images/custom_logo_sidebar.png',
  6.            'BRAND_LOGO_SIDEBAR_COMPACT' => './my_images/custom_logo_sidebar_compact.png',
  7.            'BRAND_FOOTER' => '© Zabbix',
  8.            'BRAND_HELP_URL' => 'https://www.example.com/help/'
  9.        ];