Skip to content

Commit c6a9e10

Browse files
committed
Merge branch '4.12' into merge-4.12-into-4.13.0
2 parents 83120da + 3c2b6af commit c6a9e10

File tree

7 files changed

+105
-50
lines changed

7 files changed

+105
-50
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,10 @@ All notable changes to this project will be documented in this file.
7171
- **Post-release**: Changed Windows commands in the backup guide to PowerShell. ([#8761](https://github.com/wazuh/wazuh-documentation/pull/8761))
7272
- **Post-release**: Updated 4.12.0 command output examples. ([#8779](https://github.com/wazuh/wazuh-documentation/pull/8779)) ([#8780](https://github.com/wazuh/wazuh-documentation/pull/8780))
7373
- **Post-release**: Updated the *Deployment on Docker* documentation. ([#8793](https://github.com/wazuh/wazuh-documentation/pull/8793))
74+
- **Post-release**: Updated the Windows logo in the documentation. ([#8804](https://github.com/wazuh/wazuh-documentation/pull/8804))
75+
- **Post-release**: Updated the offline installation guide. ([#8803](https://github.com/wazuh/wazuh-documentation/pull/8803))
76+
- **Post-release**: Updated the instruction and images in Wazuh server API getting started documentation to reflect the new navigation path (**Server management** > **Dev Tools**). ([#8811](https://github.com/wazuh/wazuh-documentation/pull/8811))
77+
7478

7579
### Fixed
7680

source/deployment-options/offline-installation/index.rst

Lines changed: 30 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
.. meta::
44
:description: Discover the offline step-by-step process to install the Wazuh central components without connection to the Internet.
55

6-
Offline installation
7-
====================
6+
Offline installation guide
7+
==========================
88

9-
You can install Wazuh even when there is no connection to the Internet. Installing the solution offline involves downloading the Wazuh central components later to install them on a system with no Internet connection. The Wazuh server, the Wazuh indexer, and the Wazuh dashboard can be installed and configured on the same host in an all-in-one deployment, or each component can be installed on a separate host as a distributed deployment, depending on your environment's needs. The supported architecture is 64-bit (x86_64/AMD64 or AARCH64/ARM64).
9+
You can install Wazuh even without an Internet connection. Installing the solution offline involves first downloading the Wazuh central components on a system with Internet access, then transferring and installing them on the offline system. Wazuh supports both all-in-one and distributed deployments. The Wazuh server, indexer, and dashboard can run on the same host in an all-in-one setup, or be installed on separate hosts for a distributed deployment. It supports 64-bit architectures, including x86_64/AMD64 and AARCH64/ARM64.
1010

1111
For more information about the hardware requirements and the recommended operating systems, check the :ref:`Requirements <installation_requirements>` section.
1212

@@ -22,56 +22,65 @@ Prerequisites
2222
Download the packages and configuration files
2323
---------------------------------------------
2424

25-
#. Run the following commands from any Linux system with Internet connection. This action executes a script that downloads all required files for the offline installation (on x86_64/AMD64 and AARCH64/ARM64 architectures). Select the package format to download.
25+
From a Linux system with Internet access, run the script below to download all files needed for offline installation. Choose the package format (RPM or DEB) and architecture (x86_64/AMD64 or AARCH64/ARM64).
26+
27+
#. Run the command on any Linux system with Internet access to download and prepare the Wazuh offline installer script
28+
29+
.. code-block:: console
30+
31+
# curl -sO https://packages.wazuh.com/|WAZUH_CURRENT_MINOR|/wazuh-install.sh
32+
33+
# chmod 744 wazuh-install.sh
34+
35+
#. Download packages by architecture and format
2636

2737
.. tabs::
2838

2939
.. group-tab:: RPM
3040

41+
**x86_64 / AMD64**
42+
3143
.. code-block:: console
3244
33-
# curl -sO https://packages.wazuh.com/|WAZUH_CURRENT_MINOR|/wazuh-install.sh
34-
# chmod 744 wazuh-install.sh
3545
# ./wazuh-install.sh -dw rpm -da x86_64
3646
47+
**AARCH64 / ARM64**
48+
3749
.. code-block:: console
3850
39-
# curl -sO https://packages.wazuh.com/|WAZUH_CURRENT_MINOR|/wazuh-install.sh
40-
# chmod 744 wazuh-install.sh
4151
# ./wazuh-install.sh -dw rpm -da aarch64
4252
4353
.. group-tab:: DEB
4454

55+
**x86_64 / AMD64**
56+
4557
.. code-block:: console
4658
47-
# curl -sO https://packages.wazuh.com/|WAZUH_CURRENT_MINOR|/wazuh-install.sh
48-
# chmod 744 wazuh-install.sh
4959
# ./wazuh-install.sh -dw deb -da amd64
5060
61+
**AARCH64 / ARM64**
62+
5163
.. code-block:: console
5264
53-
# curl -sO https://packages.wazuh.com/|WAZUH_CURRENT_MINOR|/wazuh-install.sh
54-
# chmod 744 wazuh-install.sh
5565
# ./wazuh-install.sh -dw deb -da arm64
5666
5767
#. Download the certificates configuration file.
5868

59-
.. code-block:: console
60-
61-
# curl -sO https://packages.wazuh.com/|WAZUH_CURRENT_MINOR|/config.yml
69+
.. code-block:: console
70+
71+
# curl -sO https://packages.wazuh.com/|WAZUH_CURRENT_MINOR|/config.yml
6272
6373
#. Edit ``config.yml`` to prepare the certificates creation.
6474

6575
- If you are performing an all-in-one deployment, replace ``"<indexer-node-ip>"``, ``"<wazuh-manager-ip>"``, and ``"<dashboard-node-ip>"`` with ``127.0.0.1``.
6676

67-
- If you are performing a distributed deployment, replace the node names and IP values with the corresponding names and IP addresses. You need to do this for all the Wazuh server, the Wazuh indexer, and the Wazuh dashboard nodes. Add as many node fields as needed.
77+
- If you are performing a distributed deployment, replace the node names and IP values with the corresponding names and IP addresses. You need to do this for all the Wazuh server, Wazuh indexer, and Wazuh dashboard nodes. Add as many node fields as needed.
6878

79+
#. Run the ``./wazuh-install.sh -g`` command to create the certificates. For a multi-node cluster, these certificates need to be later deployed to all Wazuh instances in your cluster.
6980

70-
#. Run the ``./wazuh-install.sh -g`` to create the certificates. For a multi-node cluster, these certificates need to be later deployed to all Wazuh instances in your cluster.
81+
.. code-block:: console
7182
72-
.. code-block:: console
73-
74-
# ./wazuh-install.sh -g
83+
# ./wazuh-install.sh -g
7584
7685
#. Copy or move the following files to a directory on the host(s) from where the offline installation will be carried out. You can use ``scp`` for this.
7786

@@ -84,6 +93,7 @@ Next steps
8493

8594
Once the Wazuh files are ready and copied to the specified hosts, it is necessary to install the Wazuh components.
8695

96+
Please make sure that a copy of the ``wazuh-install-files.tar`` and ``wazuh-offline.tar.gz`` files, created during the initial configuration step, is placed in your working directory.
8797

8898
.. toctree::
8999
:maxdepth: 1

source/deployment-options/offline-installation/installation-assistant.rst

Lines changed: 70 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,89 @@
1-
Install Wazuh components using the assistant
2-
--------------------------------------------
1+
Install Wazuh components using the assisted method
2+
--------------------------------------------------
33

4-
Install and configure the different Wazuh components on a 64-bit (x86_64/AMD64 or AARCH64/ARM64) architecture with the aid of the Wazuh installation assistant.
4+
Single-node offline installation
5+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6+
7+
Install and configure the single-node server on a 64-bit (x86_64/AMD64 or AARCH64/ARM64) architecture with the aid of the Wazuh assisted installation method.
58

69
.. note:: You need root user privileges to run all the commands described below.
710

811
Please, make sure that a copy of the ``wazuh-install-files.tar`` and ``wazuh-offline.tar.gz`` files, created during the initial configuration step, is placed in your working directory.
912

13+
The following dependencies must be installed on the Wazuh single node.
14+
15+
.. tabs::
16+
17+
.. group-tab:: RPM
18+
19+
- coreutils
20+
- libcap
21+
22+
.. group-tab:: DEB
23+
24+
- debconf
25+
- adduser
26+
- procps
27+
- apt-transport-https
28+
- gnupg
29+
- debhelper (version 9 or later)
30+
- libcap2-bin
31+
32+
#. To perform the offline installation with the ``--offline-installation`` of Wazuh server on a single-node using the assisted method, run:
33+
34+
.. code-block:: console
35+
36+
# bash wazuh-install.sh --offline-installation -a
37+
38+
Once the installation is finished, the output shows the access credentials and a message that confirms that the installation was successful.
39+
40+
.. code-block:: none
41+
:emphasize-lines: 3,4
42+
43+
INFO: --- Summary ---
44+
INFO: You can access the web interface https://<WAZUH_DASHBOARD_IP_ADDRESS>
45+
User: admin
46+
Password: <ADMIN_PASSWORD>
47+
INFO: Installation finished.
48+
49+
#. Access the Wazuh web interface with your admin user credentials. This is the default administrator account for the Wazuh indexer and it allows you to access the Wazuh dashboard.
50+
51+
- **URL**: ``https://<WAZUH_NODE_IP_ADDRESS>``
52+
- **Username**: ``admin``
53+
- **Password**: ``<ADMIN_PASSWORD>``
54+
55+
Multi-node offline installation
56+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
57+
1058
Installing the Wazuh indexer
11-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
59+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
60+
61+
Install and configure the Wazuh indexer nodes on a 64-bit (x86_64/AMD64 or AARCH64/ARM64) architecture.
1262

13-
Install and configure the Wazuh indexer nodes.
63+
The following dependencies must be installed on the Wazuh indexer nodes.
1464

1565
.. tabs::
1666

1767
.. group-tab:: RPM
1868

19-
The following dependencies must be installed on the Wazuh indexer nodes.
20-
2169
- coreutils
2270

2371
.. group-tab:: DEB
2472

25-
The following dependencies must be installed on the Wazuh indexer nodes.
26-
2773
- debconf
2874
- adduser
2975
- procps
3076
- apt-transport-https
3177

32-
#. Run the assistant with the ``--offline-installation`` to perform an offline installation. Use the option ``--wazuh-indexer`` and the node name to install and configure the Wazuh indexer. The node name must be the same one used in ``config.yml`` for the initial configuration, for example, ``node-1``.
78+
#. Run the multi-node assisted method with the ``--offline-installation`` to perform an offline installation. Use the option ``--wazuh-indexer`` and the node name to install and configure the Wazuh indexer. The node name must be the same one used in ``config.yml`` for the initial configuration, for example, ``node-1``.
3379

3480
.. code-block:: console
3581
3682
# bash wazuh-install.sh --offline-installation --wazuh-indexer node-1
3783
38-
Repeat this step for every Wazuh indexer node in your cluster. Then proceed with initializing your single-node or multi-node cluster in the next step.
84+
Repeat this step for every Wazuh indexer node in your cluster. Then proceed with initializing your multi-node cluster in the next step.
3985

40-
#. Run the Wazuh installation assistant with option ``--start-cluster`` on any Wazuh indexer node to load the new certificates information and start the cluster.
86+
#. Run the Wazuh assisted installation option ``--start-cluster`` on any Wazuh indexer node to load the new certificates information and start the cluster.
4187

4288
.. code-block:: console
4389
@@ -46,7 +92,7 @@ Install and configure the Wazuh indexer nodes.
4692
.. note:: You only have to initialize the cluster `once`, there is no need to run this command on every node.
4793

4894
Testing the cluster installation
49-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
95+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5096

5197
#. Run the following command to get the *admin* password:
5298

@@ -80,14 +126,14 @@ Testing the cluster installation
80126
"tagline" : "The OpenSearch Project: https://opensearch.org/"
81127
}
82128
83-
#. Replace ``<WAZUH_INDEXER_IP_ADDRESS>`` and ``<ADMIN_PASSWORD>``, and run the following command to check if the cluster is working correctly:
129+
#. Verify that the cluster is running correctly. Replace ``<WAZUH_INDEXER_IP_ADDRESS>`` and ``<ADMIN_PASSWORD>`` in the following command, then execute it:
84130

85131
.. code-block:: console
86132
87133
# curl -k -u admin:<ADMIN_PASSWORD> https://<WAZUH_INDEXER_IP_ADDRESS>:9200/_cat/nodes?v
88134
89135
Installing the Wazuh server
90-
^^^^^^^^^^^^^^^^^^^^^^^^^^^
136+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
91137

92138
.. tabs::
93139

@@ -101,47 +147,42 @@ Installing the Wazuh server
101147

102148
On systems with *apt* as package manager, the following dependencies must be installed on the Wazuh server nodes.
103149

104-
- gnupg
105150
- apt-transport-https
151+
- gnupg
106152

107-
#. Run the assistant with the ``--offline-installation`` to perform an offline installation. Use the option ``--wazuh-server`` followed by the node name to install the Wazuh server. The node name must be the same one used in ``config.yml`` for the initial configuration, for example, ``wazuh-1``.
153+
#. Run the assisted method with ``--offline-installation`` to perform an offline installation. Use the option ``--wazuh-server`` followed by the node name to install the Wazuh server. The node name must be the same one used in ``config.yml`` for the initial configuration, for example, ``wazuh-1``.
108154

109155
.. code-block:: console
110156
111157
# bash wazuh-install.sh --offline-installation --wazuh-server wazuh-1
112158
113-
Your Wazuh server is now successfully installed.
114-
115-
- If you want a Wazuh server multi-node cluster, repeat this step on every Wazuh server node.
116-
- If you want a Wazuh server single-node cluster, everything is set and you can proceed directly with the next stage.
159+
Your Wazuh server is now successfully installed. Repeat this step on every Wazuh server node.
117160

118161
Installing the Wazuh dashboard
119-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
162+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
163+
164+
The following dependencies must be installed on the Wazuh dashboard node.
120165

121166
.. tabs::
122167

123168
.. group-tab:: RPM
124169

125-
The following dependencies must be installed on the Wazuh dashboard node.
126-
127170
- libcap
128171

129172
.. group-tab:: DEB
130173

131-
The following dependencies must be installed on the Wazuh dashboard node.
132-
133-
- debhelper version 9 or later
174+
- debhelper (version 9 or later)
134175
- tar
135176
- curl
136177
- libcap2-bin
137178

138-
#. Run the assistant with the ``--offline-installation`` to perform an offline installation. Use the option ``--wazuh-dashboard`` and the node name to install and configure the Wazuh dashboard. The node name must be the same one used in ``config.yml`` for the initial configuration, for example, ``dashboard``.
179+
#. Run the assisted method with ``--offline-installation`` to perform an offline installation. Use the option ``--wazuh-dashboard`` and the node name to install and configure the Wazuh dashboard. The node name must be the same one used in ``config.yml`` for the initial configuration, for example, ``dashboard``.
139180

140181
.. code-block:: console
141182
142183
# bash wazuh-install.sh --offline-installation --wazuh-dashboard dashboard
143184
144-
The default Wazuh web user interface port is 443, used by the Wazuh dashboard. You can change this port using the optional parameter ``-p|--port <PORT_NUMBER>``. Some recommended ports are 8443, 8444, 8080, 8888, and 9000.
185+
The default TCP port for the Wazuh web user interface (dashboard) is 443. You can change this port using the optional parameter ``-p|--port <PORT_NUMBER>``. Some recommended ports are 8443, 8444, 8080, 8888, and 9000.
145186

146187
Once the assistant finishes the installation, the output shows the access credentials and a message that confirms that the installation was successful.
147188

-2.17 KB
Loading
-66.6 KB
Loading
-15.3 KB
Loading

source/user-manual/api/getting-started.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ When you install the Wazuh manager, the Wazuh server API is also installed by de
3030
Using the Wazuh server API via the Wazuh dashboard
3131
--------------------------------------------------
3232

33-
You can interact with the Wazuh server API via the Wazuh dashboard. To do this, you need to log into the Wazuh dashboard with a user that has administrator privileges. For example, the default ``admin`` user has administrator privileges. To access the Wazuh server API console on the dashboard, click on the menu icon and navigate to **Tools** > **API Console**.
33+
You can interact with the Wazuh server API via the Wazuh dashboard. To do this, you need to log into the Wazuh dashboard with a user that has administrator privileges. For example, the default ``admin`` user has administrator privileges. To access the Wazuh server API console on the dashboard, click on the menu icon and navigate to **Server management** > **Dev Tools**.
3434

3535
.. thumbnail:: /images/manual/api/access-wazuh-server-api.png
3636
:title: Access the Wazuh server API console on the dashboard

0 commit comments

Comments
 (0)