From e53e51ff4478e4d6fdfed526d2aaa8a7fc79ddfd Mon Sep 17 00:00:00 2001 From: Victor Carlos Erenu Date: Tue, 6 Jan 2026 01:52:35 +0700 Subject: [PATCH 1/4] Add Windows and macOS prerequisites --- docs/ref/getting-started/requirements.md | 35 ++++++++++++++++++++++-- 1 file changed, 32 insertions(+), 3 deletions(-) diff --git a/docs/ref/getting-started/requirements.md b/docs/ref/getting-started/requirements.md index 407cc557..d7b7cb5e 100644 --- a/docs/ref/getting-started/requirements.md +++ b/docs/ref/getting-started/requirements.md @@ -24,10 +24,10 @@ These are general recommendations. Actual needs may vary based on the number of * **Network**: * A stable network connection with sufficient bandwidth, especially if agents are reporting from remote locations. -### Software: +### Software Prerequisites: + +#### Linux: -* **Operating System**: - * A 64-bit Linux distribution is preferred (e.g., Ubuntu, CentOS, RHEL, Debian). * **Docker Engine**: * Version `20.10.0` or newer. * Install Docker by following the official instructions: [Install Docker Engine](https://docs.docker.com/engine/install/). @@ -48,6 +48,35 @@ These are general recommendations. Actual needs may vary based on the number of ``` * This is crucial for the stability of the Wazuh Indexer. +#### Windows: + +* **Docker Desktop** + * Latest version + * Install Docker Desktop by following the official instructions: [Install Docker Desktop](https://docs.docker.com/desktop/setup/install/windows-install/). +* **WSL Linux distribution** + * Install Ubuntu or other compatible Linux distribution (bash in Alpine is not comptible with wazuh-certs-tool.sh): [Install Ubuntu on WSL](https://documentation.ubuntu.com/wsl/stable/howto/install-ubuntu-wsl2/) +* **Git Client**: + * Required for cloning the `wazuh-docker` repository. +* **Web Browser**: + * A modern web browser (e.g., Chrome, Firefox, Edge, Safari) for accessing the Wazuh Dashboard. + +#### macOS: + +* **Docker Desktop** + * Latest version + * Install Docker Desktop by following the official instructions: [Install Docker Desktop](https://docs.docker.com/desktop/setup/install/mac-install/). +* **Bash Shell** +* **GNU versions of apps**: + * [Install GNU sed](https://formulae.brew.sh/formula/gnu-sed). + * [Install GNU awk](https://formulae.brew.sh/formula/gawk). + * [Install GNU grep](https://formulae.brew.sh/formula/grep). +* **OpenSSL**: + * [Install OpenSSL](https://formulae.brew.sh/formula/openssl@3). +* **Git Client**: + * Required for cloning the `wazuh-docker` repository. +* **Web Browser**: + * A modern web browser (e.g., Chrome, Firefox, Edge, Safari) for accessing the Wazuh Dashboard. + ## Network Ports Ensure that the necessary network ports are open and available on the Docker host and any firewalls: From af1e954146f8b8504267947e143a2f4936f9a786 Mon Sep 17 00:00:00 2001 From: Victor Carlos Erenu Date: Tue, 6 Jan 2026 01:58:42 +0700 Subject: [PATCH 2/4] Delete required version --- docs/ref/getting-started/requirements.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/ref/getting-started/requirements.md b/docs/ref/getting-started/requirements.md index d7b7cb5e..1b9ebeb6 100644 --- a/docs/ref/getting-started/requirements.md +++ b/docs/ref/getting-started/requirements.md @@ -51,7 +51,6 @@ These are general recommendations. Actual needs may vary based on the number of #### Windows: * **Docker Desktop** - * Latest version * Install Docker Desktop by following the official instructions: [Install Docker Desktop](https://docs.docker.com/desktop/setup/install/windows-install/). * **WSL Linux distribution** * Install Ubuntu or other compatible Linux distribution (bash in Alpine is not comptible with wazuh-certs-tool.sh): [Install Ubuntu on WSL](https://documentation.ubuntu.com/wsl/stable/howto/install-ubuntu-wsl2/) @@ -63,7 +62,6 @@ These are general recommendations. Actual needs may vary based on the number of #### macOS: * **Docker Desktop** - * Latest version * Install Docker Desktop by following the official instructions: [Install Docker Desktop](https://docs.docker.com/desktop/setup/install/mac-install/). * **Bash Shell** * **GNU versions of apps**: From e2f3c816117b4cf901608575a4aa23e910c7dd27 Mon Sep 17 00:00:00 2001 From: Victor Carlos Erenu Date: Tue, 6 Jan 2026 23:34:52 +0700 Subject: [PATCH 3/4] Add Changelog --- CHANGELOG.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 825717c5..be7f77f6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ All notable changes to this project will be documented in this file. ### Changed +- Change macOS and Windows deployment documentation ([#2150](https://github.com/wazuh/wazuh-docker/issues/2150)) - Modify docker build image process ([#2131](https://github.com/wazuh/wazuh-docker/issues/2131)) - Update documentation for Wazuh Docker image builder and workflow usage ([#2136](https://github.com/wazuh/wazuh-docker/issues/2136)) - Configure deployment with environment variables ([#2081](https://github.com/wazuh/wazuh-docker/pull/2081)) @@ -19,7 +20,7 @@ All notable changes to this project will be documented in this file. ### Fixed - Delete etc/lists references ([#2129](https://github.com/wazuh/wazuh-docker/pull/2129)) +- Delete etc/lists references ([#2129](https://github.com/wazuh/wazuh-docker/pull/2129)) ### Deleted From 88e46d80a3b0ee1acdef8337e0891e03904c6715 Mon Sep 17 00:00:00 2001 From: Victor Carlos Erenu Date: Wed, 7 Jan 2026 00:37:49 +0700 Subject: [PATCH 4/4] Delete multilingual statement --- docs/book.toml | 1 - docs/ref/getting-started/requirements.md | 6 +++--- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/book.toml b/docs/book.toml index d9b94462..10e89b86 100644 --- a/docs/book.toml +++ b/docs/book.toml @@ -2,6 +2,5 @@ title = "Wazuh Docker Documentation" description = "Technical documentation for Wazuh Docker deployment." authors = ["Victor Erenu"] -multilingual = false src = "." language = "en" \ No newline at end of file diff --git a/docs/ref/getting-started/requirements.md b/docs/ref/getting-started/requirements.md index 1b9ebeb6..48cb1c40 100644 --- a/docs/ref/getting-started/requirements.md +++ b/docs/ref/getting-started/requirements.md @@ -34,7 +34,7 @@ These are general recommendations. Actual needs may vary based on the number of * **Git Client**: * Required for cloning the `wazuh-docker` repository. * **Web Browser**: - * A modern web browser (e.g., Chrome, Firefox, Edge, Safari) for accessing the Wazuh Dashboard. + * A modern web browser (e.g., Chrome, Firefox, Edge, Safari) for accessing the Wazuh dashboard. * **`vm.max_map_count` (Linux Hosts for Wazuh Indexer/OpenSearch)**: * The Wazuh Indexer (OpenSearch) requires a higher `vm.max_map_count` setting than the default on most Linux systems. * Set it permanently: @@ -57,7 +57,7 @@ These are general recommendations. Actual needs may vary based on the number of * **Git Client**: * Required for cloning the `wazuh-docker` repository. * **Web Browser**: - * A modern web browser (e.g., Chrome, Firefox, Edge, Safari) for accessing the Wazuh Dashboard. + * A modern web browser (e.g., Chrome, Firefox, Edge, Safari) for accessing the Wazuh dashboard. #### macOS: @@ -73,7 +73,7 @@ These are general recommendations. Actual needs may vary based on the number of * **Git Client**: * Required for cloning the `wazuh-docker` repository. * **Web Browser**: - * A modern web browser (e.g., Chrome, Firefox, Edge, Safari) for accessing the Wazuh Dashboard. + * A modern web browser (e.g., Chrome, Firefox, Edge, Safari) for accessing the Wazuh dashboard. ## Network Ports