forked from wazuh/wazuh-docker
Merge pull request #2150 from wazuh/enhancement/2730-windows-macOS-prerequisites
Change macOS and Windows deployment documentation
This commit is contained in:
+2
-1
@@ -9,6 +9,7 @@ All notable changes to this project will be documented in this file.
|
|||||||
|
|
||||||
### Changed
|
### 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))
|
- 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))
|
- 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))
|
- 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
|
### 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
|
### Deleted
|
||||||
|
|
||||||
|
|||||||
@@ -2,6 +2,5 @@
|
|||||||
title = "Wazuh Docker Documentation"
|
title = "Wazuh Docker Documentation"
|
||||||
description = "Technical documentation for Wazuh Docker deployment."
|
description = "Technical documentation for Wazuh Docker deployment."
|
||||||
authors = ["Victor Erenu"]
|
authors = ["Victor Erenu"]
|
||||||
multilingual = false
|
|
||||||
src = "."
|
src = "."
|
||||||
language = "en"
|
language = "en"
|
||||||
@@ -24,17 +24,17 @@ These are general recommendations. Actual needs may vary based on the number of
|
|||||||
* **Network**:
|
* **Network**:
|
||||||
* A stable network connection with sufficient bandwidth, especially if agents are reporting from remote locations.
|
* 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**:
|
* **Docker Engine**:
|
||||||
* Version `20.10.0` or newer.
|
* Version `20.10.0` or newer.
|
||||||
* Install Docker by following the official instructions: [Install Docker Engine](https://docs.docker.com/engine/install/).
|
* Install Docker by following the official instructions: [Install Docker Engine](https://docs.docker.com/engine/install/).
|
||||||
* **Git Client**:
|
* **Git Client**:
|
||||||
* Required for cloning the `wazuh-docker` repository.
|
* Required for cloning the `wazuh-docker` repository.
|
||||||
* **Web Browser**:
|
* **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)**:
|
* **`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.
|
* The Wazuh Indexer (OpenSearch) requires a higher `vm.max_map_count` setting than the default on most Linux systems.
|
||||||
* Set it permanently:
|
* Set it permanently:
|
||||||
@@ -48,6 +48,33 @@ These are general recommendations. Actual needs may vary based on the number of
|
|||||||
```
|
```
|
||||||
* This is crucial for the stability of the Wazuh Indexer.
|
* This is crucial for the stability of the Wazuh Indexer.
|
||||||
|
|
||||||
|
#### Windows:
|
||||||
|
|
||||||
|
* **Docker Desktop**
|
||||||
|
* 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**
|
||||||
|
* 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
|
## Network Ports
|
||||||
|
|
||||||
Ensure that the necessary network ports are open and available on the Docker host and any firewalls:
|
Ensure that the necessary network ports are open and available on the Docker host and any firewalls:
|
||||||
|
|||||||
Reference in New Issue
Block a user