How to set up custom branding

Custom logos in the ThreatLockDown dashboard

ThreatLockDown dashboard home logo

To customize the ThreatLockDown dashboard home logo in the top header, do the following.

1. Edit opensearch_dashboards.yml. You can find this file in the following locations:

   • /etc/wazuh-dashboard/

   • /usr/share/wazuh-dashboard/config/ for Docker installations.

2. Add the URL of your default and dark theme logos.

   opensearchDashboards.branding:
      mark:
         defaultUrl: "https://domain.org/default-logo.png"
         darkModeUrl: "https://domain.org/dark-mode-logo.png"
   

Once you are done setting your custom logo image, you can find it saved in /usr/share/wazuh-dashboard/plugins/wazuh/public/assets/custom/images/.

Custom branding of the PDF reports

To customize the PDF reports, click Indexer/dashboard management > App Settings. Under the Custom branding section, set up the following properties:

• customization.reports.logo. This property sets the PDF reports logo image. It has a size limit of 1 MB. It's printed in the top left corner of the PDF reports. Recommended size: 190 pixels width, 40 pixels height. See #1 in the image below.

• customization.reports.footer. This property sets the Reports footer text block. It has a size limit of 2 lines of 50 characters each. It's printed in the bottom left corner of the PDF reports. See #2 in the image below.

• customization.reports.header. This property sets the Reports header text block. It has a size limit of 3 lines of 40 characters each. It's printed in the top right corner of the PDF reports. See #3 in the image below.

Configuration

The following settings correspond to the custom branding feature. Edit them using the user interface as explained above.

customization.enabled

Enables and disables custom branding of the ThreatLockDown dashboard and PDF reports.

Allowed values	true, false
Default value	true

customization.logo.app

This logo is used as loading indicator while the user is logging into ThreatLockDown API. It is saved as /usr/share/wazuh-dashboard/plugins/wazuh/public/assets/custom/images/customization.logo.app.<format>.

Allowed format	jpeg, jpg, png, svg
Default value	''
Maximum file size	1 MB

customization.logo.healthcheck

This is the image to be used as the health check logo. It is saved as /usr/share/wazuh-dashboard/plugins/wazuh/public/assets/custom/images/customization.logo.healthcheck.<format>.

Allowed format	jpeg, jpg, png, svg
Default value	''
Maximum file size	1 MB

customization.logo.reports

This is the image to be used as logo in the PDF reports generated by the app. It is saved as /usr/share/wazuh-dashboard/plugins/wazuh/public/assets/custom/images/customization.logo.reports.<format>.

Allowed format	jpeg, jpg, png
Default value	''
Maximum file size	1 MB

customization.reports.header

Header of the PDF reports. To use an empty header, type a space " " in the field. If the field is empty, it uses the default header.

Allowed characters	Printable characters
Default value	''
Value limit	3 lines of 40 characters each

customization.reports.footer

Footer of the PDF reports. To use an empty footer, type a space " " in the field. If the field is empty, it uses the default footer.

Allowed characters	Printable characters
Default value	''
Value limit	2 lines of 50 characters each