Skip to content

Commit 0d5018d

Browse files
committed
{WiP} Update the installation guide
1 parent 6850e70 commit 0d5018d

File tree

10 files changed

+176
-157
lines changed

10 files changed

+176
-157
lines changed
Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,28 @@
11
.. Copyright (C) 2015, Wazuh, Inc.
22
3-
.. note::
3+
We recommend disabling the Wazuh package repositories after installing all components on this server to prevent accidental upgrades.
44

5-
**Recommended Action**: Disable Wazuh Updates.
5+
Execute the following command only after completing all installations:
66

7-
We recommend disabling the Wazuh package repositories after installing all components on this server to prevent accidental upgrades.
7+
.. tabs::
88

9-
Execute the following command only after completing all installations:
9+
.. group-tab:: APT
1010

11-
.. tabs::
11+
.. code-block:: console
1212
13-
.. group-tab:: APT
13+
# sed -i "s/^deb /#deb /" /etc/apt/sources.list.d/wazuh.list
14+
# apt update
1415
15-
.. code-block:: console
16+
.. group-tab:: YUM
1617

17-
# sed -i "s/^deb /#deb /" /etc/apt/sources.list.d/wazuh.list
18-
# apt update
18+
.. code-block:: console
1919
20-
.. group-tab:: YUM
20+
# sed -i "s/^enabled=1/enabled=0/" /etc/yum.repos.d/wazuh.repo
2121
22-
.. code-block:: console
22+
.. group-tab:: DNF
2323

24-
# sed -i "s/^enabled=1/enabled=0/" /etc/yum.repos.d/wazuh.repo
24+
.. code-block:: console
2525
26-
.. group-tab:: DNF
27-
28-
.. code-block:: console
29-
30-
# sed -i "s/^enabled=1/enabled=0/" /etc/yum.repos.d/wazuh.repo
26+
# sed -i "s/^enabled=1/enabled=0/" /etc/yum.repos.d/wazuh.repo
3127
3228
.. End of include file

source/_templates/installations/wazuh/recommended-operating-systems.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
.. Copyright (C) 2015, Wazuh, Inc.
22
33
- Amazon Linux 2, Amazon Linux 2023
4-
- CentOS 7, 8
54
- CentOS Stream 10
65
- Red Hat Enterprise Linux 7, 8, 9, 10
76
- Ubuntu 16.04, 18.04, 20.04, 22.04, 24.04

source/installation-guide/index.rst

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,30 @@
22
33
.. meta::
44
:description: Visit the Wazuh installation guide and learn more about the deployment process, available installation alternatives, and requirements.
5-
5+
66
.. _installation_guide:
77

88

99
Installation guide
1010
==================
1111

12-
Wazuh is a security platform that provides unified XDR and SIEM protection for endpoints and cloud workloads. The solution is composed of a single universal agent and three central components: the Wazuh server, the Wazuh indexer, and the Wazuh dashboard. For more information, check the :doc:`Getting Started </getting-started/index>` documentation.
12+
Wazuh is a security platform that provides unified XDR and SIEM protection for endpoints and cloud workloads. The solution is composed of the :doc:`Wazuh agent </getting-started/components/wazuh-agent>` and three central components: the :doc:`Wazuh server </getting-started/components/wazuh-server>`, the :doc:`Wazuh indexer </getting-started/components/wazuh-indexer>`, and the :doc:`Wazuh dashboard </getting-started/components/wazuh-dashboard>`. For more information, check the :doc:`Getting Started </getting-started/index>` documentation.
1313

14-
Wazuh is free and open source. Its components abide by the `GNU General Public License, version 2 <https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html>`_, and the `Apache License, Version 2.0 <https://www.apache.org/licenses/LICENSE-2.0>`_ (ALv2).
14+
Wazuh is free and open source. Its components abide by the `GNU General Public License, version 2 <https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html>`_, and the `Apache License, Version 2.0 <https://www.apache.org/licenses/LICENSE-2.0>`_ (ALv2).
1515

16-
In this installation guide, you will learn how to install Wazuh in your infrastructure. We also offer `Wazuh Cloud <https://wazuh.com/cloud/>`_, our software as a service (SaaS) solution. Wazuh cloud is ready to use, with no additional hardware or software required, driving down the cost and complexity. Check the :doc:`Cloud service </cloud-service/index>` documentation for more information and take advantage of the `Cloud trial <https://console.cloud.wazuh.com/sign-up?landing=trial>`_ to explore this service.
16+
In this installation guide, you will learn how to install Wazuh in your infrastructure. We also offer `Wazuh Cloud <https://wazuh.com/cloud/>`_, our software as a service (SaaS) solution. Wazuh Cloud is ready to use, with no additional hardware or software required, reducing the cost and complexity. Check the :doc:`Wazuh Cloud service </cloud-service/index>` documentation for more information and take advantage of the `Wazuh Cloud trial <https://console.cloud.wazuh.com/sign-up?landing=trial>`_ to explore this service.
1717

