Skip to content

Commit 7e2b632

Browse files
javimedjavimed
committed
{WiP} Update the installation guide
1 parent fc03b25 commit 7e2b632

9 files changed

+171
-73
lines changed

‎source/images/installation/deploy-new-agent-from-ui.png‎

117 KB
Loading

‎source/images/installation/windows-agent.png‎

1.82 KB
Loading

‎source/installation-guide/wazuh-agent/index.rst‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33
.. meta::
44
:description: Find out in this section more about the Wazuh agent, its capabilities, and the options for installing the agent on different operating systems.
55

6-
.. _installation_agents:
7-
86
Wazuh agent
97
===========
108

‎source/installation-guide/wazuh-agent/wazuh-agent-package-aix.rst‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,21 +20,20 @@ The deployment of a Wazuh agent on an AIX system uses deployment variables that
2020

2121
#. To start the deployment process, download the `AIX installer <https://packages.wazuh.com/|WAZUH_CURRENT_MAJOR_AIX|/aix/wazuh-agent-|WAZUH_CURRENT_AIX|-|WAZUH_REVISION_AIX|.aix.ppc.rpm>`_.
2222

23-
#. To deploy the Wazuh agent to your endpoint, edit the ``WAZUH_MANAGER`` variable so that it contains the Wazuh manager IP address or hostname.
23+
#. Run the command below to deploy the Wazuh agent to your endpoint. Replace the ``WAZUH_MANAGER`` value with your Wazuh manager IP address or hostname:
2424

2525
.. code-block:: console
2626
2727
# WAZUH_MANAGER="10.0.0.2" rpm -ivh wazuh-agent-|WAZUH_CURRENT_AIX|-|WAZUH_REVISION_AIX|.aix.ppc.rpm
2828
2929
For additional deployment options such as agent name, agent group, and registration password, see :doc:`Deployment variables for AIX </user-manual/agent/agent-enrollment/deployment-variables/deployment-variables-aix>` section.
30-
30+
3131
.. note:: Alternatively, if you want to install an agent without registering it, omit the deployment variables. To learn more about the different registration methods, see the :doc:`Wazuh agent enrollment </user-manual/agent/agent-enrollment/index>` section.
3232

33-
#. To complete the installation process, start the Wazuh agent.
33+
#. Start the Wazuh agent to complete the installation process:
3434

35-
.. code-block:: console
35+
.. code-block:: console
3636
3737
# /var/ossec/bin/wazuh-control start
3838
39-
4039
The deployment process is now complete, and the Wazuh agent is successfully running on your AIX endpoint.

‎source/installation-guide/wazuh-agent/wazuh-agent-package-hpux.rst‎

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
.. meta::
44
:description: Learn more about how to successfully install the Wazuh agent on HP-UX systems in this section of our Installation Guide.
55

6-
Installing Wazuh agents on HP-UX endpoints
7-
==========================================
6+
Deploying Wazuh agents on HP-UX endpoints
7+
=========================================
88

99
.. warning::
1010

@@ -23,12 +23,30 @@ The installed agent runs on the endpoint you want to monitor and communicates wi
2323
# groupadd wazuh
2424
# useradd -G wazuh wazuh
2525
26-
#. Uncompress the package in ``/``.
26+
#. Decompress the package in ``/``.
2727

2828
.. code-block:: console
2929
3030
# gzip -d wazuh-agent-|WAZUH_CURRENT_HPUX|-|WAZUH_REVISION_HPUX|-hpux-11v3-ia64.tar.gz
3131
# tar -xvf wazuh-agent-|WAZUH_CURRENT_HPUX|-|WAZUH_REVISION_HPUX|-hpux-11v3-ia64.tar
3232
33+
#. Edit the ``/var/ossec/etc/ossec.conf`` file and replace ``<WAZUH_MANAGER_IP_ADDRESS>`` with the IP address of the Wazuh manager:
3334

34-
The installation process is now complete, and the Wazuh agent is successfully installed on your HP-UX endpoint. The next step is to register and configure the agent to communicate with the Wazuh server. To perform this action, see the :doc:`Linux/Unix agent enrollment via agent configuration </user-manual/agent/agent-enrollment/enrollment-methods/via-agent-configuration/linux-endpoint>` section. To learn more about agent enrollment, visit :doc:`Wazuh agent enrollment </user-manual/agent/agent-enrollment/index>`.
35+
.. code-block:: xml
36+
:emphasize-lines: 3
37+
38+
<client>
39+
<server>
40+
<address><WAZUH_MANAGER_IP_ADDRESS></address>
41+
</server>
42+
</client>
43+
44+
To learn more about this enrollment method, see the :doc:`Linux/Unix agent enrollment via agent configuration </user-manual/agent/agent-enrollment/enrollment-methods/via-agent-configuration/linux-endpoint>` section.
45+
46+
#. Start the Wazuh agent to complete the installation process:
47+
48+
.. code-block:: console
49+
50+
# /var/ossec/bin/wazuh-control start
51+
52+
The installation process is now complete and the Wazuh agent is now successfully running on your HP-UX endpoint.

