Wazuh dashboard settings

The Wazuh dashboard includes a configuration file located at /usr/share/wazuh-dashboard/data/wazuh/config/wazuh.yml where you can define custom values for several options. This section describes all the settings available in this file.

The configuration file shows the default values for all of the possible options. You can edit this file, uncomment any of them, and apply the desired values. You can edit these settings from the Wazuh dashboard in Dashboard management > App Settings > Configuration.

The configuration file reference is organized into sections:

General options
Health check

General

hosts

Defines the list of APIs to connect with your Wazuh managers.

hosts:
    - <host_id/host_name>:
        url: http(s)://<WAZUH_MANAGER_IP_ADDRESS>
        port: <PORT>
        username: <USERNAME>
        password: <PASSWORD>

Note

It is required to specify at least one host.

This is an example of a multi-host configuration:

hosts:
    - wazuh_prod:
        url: https://wazuh.com
        port: 55000
        username: wazuh-wui
        password: secret_password
        run_as: false
    - wazuh_test:
        url: https://localhost
        port: 55000
        username: wazuh-wui
        password: wazuh-wui
        run_as: false

The following table shows the configuration options for the Wazuh dashboard:

Configuration name	Description	Default value	Allowed values
General options
pattern	The property defines the default index pattern to use on the Wazuh dashboard. If there is no valid index pattern specified, the Wazuh dashboard automatically creates one with the name indicated in this option.	`wazuh-alerts-*`	Any valid index pattern
timeout	This property defines the maximum time (in milliseconds) the Wazuh dashboard will wait for an API response when making requests to it. Setting a value under `1500` milliseconds will be ignored and the dashboard will use the default value instead.	`20000`	Any number starting from 1500
ip.selector	This property defines if a user can change the selected index pattern directly from the top menu bar on the Wazuh dashboard WUI.	`true`	true, false
ip.ignore	This property is used to disable certain index pattern names from being available in the index pattern selector on the Wazuh dashboard. An empty list (the default value) won't ignore any valid index pattern.	`[]`	Array of strings. Eg: `["wazuh-archives-*"]`
hideManagerAlerts	This property controls if the Wazuh manager alerts in the dashboard visualizations are visible or not. A value of false displays the Wazuh manager alerts on dashboard visualizations.	`false`	true, false
alerts.sample.prefix	This property defines the index name prefix of sample alerts. It must match the template used by the index pattern to avoid unknown fields in dashboards.	`wazuh-alerts-5.x-`	Any valid index pattern
enrollment.dns	This property specifies the Wazuh registration server used for Wazuh agent enrollment.	`' '`	Any string
enrollment.password	This property specifies the password used to authenticate during the agent enrollment. `enrollment.password` takes a higher precedence over `authd.pass` agent enrollment password set on the Wazuh manager. When both values are set, the value of `enrollment.password` will be used instead.	`' '`	Any string
wazuh.updates.disabled	This property defines if the check updates service is disabled.	`false`	true, false
Health checks
checks.pattern	This property enables or disables the index pattern health check when opening the Wazuh dashboard. If set to false, index patterns will not be checked during the Wazuh healthcheck.	`true`	true, false
checks.template	This property enables or disables the template health check when opening the Wazuh dashboard. It checks to see if the defined index has a valid template. Set this value to false if you do not want the index template to be validated when opening the Wazuh dashboard.	`true`	true, false
checks.api	This property enables or disables the Wazuh server API health check when opening the Wazuh dashboard. Set the value of this property to `false` if you do not require this check when opening the dashboard.	`true`	true, false
checks.setup	This property enables or disables the setup health check when opening the Wazuh dashboard. It checks that the Wazuh server version is compatible with the plugin version. Setting this value to `false` might cause the dashboard to fail if there is a compatibility issue between the dashboard plugins and Wazuh server.	`true`	true, false
checks.fields	This property enables or disables the known fields health check when opening the Wazuh dashboard. Known fields refer to the fields in your indexed documents that the indexer has identified, mapped, and available for querying.	`true`	true, false
checks.metaFields	Meta fields are special fields that provide additional metadata about indexed documents such as the `_index` and `_id`. This property enables or disables the metaFields health check when opening the Wazuh dashboard.	`true`	true, false
checks.timeFilter	This property enables or disables the timeFilter health check when opening the Wazuh dashboard. It checks to ensure a value is set for the dashboard time filter. The time filter is used to set the time range of data displayed on the dashboard.	`true`	true, false
checks.maxBuckets	This property enables or disables the maxBuckets health check when opening the Wazuh dashboard. It checks to ensure that the maximum number of buckets that a single aggregation request can create is at optimal levels. This helps to prevent excessive memory usage and potential out-of-memory errors.	`true`	true, false

Example

This is an example of the /usr/share/wazuh-dashboard/data/wazuh/config/wazuh.yml configuration:

#General options

hosts:
    - env-1:
        url: https://env-1.example
        port: 55000
        username: wazuh-wui
        password: wazuh-wui
        run_as: true
    - env-2:
        url: https://env-2.example
        port: 55000
        username: wazuh-wui
        password: wazuh-wui
        run_as: true

pattern: 'wazuh-alerts-*'
timeout: 20000
ip.selector: true
ip.ignore: []
logs.level: info
hideManagerAlerts: true
alerts.sample.prefix: wazuh-alerts-4.x-
wazuh.updates.disabled: false

#Health checks

checks.pattern : true
checks.template: true
checks.fields  : true
checks.api     : true
checks.setup   : true
checks.metaFields: true
checks.timeFilter: true
checks.maxBuckets: true

#Custom branding

customization.enabled: true
customization.logo.app: 'custom/images/customization.logo.app.jpg'

customization.logo.healthcheck: 'custom/images/customization.logo.healthcheck.svg'
customization.logo.reports: 'custom/images/customization.logo.reports.jpg'
customization.reports.footer: '123 Custom footer Ave.\nSan Jose, CA 95148'
customization.reports.header: 'Custom Company\ninfo@custom.com\n@social_reference'

#Enrollment DNS

enrollment.dns: ''
enrollment.password: ''