> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/wazuh/wazuh-dashboard-plugins/llms.txt
> Use this file to discover all available pages before exploring further.

# Compatibility Matrix

> Version compatibility requirements for Wazuh Dashboard Plugins with OpenSearch Dashboards, Node.js, and Wazuh Server

## Overview

Wazuh Dashboard Plugins require specific versions of dependencies to function correctly. This page provides comprehensive compatibility information for different versions.

> [!WARNING]
>
> Always verify compatibility before installation to avoid runtime issues and ensure proper functionality.

## Current Version (5.0.0)

### Wazuh Dashboard Plugins 5.0.0-alpha0

> **Plugin Version**
>
> 5.0.0-00

> **Platform Version**
>
> 3.5.0

> **Stage**
>
> alpha0

### Core Dependencies

| Component | Version | Required |
| - | - | - |
| OpenSearch Dashboards | 3.5.0 | Yes |
| Node.js | 22.22.0 | Yes |
| Wazuh Server | 5.0.0 | Yes |
| Yarn | 1.22.0+ | Yes |
| TypeScript | 5.5.2 | Yes (dev) |

### Plugin Dependencies

#### Main Plugin (wazuh)

> **Required OpenSearch Dashboards Plugins**
>
> ```json theme={null}
> [
>   "navigation",
>   "data",
>   "dashboard",
>   "embeddable",
>   "discover",
>   "inspector",
>   "visualizations",
>   "uiActions",
>   "charts",
>   "savedObjects",
>   "opensearchDashboardsReact",
>   "opensearchDashboardsUtils",
>   "opensearchDashboardsLegacy",
>   "wazuhCheckUpdates",
>   "wazuhCore"
> ]
> ```

> **Optional OpenSearch Dashboards Plugins**
>
> ```json theme={null}
> [
>   "security",
>   "securityDashboards",
>   "searchguard",
>   "telemetry",
>   "notificationsDashboards",
>   "alertingDashboards",
>   "reportsDashboards"
> ]
> ```

#### Wazuh Core Plugin (wazuhCore)

| Dependency | Version | Purpose |
| - | - | - |
| Required Plugins | `navigation`, `opensearchDashboardsUtils` | Core functionality |
| Optional Plugins | `securityDashboards` | Enhanced security features |

#### Wazuh Check Updates Plugin (wazuhCheckUpdates)

| Dependency | Version | Purpose |
| - | - | - |
| Required Plugins | `navigation`, `opensearchDashboardsUtils`, `opensearchDashboardsReact`, `wazuhCore` | Update checking |
| Optional Plugins | `securityDashboards` | Security integration |

### JavaScript/Node.js Dependencies

**Main Plugin**

#### Production Dependencies

```json theme={null}
{
  "axios": "1.13.3",
  "dompurify": "3.2.4",
  "js2xmlparser": "^5.0.0",
  "jsdom": "^16.6.0",
  "json-2-csv": "^3.20.0",
  "jwt-decode": "^3.1.2",
  "loglevel": "1.9.2",
  "markdown-it-link-attributes": "^4.0.1",
  "md5": "^2.3.0",
  "node-cron": "^1.1.2",
  "react-cookie": "^4.0.3"
}
```

#### Development Dependencies

```json theme={null}
{
  "@typescript-eslint/eslint-plugin": "^6.2.1",
  "@typescript-eslint/parser": "^6.2.1",
  "eslint": "^8.46.0",
  "prettier": "^2.7.1",
  "typescript": "^5.5.2"
}
```

**Wazuh Core**

#### Production Dependencies

```json theme={null}
{
  "axios": "1.13.3",
  "jwt-decode": "^3.1.2",
  "md5": "^2.3.0",
  "node-cron": "^3.0.2"
}
```

**Wazuh Check Updates**

#### Production Dependencies

```json theme={null}
{
  "axios": "1.13.3",
  "md5": "^2.3.0",
  "node-cron": "^3.0.2"
}
```

### Security Resolutions