‎source/installation-guide/wazuh-agent/wazuh-agent-package-linux.rst‎

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,9 @@ Add the Wazuh repository to download the official packages.
4444
Deploy a Wazuh agent
4545
--------------------
4646

47-
#. To deploy the Wazuh agent on your endpoint, select your package manager and edit the ``WAZUH_MANAGER`` variable to contain your Wazuh manager IP address or hostname.
47+
Follow these steps to deploy the Wazuh agent on your Linux endpoint.
48+
49+
#. Select your package manager and run the command below. Replace the ``WAZUH_MANAGER`` value with your Wazuh manager IP address or hostname:
4850

4951
.. tabs::
5052

@@ -72,7 +74,7 @@ Deploy a Wazuh agent
7274
7375
# WAZUH_MANAGER="10.0.0.2" zypper install wazuh-agent|WAZUH_AGENT_ZYPP_PKG_INSTALL|
7476
75-
For additional deployment options such as agent name, agent group, and registration password, see the :doc:`Deployment variables for Linux </user-manual/agent/agent-enrollment/deployment-variables/deployment-variables-linux>` section.
77+
For additional deployment options such as agent name, agent group, and enrollment password, see the :doc:`Deployment variables for Linux </user-manual/agent/agent-enrollment/deployment-variables/deployment-variables-linux>` section.
7678

7779
.. note::
7880

@@ -84,24 +86,25 @@ Deploy a Wazuh agent
8486

8587
The deployment process is now complete, and the Wazuh agent is successfully running on your Linux system.
8688

87-
- **Recommended action** - Disable Wazuh updates
89+
Disable Wazuh updates
90+
---------------------
8891

89-
Compatibility between the Wazuh agent and the Wazuh manager is guaranteed when the Wazuh manager version is later than or equal to that of the Wazuh agent. Therefore, we recommend disabling the Wazuh repository to prevent accidental upgrades. To do so, use the following command:
92+
Compatibility between the Wazuh agent and the Wazuh manager is guaranteed when the Wazuh manager version is later than or equal to that of the Wazuh agent. Therefore, we recommend disabling the Wazuh repository to prevent accidental upgrades. To do so, use the following command:
9093

91-
.. tabs::
94+
.. tabs::
9295

93-
.. group-tab:: APT
96+
.. group-tab:: APT
9497

95-
.. include:: /_templates/installations/wazuh/deb/disabling_repository.rst
98+
.. include:: /_templates/installations/wazuh/deb/disabling_repository.rst
9699

97-
.. group-tab:: Yum
100+
.. group-tab:: Yum
98101

99-
.. include:: /_templates/installations/wazuh/yum/disabling_repository.rst
102+
.. include:: /_templates/installations/wazuh/yum/disabling_repository.rst
100103

101-
.. group-tab:: DNF
104+
.. group-tab:: DNF
102105

103-
.. include:: /_templates/installations/wazuh/dnf/disabling_repository.rst
106+
.. include:: /_templates/installations/wazuh/dnf/disabling_repository.rst
104107

105-
.. group-tab:: ZYpp
108+
.. group-tab:: ZYpp
106109

107-
.. include:: /_templates/installations/wazuh/zypp/disabling_repository.rst
110+
.. include:: /_templates/installations/wazuh/zypp/disabling_repository.rst

‎source/installation-guide/wazuh-agent/wazuh-agent-package-macos.rst‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
.. meta::
44
:description: Learn more about how to successfully install the Wazuh agent on macOS systems in this section of our Installation Guide.
55

6-
Installing Wazuh agents on macOS endpoints
7-
==========================================
6+
Deploying Wazuh agents on macOS endpoints
7+
=========================================
88

99
The Wazuh agent runs on the endpoint you want to monitor and communicates with the Wazuh manager, sending data in near real-time through an encrypted and authenticated channel.
1010

@@ -17,7 +17,6 @@ The Wazuh agent runs on the endpoint you want to monitor and communicates with t
1717
#. To start the installation process, download the Wazuh agent according to your architecture:
1818

1919
- **Intel**: |macOS_intel_64|. Suitable for macOS Sierra and later.
20-
2120
- **Apple silicon**: |macOS_arm64|. Suitable for macOS Big Sur and later.
2221

