Skip to content
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

Add new <global> option <forward_to> to configuration reference #6974

Merged
merged 3 commits into from
Jan 22, 2024
Merged

Add new <global> option <forward_to> to configuration reference #6974

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
59aca85
Add forward_to ossec.conf reference
Jan 18, 2024
52ba16c
Fix limits sections format
Jan 18, 2024
9b9377d
Apply requested changes
Jan 22, 2024
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
35 changes: 31 additions & 4 deletions source/user-manual/reference/ossec-conf/global.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ Options
- `agents_disconnection_alert_time`_
- `limits`_
- `update_check`_
- `forward_to`_

alerts_log
^^^^^^^^^^
Expand Down Expand Up @@ -479,8 +480,10 @@ Example:

<agents_disconnection_alert_time>1h</agents_disconnection_alert_time>

.. _reference_limits:

limits
------
^^^^^^

This block configures the limits section.

Expand All @@ -493,7 +496,7 @@ This block configures the limits section.
+----------------------------+

limits\\eps
^^^^^^^^^^^
"""""""""""

This block configures the events per second limitation functionality.

Expand All @@ -520,7 +523,7 @@ Events per second limits example block:
</limits>

limits\\eps\\maximum
^^^^^^^^^^^^^^^^^^^^
""""""""""""""""""""

Maximum number of events per second allowed to be processed by decoders.

Expand All @@ -531,7 +534,7 @@ Maximum number of events per second allowed to be processed by decoders.
+--------------------+-----------------------------------------------------------------+

limits\\eps\\timeframe
^^^^^^^^^^^^^^^^^^^^^^
""""""""""""""""""""""

A positive number expressed in seconds that indicates the time period where the events per second processed are increased and restored.

Expand All @@ -554,6 +557,30 @@ This setting toggles whether to query the external Wazuh Cyber Threat Intelligen
| **Allowed values** | yes, no |
+--------------------+---------+

.. _reference_forward_to:

forward_to
^^^^^^^^^^

Specifies the :ref:`name of the socket <reference_ossec_socket_name>` where the output will be redirected. The socket must be defined previously.

+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| **Default value** | None |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| **Allowed values** | Any defined socket under ``/var/ossec`` |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+

Example:
mateocervilla marked this conversation as resolved.
Show resolved Hide resolved

.. code-block:: xml

<socket>
<name>custom_socket</name>
<location>/var/ossec/custom.sock</location>
<mode>tcp</mode>
</socket>

<forward_to>custom_socket</forward_to>

Configuration example
---------------------
Expand Down
1 change: 1 addition & 0 deletions source/user-manual/reference/ossec-conf/socket.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Options
- `mode`_
- `prefix`_

.. _reference_ossec_socket_name:

name
^^^^^^^^^^
Expand Down
Loading