Skip to content

Update user manual reference documentation #9434

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
javimed wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Update user manual reference documentation #9434

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
831ba37
{WiP} Update user manual reference documentation
javimed Mar 26, 2026
4987db7
{WiP} Update user manual reference documentation
javimed Mar 27, 2026
587f401
Update user manual reference documentation
javimed Mar 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ All notable changes to this project will be documented in this file.
- Updated the FIM documentation to change the default FIM who-data mode provider to eBPF. ([#8805](https://github.com/wazuh/wazuh-documentation/pull/8805))
- Updated references in steps and links to 5.x. ([#8853](https://github.com/wazuh/wazuh-documentation/pull/8853))
- Updated version numbers in commands in the *Installation from sources* documentation. ([#9397](https://github.com/wazuh/wazuh-documentation/pull/9397))
- Updated the *Reference* guide in the *User manual* documentation. ([#9334](https://github.com/wazuh/wazuh-documentation/pull/9334))

### Removed

Expand Down
3 changes: 3 additions & 0 deletions source/_static/js/redirects.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,15 @@ removedUrls['x.y'] = [
newUrls['5.0'] = [
'/release-notes/release-5-0-0.html',
'/release-notes/index-5x.html',
'/user-manual/reference/certs-tools.html',
'/user-manual/reference/installation-assistant.html',
];

/* Pages no longer available in 5.0 */

removedUrls['5.0'] = [
'/user-manual/capabilities/system-inventory/osquery.html',
'/user-manual/reference/ossec-conf/integration.html',
'/user-manual/reference/ossec-conf/wodle-osquery.html',
'/user-manual/reference/daemons/wazuh-agentlessd.html',
'/user-manual/reference/daemons/wazuh-csyslogd.html',
Expand Down
44 changes: 44 additions & 0 deletions source/user-manual/reference/certs-tools.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
.. Copyright (C) 2015, Wazuh, Inc.

.. meta::
:description: Learn about the certs-tool and its options for generating certificates for Wazuh nodes.

Certs tool
==========

The certs-tool is used by running the ``wazuh-certs-tool.sh`` script along with the ``config.yml`` configuration file. The certs tool generates the necessary certificates for the nodes specified in the configuration file.

Options list
------------

+--------------------------------------------------+-----------------------------------------------------------------------------+
| Option | Description |
+==================================================+=============================================================================+
| ``-a``, ``--admin-certificates`` | Creates the admin certificates, add ``root-ca.pem`` and ``root-ca.key``. |
| ``</path/to/root-ca.pem>`` ``</path/to/root- | |
| ca.key>`` | |
+--------------------------------------------------+-----------------------------------------------------------------------------+
| ``-A``, ``--all`` ``</path/to/root-ca.pem>`` | Creates certificates specified in ``config.yml`` and admin certificates. |
| ``</path/to/root-ca.key>`` | Add a ``root-ca.pem`` and ``root-ca.key`` or leave it empty so a new one |
| | will be created. |
+--------------------------------------------------+-----------------------------------------------------------------------------+
| ``-ca``, ``--root-ca-certificates`` | Creates the root-ca certificates. |
+--------------------------------------------------+-----------------------------------------------------------------------------+
| ``-v``, ``--verbose`` | Enables verbose mode. |
+--------------------------------------------------+-----------------------------------------------------------------------------+
| ``-wd``, ``--wazuh-dashboard-certificates`` | Creates the Wazuh dashboard certificates. Add ``root-ca.pem`` and |
| ``</path/to/root-ca.pem>`` ``</path/to/root- | ``root-ca.key``. |
| ca.key>`` | |
+--------------------------------------------------+-----------------------------------------------------------------------------+
| ``-wi``, ``--wazuh-indexer-certificates`` | Creates the Wazuh indexer certificates. Add ``root-ca.pem`` and |
| ``</path/to/root-ca.pem>`` ``</path/to/root- | ``root-ca.key``. |
| ca.key>`` | |
+--------------------------------------------------+-----------------------------------------------------------------------------+
| ``-wm``, ``--wazuh-manager-certificates`` | Creates the Wazuh manager certificates. Add ``root-ca.pem`` and |
| ``</path/to/root-ca.pem>`` ``</path/to/root- | ``root-ca.key``. |
| ca.key>`` | |
+--------------------------------------------------+-----------------------------------------------------------------------------+
| ``-tmp``, ``--cert_tmp_path`` | Modifies the default tmp directory (``/tmp/wazuh-ceritificates``) to the |
| | specified one. Must be used along with one of these options: ``-a``, |
| | ``-A``, ``-ca``, ``-wi``, ``-wd``, ``-wm`` |
+--------------------------------------------------+-----------------------------------------------------------------------------+
22 changes: 11 additions & 11 deletions source/user-manual/reference/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

.. meta::
:description: Check out this section to see a complete reference of all the configurations and settings that can be customized on Wazuh, for both managers and agents.

.. _reference_files:

Reference
=========
Expand All @@ -13,13 +11,15 @@ This part of the user manual will cover the configuration files used by Wazuh an

.. topic:: Contents

.. toctree::
:maxdepth: 1
.. toctree::
:maxdepth: 1

ossec-conf/index
centralized-configuration.rst
internal-options
daemons/index
tools/index
unattended-installation
statistics-files/index
ossec-conf/index
centralized-configuration.rst
internal-options
daemons/index
tools/index
certs-tools
installation-assistant
unattended-installation
statistics-files/index
120 changes: 120 additions & 0 deletions source/user-manual/reference/installation-assistant.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
.. Copyright (C) 2015, Wazuh, Inc.

.. meta::
:description: Learn about the Wazuh Installation Assistant and its options for deploying Wazuh components.

Installation Assistant
======================

The Wazuh Installation Assistant is a tool designed to simplify the deployment of Wazuh. It guides users through the process of installing Wazuh components. The Installation Assistant is used by running the ``wazuh-install.sh`` script.

Options list
------------

+--------------------------------------------------+-----------------------------------------------------------------------------+
| Option | Description |
+==================================================+=============================================================================+
| ``-a``, ``--all-in-one`` | Install and configure Wazuh manager, Wazuh indexer, Wazuh dashboard. |
+--------------------------------------------------+-----------------------------------------------------------------------------+
| ``-d [pre-release\|local]``, | Use development repositories. By default it uses the pre-release package |
| ``--development`` | repository. If local is specified, it will use a local |
| | ``artifact_urls.yml`` file located in the same path as the |
| | ``wazuh-install.sh``. |
+--------------------------------------------------+-----------------------------------------------------------------------------+
| ``-dw``, ``--download-wazuh <deb\|rpm>`` | Download all the packages necessary for offline installation. Type of |
| | packages to download for offline installation (rpm, deb) |
+--------------------------------------------------+-----------------------------------------------------------------------------+
| ``-da``, ``--download-arch | Define the architecture of the packages to download for offline |
| <amd64\|arm64\|x86_64\|aarch64>`` | installation. |
+--------------------------------------------------+-----------------------------------------------------------------------------+
| ``-g``, ``--generate-config-files`` | Generate ``wazuh-install-files.tar`` file containing the files that will be |
| | needed for installation from ``config.yml``. In distributed deployments you |
| | will need to copy this file to all hosts. |
+--------------------------------------------------+-----------------------------------------------------------------------------+
| ``-h``, ``--help`` | Display this help and exit. |
+--------------------------------------------------+-----------------------------------------------------------------------------+
| ``-i``, ``--ignore-check`` | Ignore the check for minimum hardware requirements. |
+--------------------------------------------------+-----------------------------------------------------------------------------+
| ``-id``, ``--install-dependencies`` | Installs automatically the necessary dependencies for the installation. |
+--------------------------------------------------+-----------------------------------------------------------------------------+
| ``-o``, ``--overwrite`` | Overwrites previously installed components. This will erase all the |
| | existing configuration and data. |
+--------------------------------------------------+-----------------------------------------------------------------------------+
| ``-of``, ``--offline-installation`` | Perform an offline installation. This option must be used with ``-a``, |
| | ``-wm``, ``-s``, ``-wi``, or ``-wd``. |
+--------------------------------------------------+-----------------------------------------------------------------------------+
| ``-s``, ``--start-cluster`` | Initialize Wazuh indexer cluster security settings. |
+--------------------------------------------------+-----------------------------------------------------------------------------+
| ``-u``, ``--uninstall`` | Uninstalls all Wazuh components. This will erase all the existing |
| | configuration and data. |
+--------------------------------------------------+-----------------------------------------------------------------------------+
| ``-v``, ``--verbose`` | Shows the complete installation output. |
+--------------------------------------------------+-----------------------------------------------------------------------------+
| ``-V``, ``--version`` | Shows the version of the script and Wazuh packages. |
+--------------------------------------------------+-----------------------------------------------------------------------------+
| ``-wd``, ``--wazuh-dashboard <dashboard-node- | Install and configure Wazuh dashboard, used for distributed deployments. |
| name>`` | |
+--------------------------------------------------+-----------------------------------------------------------------------------+
| ``-wi``, ``--wazuh-indexer <indexer-node- | Install and configure Wazuh indexer, used for distributed deployments. |
| name>`` | |
+--------------------------------------------------+-----------------------------------------------------------------------------+
| ``-wm``, ``--wazuh-manager <manager-node- | Install and configure Wazuh manager, used for distributed deployments. |
| name>`` | |
+--------------------------------------------------+-----------------------------------------------------------------------------+

Install Wazuh using development packages
----------------------------------------

The official Wazuh packages are downloaded by default when you install Wazuh with the installation assistant. However, if you are developing or testing new features or want to try the pre-release version instead of the official ones, you can do so by specifying the ``-d [pre-release\|local]``, ``--development`` option to the installation command.

Use pre-release packages
^^^^^^^^^^^^^^^^^^^^^^^^

If you want to use Wazuh pre-release packages instead of the official ones, simply add the ``-d pre-release``, ``--development pre-release`` option to the installation command. For example, to perform an all-in-one installation using pre-release packages, the command would be:

.. code-block:: console

# sudo bash wazuh-install.sh --all-in-one --development pre-release

Or the short form:

.. code-block:: console

# sudo bash wazuh-install.sh -a -d pre-release

Use development packages
^^^^^^^^^^^^^^^^^^^^^^^^

To use packages that are in development, it is necessary to have an ``artifact_urls.yml`` file located in the same path as the ``wazuh-install.sh`` script. This file must contain the URLs of the development packages that will be used in the installation.

It must have the following format:

.. code-block:: yaml

wazuh_manager_amd64_deb: "http://example.com/wazuh-manager-amd64.deb"
wazuh_manager_arm64_deb: "http://example.com/wazuh-manager-arm"
wazuh_manager_amd64_rpm: "http://example.com/wazuh-manager-amd64.rpm"
wazuh_manager_arm64_rpm: "http://example.com/wazuh-manager-arm.rpm"
wazuh_indexer_amd64_deb: "http://example.com/wazuh-indexer-amd64.deb"
wazuh_indexer_arm64_deb: "http://example.com/wazuh-indexer-arm"
wazuh_indexer_amd64_rpm: "http://example.com/wazuh-indexer-amd64.rpm"
wazuh_indexer_arm64_rpm: "http://example.com/wazuh-indexer-arm.rpm"
wazuh_dashboard_amd64_deb: "http://example.com/wazuh-dashboard-amd64.deb"
wazuh_dashboard_arm64_deb: "http://example.com/wazuh-dashboard-arm"
wazuh_dashboard_amd64_rpm: "http://example.com/wazuh-dashboard-amd64.rpm"
wazuh_dashboard_arm64_rpm: "http://example.com/wazuh-dashboard-arm.rpm"
...

Then, to use these development packages in the installation, simply add the ``-d local``, ``--development local`` option to the installation command. For example, to perform an all-in-one installation using development packages, the command would be:

.. code-block:: console

# sudo bash wazuh-install.sh --all-in-one --development local

Or the short form:

.. code-block:: console

# sudo bash wazuh-install.sh -a -d local

This command will automatically detect the ``artifact_urls.yml`` file in the same path as the ``wazuh-install.sh`` script and will use the URLs specified in it to download the necessary packages for the installation.
3 changes: 0 additions & 3 deletions source/user-manual/reference/ossec-conf/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,6 @@ Wazuh can be installed in two ways: as a manager by using the "server/manager" i
+---------------------------------------------------------------------+------------------------+
| :doc:`indexer <indexer>` | manager |
+---------------------------------------------------------------------+------------------------+
| :doc:`integration <integration>` | manager |
+---------------------------------------------------------------------+------------------------+
| :doc:`labels <labels>` | manager, agent |
+---------------------------------------------------------------------+------------------------+
| :doc:`localfile <localfile>` | manager, agent |
Expand Down Expand Up @@ -137,7 +135,6 @@ All of the above sections must be located within the top-level ``<ossec_config>`
global
github-module
indexer
integration
labels
localfile
logging
Expand Down
Loading
Loading