Update README with default values

This commit is contained in:
Manuel Gutierrez
2020-10-23 11:25:45 +02:00
parent 1a19c72393
commit ed805ee1c1

View File

@@ -36,11 +36,11 @@ Default values are included when available.
### Wazuh
```
API_USERNAME="my-custom-login" # Wazuh API username
API_PASSWORD="Str0ngP455w0rd.!*-" # Wazuh API password - Must comply with requirements (8+ length, uppercase, lowercase, specials chars)
API_USERNAME="wazuh" # Wazuh API username
API_PASSWORD="wazuh" # Wazuh API password - Must comply with requirements (8+ length, uppercase, lowercase, specials chars)
ELASTICSEARCH_URL=https://elasticsearch:9200 # Elasticsearch URL
ELASTIC_USERNAME=admin # Elasticsearch Username
ELASTIC_PASSWORD=SecretPassword # Elasticsearch Password
ELASTIC_PASSWORD=admin # Elasticsearch Password
FILEBEAT_SSL_VERIFICATION_MODE=full # Filebeat SSL Verification mode (full or none)
SSL_CERTIFICATE_AUTHORITIES=/etc/ssl/root-ca.pem # Filebeat SSL CA
SSL_CERTIFICATE=/etc/ssl/filebeat.pem # Filebeat SSL Certificate
@@ -49,39 +49,39 @@ SSL_KEY=/etc/ssl/filebeat.key # Filebeat SSL Key
### Kibana
```
PATTERN="" # Default index pattern to use
PATTERN="wazuh-alerts-*" # Default index pattern to use
CHECKS_PATTERN="" # Defines which checks must to be consider by the healthcheck
CHECKS_TEMPLATE="" # step once the Wazuh app starts. Values must to be true or false
CHECKS_API="" #
CHECKS_SETUP="" #
CHECKS_PATTERN=true # Defines which checks must to be consider by the healthcheck
CHECKS_TEMPLATE=true # step once the Wazuh app starts. Values must to be true or false
CHECKS_API=true
CHECKS_SETUP=true
EXTENSIONS_PCI="" # Enable PCI Extension
EXTENSIONS_GDPR="" # Enable GDPR Extension
EXTENSIONS_HIPAA="" # Enable HIPAA Extension
EXTENSIONS_NIST="" # Enable NIST Extension
EXTENSIONS_TSC="" # Enable TSC Extension
EXTENSIONS_AUDIT="" # Enable Audit Extension
EXTENSIONS_OSCAP="" # Enable OpenSCAP Extension
EXTENSIONS_CISCAT="" # Enable CISCAT Extension
EXTENSIONS_AWS="" # Enable AWS Extension
EXTENSIONS_GCP="" # Enable GCP Extension
EXTENSIONS_VIRUSTOTAL="" # Enable Virustotal Extension
EXTENSIONS_OSQUERY="" # Enable OSQuery Extension
EXTENSIONS_DOCKER="" # Enable Docker Extension
EXTENSIONS_PCI=true # Enable PCI Extension
EXTENSIONS_GDPR=true # Enable GDPR Extension
EXTENSIONS_HIPAA=true # Enable HIPAA Extension
EXTENSIONS_NIST=true # Enable NIST Extension
EXTENSIONS_TSC=true # Enable TSC Extension
EXTENSIONS_AUDIT=true # Enable Audit Extension
EXTENSIONS_OSCAP=false # Enable OpenSCAP Extension
EXTENSIONS_CISCAT=false # Enable CISCAT Extension
EXTENSIONS_AWS=false # Enable AWS Extension
EXTENSIONS_GCP=false # Enable GCP Extension
EXTENSIONS_VIRUSTOTAL=false # Enable Virustotal Extension
EXTENSIONS_OSQUERY=false # Enable OSQuery Extension
EXTENSIONS_DOCKER=false # Enable Docker Extension
APP_TIMEOUT="" # Defines maximum timeout to be used on the Wazuh app requests
APP_TIMEOUT=20000 # Defines maximum timeout to be used on the Wazuh app requests
API_SELECTOR="" # Defines if the user is allowed to change the selected API directly from the Wazuh app top menu
IP_SELECTOR="" # Defines if the user is allowed to change the selected index pattern directly from the Wazuh app top menu
IP_IGNORE="" # List of index patterns to be ignored
API_SELECTOR=true Defines if the user is allowed to change the selected API directly from the Wazuh app top menu
IP_SELECTOR=true # Defines if the user is allowed to change the selected index pattern directly from the Wazuh app top menu
IP_IGNORE="[]" # List of index patterns to be ignored
WAZUH_MONITORING_ENABLED="" # Custom settings to enable/disable wazuh-monitoring indices
WAZUH_MONITORING_FREQUENCY="" # Custom setting to set the frequency for wazuh-monitoring indices cron task
WAZUH_MONITORING_SHARDS="" # Configure wazuh-monitoring-* indices shards and replicas
WAZUH_MONITORING_REPLICAS="" #
WAZUH_MONITORING_ENABLED=true # Custom settings to enable/disable wazuh-monitoring indices
WAZUH_MONITORING_FREQUENCY=900 # Custom setting to set the frequency for wazuh-monitoring indices cron task
WAZUH_MONITORING_SHARDS=2 # Configure wazuh-monitoring-* indices shards and replicas
WAZUH_MONITORING_REPLICAS=0 #
ADMIN_PRIVILEGES="" # App privileges
ADMIN_PRIVILEGES=true # App privileges
```
## Directory structure