2322
#. Select the installation method you want to follow: Command line interface (CLI) or graphical user interface (GUI).
@@ -42,20 +41,20 @@ The Wazuh agent runs on the endpoint you want to monitor and communicates with t
4241
4342
# echo "WAZUH_MANAGER='10.0.0.2'" > /tmp/wazuh_envs && sudo installer -pkg wazuh-agent-|WAZUH_CURRENT_OSX|-|WAZUH_REVISION_OSX|.arm64.pkg -target /
4443
45-
For additional deployment options such as agent name, agent group, and registration password, see the :doc:`Deployment variables for macOS </user-manual/agent/agent-enrollment/deployment-variables/deployment-variables-macos>` section.
44+
For additional deployment options such as agent name, agent group, and enrollment password, see the :doc:`Deployment variables for macOS </user-manual/agent/agent-enrollment/deployment-variables/deployment-variables-macos>` section.
45+
46+
.. note::
4647

47-
.. note:: Alternatively, if you want to install an agent without registering it, omit the deployment variables. To learn more about the different registration methods, see the :doc:`Wazuh agent enrollment </user-manual/agent/agent-enrollment/index>` section.
48+
Alternatively, if you want to install an agent without enrolling it, omit the deployment variables. To learn more about the different enrollment methods, see the :doc:`Wazuh agent enrollment </user-manual/agent/agent-enrollment/index>` section.
4849

49-
#. To complete the installation process, start the Wazuh agent.
50+
#. Start the Wazuh agent to complete the installation process:
5051

5152
.. code-block:: console
5253
5354
# launchctl bootstrap system /Library/LaunchDaemons/com.wazuh.agent.plist
5455
55-
5656
The installation process is now complete, and the Wazuh agent is successfully deployed and running on your macOS endpoint.
5757

58-
5958
.. group-tab:: GUI
6059

6160
#. To install the Wazuh agent on your system, run the downloaded file and follow the steps in the installation wizard. If you are not sure how to answer some of the prompts, use the default answers.
@@ -65,7 +64,7 @@ The Wazuh agent runs on the endpoint you want to monitor and communicates with t
6564
:title: macOS agent installer
6665
:alt: macOS agent installer
6766

68-
#. To complete the installation process, start the Wazuh agent.
67+
#. Start the Wazuh agent to complete the installation process:
6968

7069
.. code-block:: console
7170

‎source/installation-guide/wazuh-agent/wazuh-agent-package-solaris.rst‎

Lines changed: 85 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
.. meta::
44
:description: Learn more about how to successfully install the Wazuh agent on Solaris systems in this section of our Installation Guide.
55

6-
Installing Wazuh agents on Solaris endpoints
7-
============================================
6+
Deploying Wazuh agents on Solaris endpoints
7+
===========================================
88

99
.. warning::
1010

@@ -34,6 +34,25 @@ To start the installation process, select your architecture: i386 or SPARC.
3434
3535
# pkgadd -d wazuh-agent_v|WAZUH_CURRENT_SOLARIS10_i386|-sol10-i386.pkg wazuh-agent
3636
37+
#. Edit the ``/var/ossec/etc/ossec.conf`` file and replace ``<WAZUH_MANAGER_IP_ADDRESS>`` with the IP address of the Wazuh manager:
38+
39+
.. code-block:: xml
40+
:emphasize-lines: 3
41+
42+
<client>
43+
<server>
44+
<address><WAZUH_MANAGER_IP_ADDRESS></address>
45+
</server>
46+
</client>
47+
48+
To learn more about this enrollment method, see the :doc:`Linux/Unix agent enrollment via agent configuration </user-manual/agent/agent-enrollment/enrollment-methods/via-agent-configuration/linux-endpoint>` section.
49+
50+
#. Start the Wazuh agent to complete the installation process:
51+
52+
.. code-block:: console
53+
54+
# /var/ossec/bin/wazuh-control start
55+
3756
.. group-tab:: Solaris 11
3857

3958
#. Download the `Wazuh agent for Solaris 11 i386 <https://packages.wazuh.com/4.x/solaris/i386/11/wazuh-agent_v|WAZUH_CURRENT_SOLARIS11_i386|-sol11-i386.p5p>`_.
@@ -44,11 +63,30 @@ To start the installation process, select your architecture: i386 or SPARC.
4463
4564
# pkg install -g wazuh-agent_v|WAZUH_CURRENT_SOLARIS11_i386|-sol11-i386.p5p wazuh-agent
4665
47-
If the Solaris 11 zone where you want to install the package has child zones, create a repository to install the Wazuh agent:
66+
If the Solaris 11 zone where you want to install the package has child zones, create a repository to install the Wazuh agent:
4867