1818

1919
Installing the Wazuh central components
2020
---------------------------------------
2121

22-
The Wazuh indexer and Wazuh server can be installed on a single host or be distributed in cluster configurations. You can choose between two installation methods for each Wazuh central component. Both options provide instructions to install the central components on a single host or on separate hosts.
22+
You can install the Wazuh indexer, Wazuh server, and Wazuh dashboard on a single host or distribute them in cluster configurations. Each Wazuh central component supports two installation methods and both methods provide instructions to install the central components on a single host or on separate hosts.
2323

2424
You can check our :doc:`Quickstart </quickstart>` documentation to perform an all-in-one installation. This is the fastest way to get the Wazuh central components up and running.
2525

26-
For more deployment flexibility and customization, install the Wazuh central components by starting with the :doc:`Wazuh indexer <wazuh-indexer/index>` deployment. This deployment method allows the all-in-one installation, and the installation of the components on separate servers.
26+
For more deployment flexibility and customization, install the Wazuh central components by starting with the :doc:`Wazuh indexer <wazuh-indexer/index>` deployment. This deployment method supports both an all-in-one installation and installing components on separate hosts.
2727

28-
This is the installation workflow you will follow:
28+
Follow this installation workflow:
2929

3030
.. raw:: html
3131

@@ -47,7 +47,7 @@ This is the installation workflow you will follow:
4747

4848
</a>
4949
</div>
50-
50+
5151
<div class="link-boxes-item future-step">
5252
<a class="link-boxes-link" href="wazuh-server/index.html">
5353
<p class="link-boxes-label">Install the Wazuh server</p>
@@ -60,15 +60,15 @@ This is the installation workflow you will follow:
6060

6161
</a>
6262
</div>
63-
63+
6464
<div class="link-boxes-item future-step">
6565
<a class="link-boxes-link" href="wazuh-dashboard/index.html">
6666
<p class="link-boxes-label">Install the Wazuh dashboard</p>
6767

6868
.. image:: ../images/installation/Dashboard-noBG.png
6969
:align: center
7070
:height: 61px
71-
71+
7272
.. raw:: html
7373

7474
</a>
@@ -80,9 +80,9 @@ This is the installation workflow you will follow:
8080
Installing the Wazuh agent
8181
--------------------------
8282

83-
The Wazuh agent is a single and lightweight monitoring software. It is a multi-platform component that can be deployed to laptops, desktops, servers, cloud instances, containers, or virtual machines. It provides visibility into the endpoint's security by collecting critical system and application records, inventory data, and detecting anomalies.
83+
The Wazuh agent is a single, lightweight monitoring software. It is a multi-platform component that you can deploy to laptops, desktops, servers, cloud instances, containers, or virtual machines. It provides visibility into the monitored endpoint by collecting critical system and application records, inventory data, and detecting potential anomalies.
8484

85-
If the Wazuh central components are already installed in your environment, select your operating system below and follow the installation steps to deploy the agent on the endpoints.
85+
Select your endpoint operating system below and follow the installation steps to deploy the Wazuh agent.
8686

8787
.. warning::
8888

@@ -160,21 +160,23 @@ If the Wazuh central components are already installed in your environment, selec
160160
</div>
161161
</div>
162162

163-
164-
165163
Packages list
166164
-------------
167165

168-
In the :doc:`Packages list </installation-guide/packages-list>` section, you will find all the packages required for the installation of Wazuh.
166+
The :doc:`Packages list <packages-list>` section contains all the packages required for installing Wazuh.
167+
168+
Uninstalling Wazuh
169+
------------------
170+
171+
In the :doc:`Uninstalling Wazuh <uninstalling-wazuh/index>` section, you will find instructions on how to uninstall the Wazuh central components and the Wazuh agent.
169172

170-
Other installation alternatives
171-
-------------------------------
173+
Installation alternatives
174+
-------------------------
172175

173-
Wazuh provides other :doc:`installation alternatives </deployment-options/index>`. These are complementary to the installation methods of this installation guide. You will find instructions on how to deploy Wazuh using ready-to-use machines, containers, and orchestration tools. There is also information on how to install the solution offline, from sources, and with commercial options.
176+
Wazuh provides other :doc:`installation alternatives </deployment-options/index>` as well. These are complementary to the installation methods of this installation guide. You will find instructions on how to deploy Wazuh using ready-to-use machines, containers, and orchestration tools. There is also information on how to install the solution offline, from sources, and with alternative components.
174177

175178