The plugins enforce specific versions for security-critical dependencies:

```json theme={null}
{
  "**/es5-ext": "^0.10.63",
  "**/follow-redirects": "^1.15.6",
  "cross-spawn": "^7.0.5",
  "**/@babel/runtime-corejs3": "^7.27.0",
  "smol-toml": "1.3.1",
  "micromatch": "4.0.8",
  "form-data": "^4.0.4",
  "tar-fs": "2.1.4",
  "cookie": "0.7.0"
}
```

## Historical Compatibility

### Wazuh 4.x Series

**4.14.x**

#### Wazuh 4.14.5

| Component | Version |
| - | - |
| OpenSearch Dashboards | 2.19.4 |
| Wazuh Server | 4.14.5 |
| Plugin Revision | 00 |

**4.13.x**

#### Wazuh 4.13.x

| Component | Version |
| - | - |
| OpenSearch Dashboards | 2.18.x |
| Wazuh Server | 4.13.x |

**4.12.x**

#### Wazuh 4.12.x

| Component | Version |
| - | - |
| OpenSearch Dashboards | 2.17.x |
| Wazuh Server | 4.12.x |

## Docker Environment Compatibility

### Development Images

Wazuh provides pre-built Docker images for development:

| Image | Platform Version | Node.js | Registry |
| - | - | - | - |
| osd-dev:3.5.0 | OpenSearch Dashboards 3.5.0 | 22.22.0 | quay.io/wazuh |
| osd-dev:2.19.0 | OpenSearch Dashboards 2.19.0 | 18.x | quay.io/wazuh |
| osd-dev:2.18.0 | OpenSearch Dashboards 2.18.0 | 18.x | quay.io/wazuh |

### Docker Requirements

> **Docker Desktop**
>
> Version with Docker Compose 2.20.2+

> **System Resources**
>
> 8 GB RAM minimum, 4 CPU cores

## Browser Compatibility

The Wazuh Dashboard Plugins support modern browsers:

**Supported**

* Chrome 90+
* Firefox 88+
* Safari 14+
* Edge 90+

**Not Supported**

* Internet Explorer (all versions)
* Chrome \< 90
* Firefox \< 88
* Safari \< 14

## Operating System Compatibility

### Development

| OS | Version | Support Status |
| - | - | - |
| Ubuntu | 20.04, 22.04, 24.04 | Full |
| Debian | 10, 11, 12 | Full |
| Fedora | 38, 39, 40 | Full |
| macOS | 12+, 13+, 14+ | Full |
| Windows | 10, 11 (via WSL2) | Full |

### Production

