config.sh.example

#!/bin/bash

################################################################################
# COMMON CONFIGURATION FILE FOR SERVER SCRIPTS - EXAMPLE TEMPLATE
#
# This file contains shared configuration constants used across multiple
# server management scripts. Copy this file to config.sh and customize
# the values according to your environment.
#
# USAGE:
#   cp config.sh.example config.sh
#   # Edit config.sh with your actual values
#
# IMPORTANT: The actual config.sh file should NOT be committed to version
# control as it contains sensitive information (Slack webhook URLs, etc.)
################################################################################

# =============================================================================
# GLOBAL CONFIGURATION
# =============================================================================

# Automatically update scripts from git repository before execution
# - true (default): scripts will run 'git pull' at startup
# - false: scripts will not auto-update
AUTO_UPDATE_SCRIPTS="true"

# =============================================================================
# CHECK APP VULNERABILITIES CONFIGURATION
# =============================================================================

# Default directory to scan if none is provided
CHECK_APP_VULNERABILITIES_DEFAULT_SEARCH_DIR="/home"

# Server identification
CHECK_APP_VULNERABILITIES_SERVER_NAME="My server name"

# Slack Webhook URL
CHECK_APP_VULNERABILITIES_SLACK_WEBHOOK_URL="https://hooks.slack.com/services/YOUR/WEBHOOK/URL"

# List of Slack usernames to mention (without @)
CHECK_APP_VULNERABILITIES_PING_USERS="user1 user2"

# =============================================================================
# CHECK GIT STATUS CONFIGURATION
# =============================================================================

# Default directory to scan if none is provided
CHECK_GIT_STATUS_DEFAULT_SEARCH_DIR="/home"

# Server identification (references the first definition)
CHECK_GIT_STATUS_SERVER_NAME="${CHECK_APP_VULNERABILITIES_SERVER_NAME}"

# Slack Webhook URL (references the first definition)
CHECK_GIT_STATUS_SLACK_WEBHOOK_URL="${CHECK_APP_VULNERABILITIES_SLACK_WEBHOOK_URL}"

# List of Slack usernames to mention (references the first definition)
CHECK_GIT_STATUS_PING_USERS="${CHECK_APP_VULNERABILITIES_PING_USERS}"

# =============================================================================
# CHECK SERVER UPDATES CONFIGURATION
# =============================================================================

# Server identification (references the first definition)
CHECK_SERVER_UPDATES_SERVER_NAME="${CHECK_APP_VULNERABILITIES_SERVER_NAME}"

# Slack Webhook URL (references the first definition)
CHECK_SERVER_UPDATES_SLACK_WEBHOOK_URL="${CHECK_APP_VULNERABILITIES_SLACK_WEBHOOK_URL}"

# List of Slack usernames to mention (references the first definition)
CHECK_SERVER_UPDATES_PING_USERS="${CHECK_APP_VULNERABILITIES_PING_USERS}"

# Treat situation "no updates but obsolete packages" as an error?
# - false (default): do NOT treat it as an error (will be a warning)
# - true: treat it as an error (alert/failed state)
CHECK_SERVER_UPDATES_TREAT_OBSOLETE_ONLY_AS_ERROR="false"

# =============================================================================
# CHECK RESOURCE USAGE CONFIGURATION
# =============================================================================

# Server identification (references the first definition)
CHECK_RESOURCE_USAGE_SERVER_NAME="${CHECK_APP_VULNERABILITIES_SERVER_NAME}"

# Slack Webhook URL (references the first definition)
CHECK_RESOURCE_USAGE_SLACK_WEBHOOK_URL="${CHECK_APP_VULNERABILITIES_SLACK_WEBHOOK_URL}"

# List of Slack usernames to mention (references the first definition)
CHECK_RESOURCE_USAGE_PING_USERS="${CHECK_APP_VULNERABILITIES_PING_USERS}"

# Disk space thresholds (percentage)
CHECK_RESOURCE_USAGE_DISK_WARNING_THRESHOLD="80"
CHECK_RESOURCE_USAGE_DISK_CRITICAL_THRESHOLD="90"

