Wazuh Indexer Technical Documentation
This folder contains the technical documentation for the Wazuh Indexer. The documentation is organized into the following guides:
- Development Guide: Instructions for building, testing, and packaging the Indexer.
- Reference Manual: Detailed information on the Indexer’s architecture, configuration, and usage.
Requirements
To work with this documentation, you need mdBook installed.
| Tool | Required Version |
|---|---|
| mdbook | 0.5.2 |
| mdbook-mermaid | 0.17.0 |
-
Get the latest
cargo(hit enter when prompted for a default install)curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -
Install
mdbookandmdbook-mermaidcargo install mdbook --version 0.5.2 --locked cargo install mdbook-mermaid --version 0.17.0 --locked
Usage
-
To build the documentation, run:
./build.shThe output will be generated in the
bookdirectory. -
To serve the documentation locally for preview, run:
./server.shThe documentation will be available at http://127.0.0.1:3000.