176179
.. toctree::
177-
:hidden:
178180
:maxdepth: 1
179181

180182
wazuh-indexer/index

source/installation-guide/wazuh-dashboard/installation-assistant.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,9 @@ Wazuh dashboard installation
5555

5656
When you access the Wazuh dashboard for the first time, the browser shows a warning message stating that the certificate was not issued by a trusted authority. An exception can be added in the advanced options of the web browser. For increased security, the ``root-ca.pem`` file previously generated can be imported to the certificate manager of the browser instead. Alternatively, a certificate from a trusted authority can be configured.
5757

58+
Disable Wazuh updates
59+
---------------------
60+
5861
.. include:: /_templates/installations/disable-wazuh-updates.rst
5962

6063
Next steps

source/installation-guide/wazuh-dashboard/step-by-step.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,9 @@ Starting the Wazuh dashboard service
124124

125125
When you access the Wazuh dashboard for the first time, the browser shows a warning message stating that the certificate was not issued by a trusted authority. An exception can be added in the advanced options of the web browser. For increased security, the ``root-ca.pem`` file previously generated can be imported to the certificate manager of the browser. Alternatively, a certificate from a trusted authority can be configured.
126126

127+
Disable Wazuh updates
128+
---------------------
129+
127130
.. include:: /_templates/installations/disable-wazuh-updates.rst
128131

129132
Securing your Wazuh installation

source/installation-guide/wazuh-indexer/index.rst

Lines changed: 60 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -7,63 +7,63 @@ Wazuh indexer
77
=============
88

99

10-
The Wazuh indexer is a highly scalable, full-text search and analytics engine. This Wazuh central component indexes and stores alerts generated by the Wazuh server and provides near real-time data search and analytics capabilities. If you want to learn more about the Wazuh components, check the :doc:`Getting started <../../getting-started/components/index>` section.
10+
The Wazuh indexer is a highly scalable, full-text search and analytics engine. It indexes and stores alerts generated by the Wazuh server and provides near real-time data search and analytics capabilities. If you want to learn more about Wazuh components, check the :doc:`Getting started <../../getting-started/components/index>` section.
1111

12-
You can install the Wazuh indexer on a single host. Alternatively, you can install it distributed in multiple nodes, in a cluster configuration. This provides scalability, high availability, and improved performance.
12+
You can install the Wazuh indexer on a single host or distribute it across multiple nodes in a cluster configuration. The cluster configuration provides scalability, high availability, and improved performance.
1313

1414
Check the requirements below and choose an installation method to start installing the Wazuh indexer.
1515

16-
- :doc:`Assisted installation <installation-assistant>`: Install this component by running an assistant that automates the installation and configuration process.
16+
- :doc:`Assisted installation <installation-assistant>`: Install this component by running an assistant that automates the installation and configuration process.
1717

18-
- :doc:`Step-by-step installation <step-by-step>`: Install this component following detailed step-by-step instructions.
18+
- :doc:`Step-by-step installation <step-by-step>`: Install this component by following detailed step-by-step instructions.
1919

2020
.. raw:: html
2121

22-
<div class="link-boxes-group layout-3" data-step="1">
23-
<div class="steps-line">
24-
<div class="steps-number current-step">1</div>
25-
<div class="steps-number future-step">2</div>
26-
<div class="steps-number future-step">3</div>
27-
</div>
28-
<div class="link-boxes-item current-step">
29-
<div class="link-boxes-link" href="#">
30-
<p class="link-boxes-label">Install the Wazuh indexer</p>
22+
<div class="link-boxes-group layout-3" data-step="1">
23+
<div class="steps-line">
24+
<div class="steps-number current-step">1</div>
25+
<div class="steps-number future-step">2</div>
26+
<div class="steps-number future-step">3</div>
27+
</div>
28+
<div class="link-boxes-item current-step">
29+
<div class="link-boxes-link" href="#">
30+
<p class="link-boxes-label">Install the Wazuh indexer</p>
3131

3232
.. image:: ../../images/installation/Indexer-Circle.png
33-
:align: center
34-
:height: 61px
33+
:align: center
34+
:height: 61px
3535

3636
.. raw:: html
3737

38-
</div>
39-
</div>
40-
41-
<div class="link-boxes-item future-step">
42-
<a class="link-boxes-link" href="../wazuh-server/index.html">
43-
<p class="link-boxes-label">Install the Wazuh server</p>
38+
</div>
39+
</div>
40+
41+
<div class="link-boxes-item future-step">
42+
<a class="link-boxes-link" href="../wazuh-server/index.html">
43+
<p class="link-boxes-label">Install the Wazuh server</p>
4444

4545
.. image:: ../../images/installation/Server-noBG.png
46-
:align: center
47-
:height: 61px
46+
:align: center
47+
:height: 61px
4848

