mirror of
				https://github.com/wazuh/wazuh-docker.git
				synced 2025-11-03 21:43:17 +00:00 
			
		
		
		
	Add reference documentation
This commit is contained in:
		@@ -1,6 +1,6 @@
 | 
				
			|||||||
# Development Guide - Introduction
 | 
					# Development Guide - Introduction
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Welcome to the Development Guide for Wazuh-Docker version 4.12.0. This guide is intended for developers, contributors, and advanced users who wish to understand the development aspects of the Wazuh-Docker project, build custom Docker images, or contribute to its development.
 | 
					Welcome to the Development Guide for Wazuh-docker version 4.12.2. This guide is intended for developers, contributors, and advanced users who wish to understand the development aspects of the Wazuh-Docker project, build custom Docker images, or contribute to its development.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Purpose of This Guide
 | 
					## Purpose of This Guide
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -1,6 +1,6 @@
 | 
				
			|||||||
# Development Guide - Setup Environment
 | 
					# Development Guide - Setup Environment
 | 
				
			||||||
 | 
					
 | 
				
			||||||
This section outlines the steps required to set up your local development environment for working with the Wazuh-Docker project (version 4.12.0). A proper setup is crucial for building images, running tests, and contributing effectively.
 | 
					This section outlines the steps required to set up your local development environment for working with the Wazuh-Docker project (version 4.12.2). A proper setup is crucial for building images, running tests, and contributing effectively.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Prerequisites
 | 
					## Prerequisites
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@@ -26,7 +26,7 @@ Before you begin, ensure your system meets the following requirements:
 | 
				
			|||||||
Follow these steps to prepare your development environment:
 | 
					Follow these steps to prepare your development environment:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
