Skip to content

Commit 0f3ffaf

Browse files
taylorcopilotClawdbot
andauthored
Docs: add supported tool versions matrix (#738)
* docs: add supported tool versions table * docs: move supported tool versions to getting-started --------- Co-authored-by: Clawdbot <clawdbot@Clawdbots-Mac-mini.local>
1 parent 026a7e7 commit 0f3ffaf

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Supported tool versions
2+
3+
CoPilot integrates with multiple upstream tools (SIEM, EDR, SOAR, DFIR, dashboards). In practice, “supported” means:
4+
5+
- CoPilot’s connectors/provisioning logic has been **tested** against these versions
6+
- API endpoints and payloads CoPilot relies on are stable in these versions
7+
8+
If you’re running something older/newer, it *may* work — but this table is the **known-good** baseline.
9+
10+
> If you hit a version-specific issue, open a GitHub issue with:
11+
> CoPilot version, tool version, and the exact failing endpoint/UI path.
12+
13+
---
14+
15+
## Version compatibility matrix
16+
17+
| Tool | Known-good / tested versions | Notes |
18+
|---|---:|---|
19+
| **Graylog** | **≥ 5.2** | CoPilot relies on Graylog Event Definitions writing to `gl-events_*` and uses fields that differ in older Graylog versions (ex: config differences around `event_limit`). |
20+
| **Wazuh (Manager)** | **≥ 4.8.0** | CoPilot’s vulnerability flows use Wazuh APIs that changed in newer Wazuh versions; 4.8+ is required for the “new” vulnerability API logic. |
21+
| **Grafana** | **≥ 9.x** | CoPilot provisions/uses orgs, dashboards, and datasources via Grafana’s HTTP API; Grafana 9+ is the baseline for current provisioning workflows. |
22+
| **Shuffle** | **1.x (current)** | CoPilot invokes Shuffle workflows via API key + workflow ID. Recommended: run the latest stable Shuffle (cloud UI + on-prem worker/location). |
23+
| **Velociraptor** | **0.7.x (current)** | CoPilot integrates with Velociraptor via its API for hunting/collection workflows. Recommended: stay on the latest stable 0.7.x branch. |
24+
25+
---
26+
27+
## Where to check versions
28+
29+
- **CoPilot version:** bottom-left of the CoPilot UI (or the Git tag/release you deployed)
30+
- **Graylog version:** Graylog **System → Overview**
31+
- **Wazuh version:** Wazuh dashboard footer / Wazuh API `/version`
32+
- **Grafana version:** bottom-left footer
33+
- **Shuffle version:** Shuffle admin/about (or image tag if self-hosted)
34+
- **Velociraptor version:** server UI footer / `velociraptor --version`

mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,8 @@ extra_css:
7373

7474
nav:
7575
- Home: index-mkdocs.md
76+
- Getting Started:
77+
- Supported Tool Versions: getting-started/supported-tool-versions.md
7678
- User Guide:
7779
- Overview: user/overview.md
7880
- Quickstart (Operators): user/operators-quickstart.md

0 commit comments

Comments
 (0)