Overview
Custom branding allows you to:- Replace the Dashboard loading logo
- Customize the header logo
- Set custom logos for the Wazuh application
- Brand PDF reports with custom headers and footers
- Support both light and dark mode themes
Dashboard Loading and Header Logos
The Dashboard uses OpenSearch Dashboards branding configuration to customize the loading screen and header logos.Configuration
Edit theopensearch_dashboards.yml file to set custom branding URLs:
Branding Parameters
loadingLogo.defaultUrl
URL to the logo displayed on the loading screen in light mode.
loadingLogo.darkModeUrl
URL to the logo displayed on the loading screen in dark mode.
mark.defaultUrl
URL to the logo displayed in the Dashboard header in light mode.
mark.darkModeUrl
URL to the logo displayed in the Dashboard header in dark mode.
Logo Requirements
File Format: PNG, SVG, or JPG Recommended Dimensions:- Loading logo: 200px × 200px
- Header logo: 40px × 40px (height), variable width
- Use publicly accessible URLs (HTTPS recommended)
- Alternatively, use local file paths or data URIs
Apply Configuration
Restart the Wazuh Dashboard service after modifying the configuration:Wazuh Application Custom Logos
The Wazuh application provides additional branding options for logos displayed within the application interface.Configuration Methods
Dashboard Management UI (Recommended)
If the App Settings UI is available in your build:- Navigate to Dashboard management > App Settings
- Locate the Custom branding section
- Configure the following properties:
customization.logo.appcustomization.logo.healthcheckcustomization.logo.reports
- Upload or specify URLs for your custom logos
- Apply the changes
Logo Properties
customization.logo.app
Logo displayed in the main Wazuh application interface.
Recommended dimensions: 300px × 70px
customization.logo.healthcheck
Logo displayed on the health check screen.
Recommended dimensions: 300px × 70px
customization.logo.reports
Logo included in generated PDF reports.
Recommended dimensions: 190px × 40px (optimized for print)
Asset Storage Location
Custom logo assets are stored in the following directory:File-Based Configuration (Deprecated)
Note: In-filecustomization.logo.* settings are deprecated. Use the Dashboard management UI to update these values when available.
If the App Settings UI is not present in your version, rely exclusively on the opensearchDashboards.branding settings in opensearch_dashboards.yml.
PDF Reports Branding
Customize the branding elements that appear in generated PDF reports.Configuration
Configure PDF report branding through Dashboard management > App Settings: Logo:Report Branding Elements
Report Logo The logo displayed at the top of PDF reports. Use thecustomization.logo.reports setting.
Recommended specifications:
- Format: PNG or SVG
- Dimensions: 190px × 40px
- Resolution: 150-300 DPI for print quality
customization.reports.header setting.
Example:
customization.reports.footer setting.
Example:
Best Practices for Report Branding
- Print-Friendly Colors: Use colors that render well in both digital and print formats
- High Resolution: Provide high-resolution logos (at least 150 DPI)
- Simple Designs: Logos with simple designs render better in PDF format
- Contrast: Ensure sufficient contrast between text and background
- File Size: Optimize images to keep PDF file sizes manageable
Advanced Branding Options
Using Local Files
Instead of hosting logos on an external server, you can use local file paths:Using Data URIs
Embed logos directly in the configuration using base64-encoded data URIs:Theme-Specific Logos
Provide different logos for light and dark themes to ensure optimal visibility: Light Mode Logo:- Use darker colors for contrast against light backgrounds
- Ensure logo elements are clearly visible
- Use lighter colors or inverse versions
- May require a different color scheme or outline
Branding Verification
Check Configuration
Verify your branding configuration is correctly applied:- Clear browser cache to ensure you see the latest changes
- Test both themes (light and dark mode)
- Generate a test report to verify PDF branding
- Check health check screen to verify health check logo
Browser Developer Tools
Use browser developer tools to inspect logo loading:- Open browser developer console (F12)
- Navigate to the Network tab
- Filter by image requests
- Verify custom logos are loading without errors
- Check for 404 errors or CORS issues
Troubleshooting
Logo Not Displaying
Possible Causes:- Incorrect URL or file path
- File permissions preventing access
- CORS restrictions on external URLs
- Browser caching old logos
- Verify the URL or path is accessible
- Check file permissions:
chmod 644 /path/to/logo.png - Configure CORS headers if using external hosting
- Clear browser cache and hard refresh (Ctrl+F5)
- Check Dashboard logs for loading errors
Logo Quality Issues
Problem: Logo appears blurry or pixelated Solutions:- Use higher resolution images (2x or 3x for retina displays)
- Use vector formats (SVG) when possible
- Ensure image dimensions match recommended sizes
- Avoid excessive scaling
PDF Report Logos Not Appearing
Solutions:- Verify
customization.logo.reportsis configured - Ensure the logo file is accessible from the server
- Check PDF generation logs for errors
- Test with a simple, smaller logo file
Dark Mode Logo Not Switching
Solutions:- Verify
darkModeUrlis configured - Clear browser cache
- Check that theme switching is working correctly
- Ensure dark mode logo URL is accessible
Security Considerations
- Use HTTPS: Host logos on HTTPS URLs to avoid mixed content warnings
- File Permissions: Restrict access to logo files to necessary users only
- External URLs: Validate external logo URLs are from trusted sources
- File Size Limits: Implement file size restrictions to prevent resource exhaustion
- Input Validation: Sanitize logo URLs to prevent injection attacks