mirror of
https://github.com/Security-Onion-Solutions/securityonion.git
synced 2025-12-06 17:22:49 +01:00
Clarify enabled settings
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
elastalert:
|
||||
enabled:
|
||||
description: You can enable or disable Elastalert.
|
||||
description: Enables or disables the ElastAlert 2 process. This process is critical for ensuring alerts arrive in SOC, and for outbound notification delivery.
|
||||
helpLink: elastalert.html
|
||||
alerter_parameters:
|
||||
title: Custom Configuration Parameters
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
elastic_fleet_package_registry:
|
||||
enabled:
|
||||
description: You can enable or disable Elastic Fleet Package Registry.
|
||||
description: Enables or disables the Fleet package registry process. This process must remain enabled for proper HIDS functionality.
|
||||
advanced: True
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
elasticfleet:
|
||||
enabled:
|
||||
description: You can enable or disable Elastic Fleet.
|
||||
description: Enables or disables the Elatic Fleet process. This process is critical for ensuring HIDS events are made available in SOC.
|
||||
advanced: True
|
||||
helpLink: elastic-fleet.html
|
||||
enable_manager_output:
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
elasticsearch:
|
||||
enabled:
|
||||
description: You can enable or disable Elasticsearch.
|
||||
description: Enables or disables the Elasticsearch process. This process provides the log event storage system. WARNING: Disabling this process is unsupported.
|
||||
advanced: True
|
||||
helpLink: elasticsearch.html
|
||||
version:
|
||||
description: "This specifies the version of the following containers: so-elastic-fleet-package-registry, so-elastic-agent, so-elastic-fleet, so-kibana, so-logstash and so-elasticsearch. Modifying this value in the Elasticsearch defaults.yaml will result in catastrophic grid failure."
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
idh:
|
||||
enabled:
|
||||
description: You can enable or disable IDH.
|
||||
description: Enables or disables the Intrustion Detection Honeypot (IDH) process.
|
||||
helpLink: idh.html
|
||||
opencanary:
|
||||
config:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
idstools:
|
||||
enabled:
|
||||
description: You can enable or disable IDSTools.
|
||||
description: Enables or disables the IDS tools process, which is used by the Detection system.
|
||||
config:
|
||||
oinkcode:
|
||||
description: Enter your registration code or oinkcode for paid NIDS rulesets.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
influxdb:
|
||||
enabled:
|
||||
description: You can enable or disable InfluxDB.
|
||||
description: Enables the grid metrics collection storage system. Security Onion grid health monitoring requires this process to remain enabled. WARNING: Disabling the process is unsupported, and will cause unexpected results.
|
||||
helpLink: influxdb.html
|
||||
config:
|
||||
assets-path:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
kibana:
|
||||
enabled:
|
||||
description: You can enable or disable Kibana.
|
||||
description: Enables or disables the Kibana front-end interface to Elasticsearch. Due to Kibana being used for loading certain configuration details in Elasticsearch, this process should remain enabled. WARNING: Disabling the process is unsupported, and will cause unexpected results.
|
||||
helpLink: kibana.html
|
||||
config:
|
||||
elasticsearch:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
kratos:
|
||||
enabled:
|
||||
description: You can enable or disable Kratos.
|
||||
description: Enables or disables the Kratos authentication system. WARNING: Disabling this process will cause the grid to malfunction. Re-enabling this setting will require manual effort via SSH.
|
||||
advanced: True
|
||||
helpLink: kratos.html
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
logstash:
|
||||
enabled:
|
||||
description: You can enable or disable Logstash.
|
||||
description: Enables or disables the Logstash log event forwarding process. On most grid installations, when this process is disabled log events are unable to be ingested into the SOC backend.
|
||||
helpLink: logstash.html
|
||||
assigned_pipelines:
|
||||
roles:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
manager:
|
||||
reposync:
|
||||
enabled:
|
||||
description: This is the daily task of syncing the Security Onion OS packages. It is recommended that you leave this enabled.
|
||||
description: This is the daily task of syncing the Security Onion OS packages. It is recommended that this setting remain enabled to ensure important updates are applied to the grid on an automated, scheduled basis.
|
||||
global: True
|
||||
helpLink: soup.html
|
||||
hour:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
nginx:
|
||||
enabled:
|
||||
description: You can enable or disable Nginx.
|
||||
description: Enables or disables the Nginx web server and reverse proxy. WARNING: Disabling this process will prevent access to SOC and other important web interfaces and APIs. Re-enabling the process is a manual effort. Do not change this setting without instruction from Security Onion support.
|
||||
advanced: True
|
||||
helpLink: nginx.html
|
||||
external_suricata:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
patch:
|
||||
os:
|
||||
enabled:
|
||||
description: Enable OS updates.
|
||||
description: Enable OS updates. WARNING: Disabling this setting will prevent important operating system updates from being applied on a scheduled basis.
|
||||
helpLink: soup.html
|
||||
schedule_to_run:
|
||||
description: Currently running schedule for updates.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
pcap:
|
||||
enabled:
|
||||
description: You can enable or disable Stenographer on all sensors or a single sensor.
|
||||
description: Enables or disables the Stenographer packet recording process. This process may already be disabled if Suricata is being used as the packet capture process.
|
||||
helpLink: stenographer.html
|
||||
config:
|
||||
maxdirectoryfiles:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
redis:
|
||||
enabled:
|
||||
description: You can enable or disable Redis.
|
||||
description: Enables the log event in-memory buffering process. Thsi may already be disabled on some installation types. Disabling this process on distributed-capable grids can result in loss of log events.
|
||||
helpLink: redis.html
|
||||
config:
|
||||
bind:
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
registry:
|
||||
enabled:
|
||||
description: You can enable or disable the registry.
|
||||
description: Enables or disables the Docker registry on the manager node. WARNING: If this process is disabled the grid will malfunction and a manual effort may be needed to re-enable the setting.
|
||||
advanced: True
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
sensoroni:
|
||||
enabled:
|
||||
description: Enable or disable Sensoroni.
|
||||
description: Enable or disable the per-node SOC agent process. This process is used for performing node-related jobs and reporting node metrics back to SOC. Disabling this process is unsupported and will result in an improperly functioning grid.
|
||||
advanced: True
|
||||
helpLink: grid.html
|
||||
config:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
soc:
|
||||
enabled:
|
||||
description: You can enable or disable SOC.
|
||||
description: Enables or disables SOC. WARNING: Disabling this setting is unsupported and will cause the grid to malfunction. Re-enabling this setting is a manual effort via SSH.
|
||||
advanced: True
|
||||
telemetryEnabled:
|
||||
title: SOC Telemetry
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
stig:
|
||||
enabled:
|
||||
description: You can enable or disable the application of STIGS using oscap. Note that the actions performed by OSCAP are not automatically reversible. Requires a valid Security Onion license key.
|
||||
description: Enables or disables the application of STIGS using oscap. Note that the actions performed by OSCAP are not automatically reversible. Requires a valid Security Onion license key.
|
||||
forcedType: bool
|
||||
advanced: True
|
||||
run_interval:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
strelka:
|
||||
backend:
|
||||
enabled:
|
||||
description: You can enable or disable Strelka backend.
|
||||
description: Enables or disables the Strelka file analysis process.
|
||||
helpLink: strelka.html
|
||||
config:
|
||||
backend:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
suricata:
|
||||
enabled:
|
||||
description: You can enable or disable Suricata.
|
||||
description: Enables or disables the Suricata process. This process is used for triggering alerts and optionally for packet meta-data collection and network packet recording.
|
||||
helpLink: suricata.html
|
||||
thresholding:
|
||||
sids__yaml:
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
telegraf:
|
||||
enabled:
|
||||
description: You can enable or disable Telegraf.
|
||||
description: Enables the grid metrics collection process. WARNING: Security Onion grid health monitoring requires this process to remain enabled. Disabling it will cause unexpected and unsupported results.
|
||||
advanced: True
|
||||
helpLink: influxdb.html
|
||||
config:
|
||||
interval:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
zeek:
|
||||
enabled:
|
||||
description: You can enable or disable ZEEK on all sensors or a single sensor.
|
||||
description: Controls whether the Zeek (network packet inspection) process runs. Disabling this process could result in missed alerts and other important NIDS-related information. If Suricata was selected as the packet meta-data engine during setup then this will already be disabled.
|
||||
helpLink: zeek.html
|
||||
config:
|
||||
local:
|
||||
|
||||
Reference in New Issue
Block a user