# Partitions to monitor (space-separated list)
CHECK_RESOURCE_USAGE_PARTITIONS="/ /home"

# Cooldown period between alerts for same partition and severity level (in minutes)
CHECK_RESOURCE_USAGE_ALERT_COOLDOWN_MINUTES="240"

# TODO: Future metrics to be configured
# CHECK_RESOURCE_USAGE_CPU_THRESHOLD=""
# CHECK_RESOURCE_USAGE_MEMORY_THRESHOLD=""
# CHECK_RESOURCE_USAGE_SWAP_THRESHOLD=""
# CHECK_RESOURCE_USAGE_LOAD_AVERAGE_THRESHOLD=""
# CHECK_RESOURCE_USAGE_NETWORK_THRESHOLD=""

# =============================================================================
# WP UPDATE CONFIGURATION
# =============================================================================

# Root directory containing all WordPress installations
WP_UPDATE_WP_ROOT="/var/www"

# Path to WP-CLI executable
WP_UPDATE_WP_CLI="/usr/local/bin/wp"

# Log file directory
WP_UPDATE_LOG_FOLDER="/var/log/wp-update"

# Root backup directory (daily subfolders will be created)
WP_UPDATE_BACKUP_DIR="/var/backups"

# Days to retain backups
WP_UPDATE_BACKUP_RETENTION_DAYS="7"

# Feature Flags
# Perform database and file backups
WP_UPDATE_ENABLE_BACKUPS="false"

# Remove inactive plugins
WP_UPDATE_REMOVE_INACTIVE_PLUGINS="false"

# Remove inactive themes
WP_UPDATE_REMOVE_INACTIVE_THEMES="true"

# =============================================================================
# CHECK WORDPRESS UPDATES CONFIGURATION
# =============================================================================

# Root directory containing all WordPress installations (references WP_UPDATE)
CHECK_WORDPRESS_UPDATES_WP_ROOT="${WP_UPDATE_WP_ROOT}"

# Server identification (references the first definition)
CHECK_WORDPRESS_UPDATES_SERVER_NAME="${CHECK_APP_VULNERABILITIES_SERVER_NAME}"

# Slack Webhook URL (references the first definition)
CHECK_WORDPRESS_UPDATES_SLACK_WEBHOOK_URL="${CHECK_APP_VULNERABILITIES_SLACK_WEBHOOK_URL}"

# List of Slack usernames to mention (references the first definition)
CHECK_WORDPRESS_UPDATES_PING_USERS="${CHECK_APP_VULNERABILITIES_PING_USERS}"

# =============================================================================
# CHECK MALWARE CONFIGURATION
# =============================================================================

# Default directory to scan if none is provided
CHECK_MALWARE_DEFAULT_SEARCH_DIR="${WP_UPDATE_WP_ROOT}"

# Server identification (references the first definition)
CHECK_MALWARE_SERVER_NAME="${CHECK_APP_VULNERABILITIES_SERVER_NAME}"

# Slack Webhook URL (references the first definition)
CHECK_MALWARE_SLACK_WEBHOOK_URL="${CHECK_APP_VULNERABILITIES_SLACK_WEBHOOK_URL}"

# List of Slack usernames to mention (references the first definition)
CHECK_MALWARE_PING_USERS="${CHECK_APP_VULNERABILITIES_PING_USERS}"

# Directories to exclude from scanning (space-separated)
CHECK_MALWARE_EXCLUDE_DIRS="vendor node_modules .git cache tmp temp logs log backup backups .npm .composer dist build __pycache__"

# Maximum file size to scan (files larger than this will be skipped)
CHECK_MALWARE_MAX_FILE_SIZE="10M"

# Scan only recently modified files?
# - false (default): scan all files
# - true: only scan files modified in the last N days
CHECK_MALWARE_SCAN_RECENT_ONLY="false"

# Number of days to consider a file "recent" (used when SCAN_RECENT_ONLY=true)
CHECK_MALWARE_RECENT_DAYS="7"