1.  **Clone the Repository**:
 | 
					1.  **Clone the Repository**:
 | 
				
			||||||
    Clone the `wazuh-docker` repository from GitHub. It's important to check out the specific branch you intend to work with, in this case, `4.12.0`.
 | 
					    Clone the `wazuh-docker` repository from GitHub. It's important to check out the specific branch you intend to work with, in this case, `4.12.2`.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    ```bash
 | 
					    ```bash
 | 
				
			||||||
    git clone [https://github.com/wazuh/wazuh-docker.git](https://github.com/wazuh/wazuh-docker.git)
 | 
					    git clone [https://github.com/wazuh/wazuh-docker.git](https://github.com/wazuh/wazuh-docker.git)
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -1,6 +1,6 @@
 | 
				
			|||||||
# Reference Manual - Description
 | 
					# Reference Manual - Description
 | 
				
			||||||
 | 
					
 | 
				
			||||||
This section provides a detailed description of Wazuh-docker (version 4.12.0), its components, and its architecture when deployed using Docker containers. Understanding these aspects is key to effectively deploying and managing your Wazuh environment.
 | 
					This section provides a detailed description of Wazuh-docker (version 4.12.2), its components, and its architecture when deployed using Docker containers. Understanding these aspects is key to effectively deploying and managing your Wazuh environment.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## What is Wazuh?
 | 
					## What is Wazuh?
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@@ -18,7 +18,7 @@ Wazuh-docker is a project that provides Docker images and `docker compose` confi
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
## Core Components in Wazuh-Docker
 | 
					## Core Components in Wazuh-Docker
 | 
				
			||||||
 | 
					
 | 
				
			||||||
The Wazuh-Docker project typically provides images for the following core Wazuh components, adapted for version 4.12.0:
 | 
					The Wazuh-Docker project typically provides images for the following core Wazuh components, adapted for version 4.12.2:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
1.  **Wazuh Manager**:
 | 
					1.  **Wazuh Manager**:
 | 
				
			||||||
    -   The central component that collects and analyzes data from deployed Wazuh agents.
 | 
					    -   The central component that collects and analyzes data from deployed Wazuh agents.
 | 
				
			||||||
@@ -28,7 +28,7 @@ The Wazuh-Docker project typically provides images for the following core Wazuh
 | 
				
			|||||||
2.  **Wazuh Indexer**:
 | 
					2.  **Wazuh Indexer**:
 | 
				
			||||||
    -   A highly scalable, full-text search and analytics engine.
 | 
					    -   A highly scalable, full-text search and analytics engine.
 | 
				
			||||||
    -   Based on OpenSearch (or historically Elasticsearch), it stores and indexes alerts and monitoring data generated by the Wazuh manager.
 | 
					    -   Based on OpenSearch (or historically Elasticsearch), it stores and indexes alerts and monitoring data generated by the Wazuh manager.
 | 
				
			||||||
    -   The Wazuh indexer container provides the data persistence layer for Wazuh alerts and events. For version 4.12.0, this is typically an OpenSearch-based component.
 | 
					    -   The Wazuh indexer container provides the data persistence layer for Wazuh alerts and events. For version 4.12.2, this is typically an OpenSearch-based component.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
3.  **Wazuh Dashboard**:
 | 
					3.  **Wazuh Dashboard**:
 | 
				
			||||||
    -   A flexible visualization tool based on OpenSearch Dashboards (or historically Kibana).
 | 
					    -   A flexible visualization tool based on OpenSearch Dashboards (or historically Kibana).
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -1,6 +1,6 @@
 | 
				
			|||||||
# Reference Manual - Introduction
 | 
					# Reference Manual - Introduction
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Welcome to the Reference Manual for Wazuh-Docker, version 4.12.0. This manual provides comprehensive information about deploying, configuring, and managing your Wazuh environment using Docker.
 | 
					Welcome to the Reference Manual for Wazuh-Docker, version 4.12.2. This manual provides comprehensive information about deploying, configuring, and managing your Wazuh environment using Docker.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Purpose of This Manual
 | 
					## Purpose of This Manual
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@@ -44,4 +44,4 @@ This manual is structured to help you find information efficiently:
 | 
				
			|||||||
-   If you need to customize your deployment, refer to the [Configuration](configuration/configuration.md) section.
 | 
					-   If you need to customize your deployment, refer to the [Configuration](configuration/configuration.md) section.
 | 
				
			||||||
-   For specific terms or concepts, consult the [Glossary](glossary.md).
 | 
					-   For specific terms or concepts, consult the [Glossary](glossary.md).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
This manual refers to version 4.12.0 of Wazuh-Docker. Ensure you are using the documentation that corresponds to your deployed version.
 | 
					This manual refers to version 4.12.2 of Wazuh-Docker. Ensure you are using the documentation that corresponds to your deployed version.
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -1,6 +1,6 @@
 | 
				
			|||||||
# Reference Manual - Configuration
 | 
					# Reference Manual - Configuration
 | 
				
			||||||
 | 
					
 | 
				
			||||||
This section details how to configure your Wazuh-Docker deployment (version 4.12.0). Proper configuration is key to tailoring the Wazuh stack to your specific needs, managing data persistence, and integrating with your environment.
 | 
					This section details how to configure your Wazuh-Docker deployment (version 4.12.2). Proper configuration is key to tailoring the Wazuh stack to your specific needs, managing data persistence, and integrating with your environment.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Overview of Configuration Methods
 | 
					## Overview of Configuration Methods
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -1,6 +1,6 @@
 | 
				
			|||||||
# Reference Manual - Deployment
 | 
					# Reference Manual - Deployment
 | 
				
			||||||
 | 
					
 | 
				
			||||||
This section provides detailed instructions for deploying Wazuh-Docker (version 4.12.0) in various configurations. Choose the deployment model that best suits your needs, from simple single-node setups for testing to more robust multi-node configurations for production environments.
 | 
					This section provides detailed instructions for deploying Wazuh-Docker (version 4.12.2) in various configurations. Choose the deployment model that best suits your needs, from simple single-node setups for testing to more robust multi-node configurations for production environments.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Overview of Deployment Options
 | 
					## Overview of Deployment Options
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -1,6 +1,6 @@
 | 
				
			|||||||
# Reference Manual - Getting Started
 | 
					# Reference Manual - Getting Started
 | 
				
			||||||
 | 
					
 | 
				
			||||||
This section guides you through the initial steps to get your Wazuh-docker (version 4.12.0) environment up and running. We will cover the prerequisites and point you to the deployment instructions.
 | 
					This section guides you through the initial steps to get your Wazuh-docker (version 4.12.2) environment up and running. We will cover the prerequisites and point you to the deployment instructions.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Overview
 | 
					## Overview
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@@ -27,11 +27,11 @@ Before diving into the deployment, please ensure you have reviewed:
 | 
				
			|||||||
    Verify that your host system has sufficient RAM, CPU, and disk space. Ensure Docker and Docker Compose are installed and functioning correctly.
 | 
					    Verify that your host system has sufficient RAM, CPU, and disk space. Ensure Docker and Docker Compose are installed and functioning correctly.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
2.  **Obtain Wazuh-docker Configuration**:
 | 
					2.  **Obtain Wazuh-docker Configuration**:
 | 
				
			||||||
    You'll need the Docker Compose files and any associated configuration files from the `wazuh-docker` repository for version 4.12.0.
 | 
					    You'll need the Docker Compose files and any associated configuration files from the `wazuh-docker` repository for version 4.12.2.
 | 
				
			||||||
    ```bash
 | 
					    ```bash
 | 
				
			||||||
    git clone [https://github.com/wazuh/wazuh-docker.git](https://github.com/wazuh/wazuh-docker.git)
 | 
					    git clone [https://github.com/wazuh/wazuh-docker.git](https://github.com/wazuh/wazuh-docker.git)
 | 
				
			||||||
    cd wazuh-docker
 | 
					    cd wazuh-docker
 | 
				
			||||||
    git checkout 4.12.0
 | 
					    git checkout v4.12.2
 | 
				
			||||||
    # Navigate to the specific docker-compose directory, e.g., single-node or multi-node
 | 
					    # Navigate to the specific docker-compose directory, e.g., single-node or multi-node
 | 
				
			||||||
    # cd docker-compose/single-node/ (example path)
 | 
					    # cd docker-compose/single-node/ (example path)
 | 
				
			||||||
    ```
 | 
					    ```
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -1,6 +1,6 @@
 | 
				
			|||||||
# Reference Manual - Requirements
 | 
					# Reference Manual - Requirements
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Before deploying Wazuh-Docker (version 4.12.0), it's essential to ensure your environment meets the necessary hardware and software requirements. Meeting these prerequisites will help ensure a stable and performant Wazuh deployment.
 | 
					Before deploying Wazuh-Docker (version 4.12.2), it's essential to ensure your environment meets the necessary hardware and software requirements. Meeting these prerequisites will help ensure a stable and performant Wazuh deployment.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Host System Requirements
 | 
					## Host System Requirements
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -1,6 +1,6 @@
 | 
				
			|||||||
# Reference Manual - Glossary
 | 
					# Reference Manual - Glossary
 | 
				
			||||||
 | 
					
 | 
				
			||||||
This glossary defines key terms and concepts related to Wazuh, Docker, and their use together in the Wazuh-Docker project (version 4.12.0).
 | 
					This glossary defines key terms and concepts related to Wazuh, Docker, and their use together in the Wazuh-Docker project (version 4.12.2).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
---
 | 
					---
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@@ -22,7 +22,7 @@ This glossary defines key terms and concepts related to Wazuh, Docker, and their
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
**D**
 | 
					**D**
 | 
				
			||||||
 | 
					
 | 
				
			||||||
-   **Dashboard (Wazuh Dashboard / OpenSearch Dashboards / Kibana)**: A web-based visualization tool used to explore, analyze, and visualize data stored in the Wazuh Indexer. It provides dashboards, visualizations, and a query interface for security events and alerts. For Wazuh 4.12.0, this is typically OpenSearch Dashboards.
 | 
					-   **Dashboard (Wazuh Dashboard / OpenSearch Dashboards / Kibana)**: A web-based visualization tool used to explore, analyze, and visualize data stored in the Wazuh Indexer. It provides dashboards, visualizations, and a query interface for security events and alerts. For Wazuh 4.12.2, this is typically OpenSearch Dashboards.
 | 
				
			||||||
-   **Decoder**: A component in the Wazuh Manager that parses and extracts relevant information (fields) from raw log messages or event data.
 | 
					-   **Decoder**: A component in the Wazuh Manager that parses and extracts relevant information (fields) from raw log messages or event data.
 | 
				
			||||||
-   **Docker**: An open platform for developing, shipping, and running applications inside containers.
 | 
					-   **Docker**: An open platform for developing, shipping, and running applications inside containers.
 | 
				
			||||||
-   **Docker Compose**: A tool for defining and running multi-container Docker applications. It uses a YAML file (`docker-compose.yml`) to configure the application's services, networks, and volumes.
 | 
					-   **Docker Compose**: A tool for defining and running multi-container Docker applications. It uses a YAML file (`docker-compose.yml`) to configure the application's services, networks, and volumes.
 | 
				
			||||||
@@ -42,7 +42,7 @@ This glossary defines key terms and concepts related to Wazuh, Docker, and their
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
**I**
 | 
					**I**
 | 
				
			||||||
 | 
					
 | 
				
			||||||
-   **Indexer (Wazuh Indexer / OpenSearch / Elasticsearch)**: The component responsible for storing, indexing, and making searchable the alerts and event data generated by the Wazuh Manager. For Wazuh 4.12.0, this is typically OpenSearch.
 | 
					-   **Indexer (Wazuh Indexer / OpenSearch / Elasticsearch)**: The component responsible for storing, indexing, and making searchable the alerts and event data generated by the Wazuh Manager. For Wazuh 4.12.2, this is typically OpenSearch.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
**L**
 | 
					**L**
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user