Configuration file¶

The Wazuh app includes a configuration file (located at /usr/share/kibana/optimize/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 the file, uncomment any of them and apply the desired values. You can also edit these settings from the Wazuh app in Settings > Configuration.

The configuration file reference is organized by sections:

Basic options¶

hosts¶

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

hosts:
    - <id>:
        url: http(s)://<url>
        port: <port>
        user: <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
        user: foo
        password: secret_password
    - wazuh_test:
        url: https://localhost
        port: 55000
        user: foo
        password: bar

pattern¶

Default index pattern to use on the app. If there’s no valid index patterns on Elasticsearch, the app will automatically create one with the name indicated in this option.

Default value	wazuh-alerts-3.x-*
Allowed values	Any valid index pattern

timeout¶

Defines the maximum time the app will wait for an API response when making requests to it. It will be ignored if the value is set under 1500 milliseconds.

Default value	8000 (milliseconds)
Allowed values	Any number starting from 1500

api.selector¶

Defines if the user is allowed to change the selected API directly from the Wazuh app top menu.

Default value	false
Allowed values	true,false

ip.selector¶

Defines if the user is allowed to change the selected index pattern directly from the top menu bar.

Default value	true
Allowed values	true,false

ip.ignore¶

Disable certain index pattern names from being available in index pattern selector from the Wazuh app. An empty list (the default value) won’t ignore any valid index pattern.

Default value	[]
Allowed values	Array of strings. Eg: [“wazuh-archives-*”]

xpack.rbac.enabled¶

Enable or disable X-Pack RBAC security capabilities when using the app.

Default value	true
Allowed values	true,false

admin¶

Enable or disable administrator requests to the Wazuh API when using the app. This makes PUT, POST and DELETE requests available on the Dev tools tab.

Default value	true
Allowed values	true,false

logs.level¶

Set the logging level for the Wazuh App log files.

Default value	info
Allowed values	info,debug

hideManagerAlerts¶

Hide the manager’s alerts in the dashboard visualizations.

Default value	false
Allowed values	true,false

Monitoring¶

wazuh.monitoring.enabled¶

Enable or disable the wazuh-monitoring index creation and/or visualization:

When the value is set to true, the app will show the Agents status visualization and will insert monitoring-related data.
When the value is set to false, the app won’t show the visualization and won’t insert monitoring-related data.
When the value is set to worker, the app will show the visualization, but won’t insert monitoring-related data.

Default value	true
Allowed values	true,false,worker

wazuh.monitoring.frequency¶

Define in seconds the frequency of API requests to get the state of the agents to create a new document in the wazuh-monitoring index with this data.

Default value	900 (seconds)
Allowed values	Any number starting from 60

Warning

Although the minimum value can be 60, we recommend adjusting it to at least 300 seconds to avoid overloading issues due to the excessive creation of documents into the index.

wazuh.monitoring.pattern¶

Default Wazuh monitoring index pattern to use for the app. This setting does not remove any existing patterns or templates, it just updates the app to add the new ones.

Default value	wazuh-monitoring-3.x-*
Allowed values	Any valid index pattern

wazuh.monitoring.creation¶

Configure wazuh-monitoring-3.x-* indices custom creation interval.

Default value	d (daily)
Allowed values	h (hourly), d (daily), w (weekly), m (monthly)

Checks¶

checks.pattern¶

Enable or disable the index pattern health check when opening the app.

Default value	true
Allowed values	true,false

checks.template¶

Enable or disable the template health check when opening the app.

Default value	true
Allowed values	true,false

checks.api¶

Enable or disable the API health check when opening the app.

Default value	true
Allowed values	true,false

checks.setup¶

Enable or disable the setup health check when opening the app.

Default value	true
Allowed values	true,false

checks.fields¶

Enable or disable the known fields health check when opening the app.

Default value	true
Allowed values	true,false

Extensions¶

Note

These options are only applied for newly inserted APIs on the Settings tab, not for the existing ones.

extensions.pci¶

Enable or disable the PCI DSS tab on Overview and Agents.

Default value	true
Allowed values	true,false

extensions.audit¶

Enable or disable the Audit tab on Overview and Agents.

Default value	true
Allowed values	true,false

extensions.oscap¶

Enable or disable the Open SCAP tab on Overview and Agents.

Default value	true
Allowed values	true,false

extensions.ciscat¶

Enable or disable the CIS-CAT tab on Overview and Agents.

Default value	false
Allowed values	true,false

extensions.aws¶

Enable or disable the Amazon (AWS) tab on Overview and Agents.

Default value	false
Allowed values	true,false

extensions.virustotal¶

Enable or disable the VirusTotal tab on Overview and Agents.

Default value	false
Allowed values	true,false

extensions.osquery¶

Enable or disable the Osquery tab on Overview and Agents.

Default value	false
Allowed values	true,false

extensions.docker¶

Enable or disable the Docker listener tab on Overview and Agents.

Default value	false
Allowed values	true,false

Advanced index options¶