For production deployments, refer to the [Wazuh Installation Guide](https://documentation.wazuh.com/current/installation-guide/index.html) for complete OS compatibility.

## API Compatibility

### Wazuh Server API

The dashboard plugins communicate with the Wazuh Server API:

| Plugin Version | Compatible API Versions |
| - | - |
| 5.0.0 | 5.0.0 |
| 4.14.x | 4.14.x |
| 4.13.x | 4.13.x |

> [!WARNING]
>
> **API Version Mismatch**: Ensure your Wazuh Dashboard Plugin version matches your Wazuh Server version for optimal compatibility.

### API Endpoints

The plugins use these API specifications:

```bash theme={null}
# Version 5.0.0 API spec
https://raw.githubusercontent.com/wazuh/wazuh/v5.0.0/api/api/spec/spec.yaml

# Version 4.14.x API spec
https://raw.githubusercontent.com/wazuh/wazuh/v4.14.0/api/api/spec/spec.yaml
```

## Index Pattern Compatibility

### Version 5.0.0 Index Patterns

Wazuh 5.0.0 introduced new index patterns:

```text Default Events theme={null}
wazuh-events*
```

```text Security Events theme={null}
wazuh-events-security*
wazuh-events-system-activity*
wazuh-events-network-activity*
wazuh-events-access-management*
wazuh-events-applications*
```

```text Cloud Services theme={null}
wazuh-events-cloud-services*
wazuh-events-cloud-services-aws*
wazuh-events-cloud-services-azure*
wazuh-events-cloud-services-gcp*
```

```text IT Hygiene & States theme={null}
wazuh-states-it-hygiene*
wazuh-states-it-hygiene-packages*
wazuh-states-fim-files*
wazuh-states-vulnerabilities*
wazuh-states-sca*
```

> [!NOTE]
>
> **Migration Note**: Wazuh 5.0.0 replaced `wazuh-alerts*` with `wazuh-events*` as the default index pattern.

## Elasticsearch vs OpenSearch

### Platform Evolution

| Version Range | Platform | Notes |
| - | - | - |
| 4.3+ | OpenSearch Dashboards | Primary platform |
| 4.2-4.3 | OpenSearch & Elastic | Dual support |
| \< 4.2 | Kibana (Elastic) | Legacy |

### Current Focus

Wazuh Dashboard Plugins 5.0.0 exclusively supports **OpenSearch Dashboards**.

## Security Plugin Compatibility

Wazuh integrates with various security plugins:

| Security Plugin | Version | Status |
| - | - | - |
| OpenSearch Security | 3.5.0 | Supported |
| Security Dashboards | 3.5.0 | Supported |
| Search Guard | Compatible versions | Optional |

## Upgrade Paths

### From 4.14.x to 5.0.0

**1. Review Breaking Changes**

* Index patterns changed from `wazuh-alerts*` to `wazuh-events*`
* Removed deprecated modules (OpenSCAP, CIS-CAT, Osquery)
* Configuration migrated from `wazuh.yml` to `opensearch_dashboards.yml`

**2. Backup Data**

Backup your OpenSearch indices and configuration

**3. Upgrade Components**

1. Upgrade Wazuh Server to 5.0.0
2. Upgrade OpenSearch to compatible version
3. Upgrade OpenSearch Dashboards to 3.5.0
4. Install Wazuh Dashboard Plugins 5.0.0

**4. Verify Health Checks**

Allow automatic health checks to recreate index patterns and configurations

> [!WARNING]
>
> **Major Version Upgrade**: Upgrading from 4.x to 5.0 includes breaking changes. Review the [CHANGELOG](https://github.com/wazuh/wazuh-dashboard-plugins/blob/master/CHANGELOG.md) carefully.

## Testing Compatibility

Before deploying to production, verify compatibility:

**1. Development Environment**

Test with Docker development environment

**2. Run Health Checks**

Verify all health checks pass after installation

**3. API Connectivity**

Confirm dashboard can communicate with Wazuh Server API

**4. Index Patterns**

Ensure index patterns are created correctly

## Getting Help

If you encounter compatibility issues:

> **[GitHub Issues](https://github.com/wazuh/wazuh-dashboard-plugins/issues)**
>
> Report bugs and compatibility problems

> **[Slack Community](https://wazuh.com/community/join-us-on-slack/)**
>
> Get help from the community

> **[Documentation](https://documentation.wazuh.com)**
>
> Read official documentation

> **[Forums](https://groups.google.com/forum/#!forum/wazuh)**
>
> Join community discussions

## Version Checking

To verify your installed versions:

```bash theme={null}
# Check Node.js version
node --version

# Check plugin versions
bin/opensearch-dashboards-plugin list

# Check OpenSearch Dashboards version
cat config/opensearch_dashboards.yml | grep version

# Inside the repository, check Wazuh plugin version
cat VERSION.json
```

## Future Compatibility

> [!NOTE]
>
> Wazuh maintains backward compatibility within major versions (e.g., 5.x series). However, major version upgrades may include breaking changes.

Stay updated with:

* [Release Notes](https://github.com/wazuh/wazuh-dashboard-plugins/releases)
* [Changelog](https://github.com/wazuh/wazuh-dashboard-plugins/blob/master/CHANGELOG.md)
* [Wazuh Blog](https://wazuh.com/blog/)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.