49-
.. code-block:: console
68+
.. code-block:: console
69+
70+
# pkg set-publisher -g wazuh-agent_v|WAZUH_CURRENT_SOLARIS11_i386|-sol11-i386.p5p wazuh && pkg install --accept wazuh-agent && pkg unset-publisher wazuh
71+
72+
#. Edit the ``/var/ossec/etc/ossec.conf`` file and replace ``<WAZUH_MANAGER_IP_ADDRESS>`` with the IP address of the Wazuh manager:
73+
74+
.. code-block:: xml
75+
:emphasize-lines: 3
76+
77+
<client>
78+
<server>
79+
<address><WAZUH_MANAGER_IP_ADDRESS></address>
80+
</server>
81+
</client>
82+
83+
To learn more about this enrollment method, see the :doc:`Linux/Unix agent enrollment via agent configuration </user-manual/agent/agent-enrollment/enrollment-methods/via-agent-configuration/linux-endpoint>` section.
84+
85+
#. Start the Wazuh agent to complete the installation process:
86+
87+
.. code-block:: console
5088
51-
# pkg set-publisher -g wazuh-agent_v|WAZUH_CURRENT_SOLARIS11_i386|-sol11-i386.p5p wazuh && pkg install --accept wazuh-agent && pkg unset-publisher wazuh
89+
# /var/ossec/bin/wazuh-control start
5290
5391
.. group-tab:: SPARC
5492

@@ -66,6 +104,25 @@ To start the installation process, select your architecture: i386 or SPARC.
66104
67105
# pkgadd -d wazuh-agent_v|WAZUH_CURRENT_SOLARIS10_SPARC|-sol10-sparc.pkg wazuh-agent
68106
107+
#. Edit the ``/var/ossec/etc/ossec.conf`` file and replace ``<WAZUH_MANAGER_IP_ADDRESS>`` with the IP address of the Wazuh manager:
108+
109+
.. code-block:: xml
110+
:emphasize-lines: 3
111+
112+
<client>
113+
<server>
114+
<address><WAZUH_MANAGER_IP_ADDRESS></address>
115+
</server>
116+
</client>
117+
118+
To learn more about this enrollment method, see the :doc:`Linux/Unix agent enrollment via agent configuration </user-manual/agent/agent-enrollment/enrollment-methods/via-agent-configuration/linux-endpoint>` section.
119+
120+
#. Start the Wazuh agent to complete the installation process:
121+
122+
.. code-block:: console
123+
124+
# /var/ossec/bin/wazuh-control start
125+
69126
.. group-tab:: Solaris 11
70127

71128
#. Download the `Wazuh agent for Solaris 11 SPARC <https://packages.wazuh.com/4.x/solaris/sparc/11/wazuh-agent_v|WAZUH_CURRENT_SOLARIS11_SPARC|-sol11-sparc.p5p>`_.
@@ -76,10 +133,29 @@ To start the installation process, select your architecture: i386 or SPARC.
76133
77134
# pkg install -g wazuh-agent_v|WAZUH_CURRENT_SOLARIS11_SPARC|-sol11-sparc.p5p wazuh-agent
78135
79-
If the Solaris 11 zone where you want to install the package has child zones, create a repository to install the Wazuh agent:
136+
If the Solaris 11 zone where you want to install the package has child zones, create a repository to install the Wazuh agent:
80137

81-
.. code-block:: console
138+
.. code-block:: console
139+
140+
# pkg set-publisher -g wazuh-agent_v|WAZUH_CURRENT_SOLARIS11_SPARC|-sol11-sparc.p5p wazuh && pkg install --accept wazuh-agent && pkg unset-publisher wazuh
141+
142+
#. Edit the ``/var/ossec/etc/ossec.conf`` file and replace ``<WAZUH_MANAGER_IP_ADDRESS>`` with the IP address of the Wazuh manager:
143+
144+
.. code-block:: xml
145+
:emphasize-lines: 3
146+
147+
<client>
148+
<server>
149+
<address><WAZUH_MANAGER_IP_ADDRESS></address>
150+
</server>
151+
</client>
152+
153+
To learn more about this enrollment method, see the :doc:`Linux/Unix agent enrollment via agent configuration </user-manual/agent/agent-enrollment/enrollment-methods/via-agent-configuration/linux-endpoint>` section.
154+
155+
#. Start the Wazuh agent to complete the installation process:
156+
157+
.. code-block:: console
82158
83-
# pkg set-publisher -g wazuh-agent_v|WAZUH_CURRENT_SOLARIS11_SPARC|-sol11-sparc.p5p wazuh && pkg install --accept wazuh-agent && pkg unset-publisher wazuh
159+
# /var/ossec/bin/wazuh-control start
84160
85-
The installation process is now complete, and the Wazuh agent is successfully installed on your Solaris endpoint. The next step is to register and configure the agent to communicate with the Wazuh server. To perform this action, see the :doc:`Wazuh agent enrollment </user-manual/agent/agent-enrollment/index>` section.
161+
The installation process is now complete and the Wazuh agent is successfully installed on your Solaris endpoint.

0 commit comments

Comments
 (0)