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. For installation instructions, refer to the mdBook documentation.

Usage

  • To build the documentation, run:

    ./build.sh
    

    The output will be generated in the book directory.

  • To serve the documentation locally for preview, run:

    ./serve.sh
    

    The documentation will be available at http://127.0.0.1:3000.

Development documentation

Set up the development environment

How to generate a package

How to generate a container image

How to build from sources

How to run from sources

How to run the tests

Reference manual

Description

Architecture

Compatibility

Getting Started

Requirements

Packages

Installation

Configuration

Environment variables

Command line options

Configuration files

Modules

Setup

Architecture

API reference

Command Manager

Architecture

API reference

Content Manager

Architecture

API reference

Upgrade

Uninstall

Backup and restore

Security

Performance

Glossary