4949
.. raw:: html
5050

51-
</a>
52-
</div>
53-
54-
<div class="link-boxes-item future-step">
55-
<a class="link-boxes-link" href="../wazuh-dashboard/index.html">
56-
<p class="link-boxes-label">Install the Wazuh dashboard</p>
51+
</a>
52+
</div>
53+
54+
<div class="link-boxes-item future-step">
55+
<a class="link-boxes-link" href="../wazuh-dashboard/index.html">
56+
<p class="link-boxes-label">Install the Wazuh dashboard</p>
5757

5858
.. image:: ../../images/installation/Dashboard-noBG.png
59-
:align: center
60-
:height: 61px
61-
59+
:align: center
60+
:height: 61px
61+
6262
.. raw:: html
6363

64-
</a>
65-
</div>
66-
</div>
64+
</a>
65+
</div>
66+
</div>
6767

6868
Requirements
6969
------------
@@ -80,41 +80,36 @@ The Wazuh indexer requires a 64-bit Intel, AMD, or ARM Linux processor (x86_64/A
8080
Hardware recommendations
8181
^^^^^^^^^^^^^^^^^^^^^^^^
8282

83-
The Wazuh indexer can be installed as a single-node or as a multi-node cluster.
84-
85-
- Hardware recommendations for each node
86-
87-
+-------------------------+-------------------------+-------------------------------+
88-
| | Minimum | Recommended |
89-
+-------------------------+----------+--------------+--------------+----------------+
90-
| Component | RAM (GB)| CPU (cores) | RAM (GB) | CPU (cores) |
91-
+=========================+==========+==============+==============+================+
92-
| Wazuh indexer | 4 | 2 | 16 | 8 |
93-
+-------------------------+----------+--------------+--------------+----------------+
94-
95-
96-
- Disk space requirements
83+
You can install the Wazuh indexer as a single-node or multi-node cluster.
9784

98-
The amount of data depends on the generated alerts per second (APS). This table details the estimated disk space needed per agent to store 90 days of alerts on a Wazuh indexer server, depending on the type of monitored endpoints.
85+
- Hardware recommendations for each node
9986

100-
+-------------------------------------------------+-----+---------------------------+
101-
| Monitored endpoints | APS || Storage in Wazuh indexer |
102-
| | || (GB/90 days) |
103-
+=================================================+=====+===========================+
104-
| Servers | 0.25| 3.7 |
105-
+-------------------------------------------------+-----+---------------------------+
106-
| Workstations | 0.1 | 1.5 |
107-
+-------------------------------------------------+-----+---------------------------+
108-
| Network devices | 0.5 | 7.4 |
109-
+-------------------------------------------------+-----+---------------------------+
87+
+-------------------------+-------------------------+-------------------------------+
88+
| | Minimum | Recommended |
89+
+-------------------------+----------+--------------+--------------+----------------+
90+
| Component | RAM (GB)| CPU (cores) | RAM (GB) | CPU (cores) |
91+
+=========================+==========+==============+==============+================+
92+
| Wazuh indexer | 4 | 2 | 16 | 8 |
93+
+-------------------------+----------+--------------+--------------+----------------+
11094

111-
For example, for an environment with 80 workstations, 10 servers, and 10 network devices, the storage needed on the Wazuh indexer server for 90 days of alerts is 230 GB.
95+
- Disk space requirements: The amount of disk space required depends on the generated alerts per second (APS). This table details the estimated disk space needed per agent to store 90 days of alerts on a Wazuh indexer server, depending on the type of monitored endpoints.
11296

97+
+-------------------------------------------------+-----+---------------------------+
98+
| Monitored endpoints | APS || Storage in Wazuh indexer |
99+
| | || (GB/90 days) |
100+
+=================================================+=====+===========================+
101+
| Servers | 0.25| 3.7 |
102+
+-------------------------------------------------+-----+---------------------------+
103+
| Workstations | 0.1 | 1.5 |
104+
+-------------------------------------------------+-----+---------------------------+
105+
| Network devices | 0.5 | 7.4 |
106+
+-------------------------------------------------+-----+---------------------------+
113107

108+
For example, for an environment with 80 workstations, 10 servers, and 10 network devices, the storage needed on the Wazuh indexer server for 90 days of alerts is 230 GB.
114109

115110
.. toctree::
116-
:hidden:
117-
:maxdepth: 1
111+
:hidden:
112+
:maxdepth: 1
118113

119-
Assisted installation <installation-assistant>
120-
Step-by-step installation <step-by-step>
114+
Assisted installation <installation-assistant>
115+
Step-by-step installation <step-by-step>

0 commit comments

Comments
 (0)