config.example.yaml

# PulseCheck Configuration File
# This is an example configuration file with all available options.
# Copy this to config.yaml and customize for your environment.

# Database Configuration
database:
  # Path to SQLite database file (relative or absolute)
  path: "./pulsecheck.db"

  # Maximum number of concurrent database connections
  max_connections: 10

  # Enable Write-Ahead Logging (WAL) mode for better concurrency
  # Recommended: true for production environments
  enable_wal: true

# Server Configuration (for pulsecheck-server)
server:
  # Host to bind to (0.0.0.0 for all interfaces)
  host: "0.0.0.0"

  # Port to listen on
  port: 8080

  # HTTP server timeouts
  read_timeout: "30s"
  write_timeout: "30s"
  idle_timeout: "120s"

  # TLS/SSL Configuration
  tls:
    # Enable HTTPS
    enabled: false

    # Path to TLS certificate file
    cert_file: "/path/to/cert.pem"

    # Path to TLS private key file
    key_file: "/path/to/key.pem"

  # CORS Configuration
  cors:
    # Enable CORS support
    enabled: false

    # Allowed origins (["*"] allows all)
    allowed_origins:
      - "*"

    # Allowed HTTP methods
    allowed_methods:
      - "GET"
      - "POST"
      - "PUT"
      - "DELETE"
      - "OPTIONS"

    # Allowed headers
    allowed_headers:
      - "Accept"
      - "Authorization"
      - "Content-Type"

# Worker Pool Configuration
worker_pool:
  # Number of concurrent workers for URL checking
  # Recommended: 10-50 for most use cases
  num_workers: 10

  # Channel buffer size (2x num_workers is a good starting point)
  channel_buffer_size: 20

  # How often to poll for URLs that need checking
  check_interval: "10s"

# Notification Configuration
notifications:
  # Slack Notifications
  slack:
    # Enable Slack notifications
    enabled: false

    # Slack webhook URL (create at https://api.slack.com/messaging/webhooks)
    # Can also be set via environment variable: PULSECHECK_NOTIFICATIONS_SLACK_WEBHOOK_URL
    webhook_url: ""

  # Discord Notifications
  discord:
    # Enable Discord notifications
    enabled: false

    # Discord webhook URL (create in channel settings)
    # Can also be set via environment variable: PULSECHECK_NOTIFICATIONS_DISCORD_WEBHOOK_URL
    webhook_url: ""

  # Email Notifications
  email:
    # Enable email notifications
    enabled: false

    # SMTP server hostname
    smtp_server: "smtp.gmail.com"

    # SMTP server port (587 for TLS, 465 for SSL, 25 for plain)
    port: 587

    # SMTP authentication username
    # Can also be set via environment variable: PULSECHECK_NOTIFICATIONS_EMAIL_USERNAME
    username: ""

    # SMTP authentication password
    # Can also be set via environment variable: PULSECHECK_NOTIFICATIONS_EMAIL_PASSWORD
    password: ""

    # From address for notification emails
    from: "pulsecheck@example.com"

    # List of recipient email addresses
    recipients:
      - "ops-team@example.com"
      - "oncall@example.com"

    # Use TLS encryption (recommended)
    use_tls: true

# Logging Configuration
logging:
  # Log level: debug, info, warn, error
  level: "info"

  # Log format: json, text
  # Recommendation: json for production, text for development
  format: "text"

  # Log output: stdout, stderr, or file path
  output: "stdout"

# Feature Flags
features:
  # Enable SSRF (Server-Side Request Forgery) protection
  # Blocks requests to private IPs, localhost, and cloud metadata endpoints
  # Recommended: true for production
  enable_ssrf_protection: true

  # Default timeout for URL checks (seconds)
  # Individual URLs can override this value
  request_timeout: 30

  # Maximum response body size to read (bytes)
  # Prevents memory exhaustion from large responses
  # Default: 10MB (10485760 bytes)
  max_response_body_size: 10485760

# Environment Variable Overrides
# Any configuration value can be overridden with environment variables.
# Format: PULSECHECK_<SECTION>_<KEY>
# Examples:
#   PULSECHECK_DATABASE_PATH=/data/pulsecheck.db
#   PULSECHECK_SERVER_PORT=9090
#   PULSECHECK_WORKER_POOL_NUM_WORKERS=20
#   PULSECHECK_NOTIFICATIONS_SLACK_WEBHOOK_URL=https://hooks.slack.com/...
#   PULSECHECK_LOGGING_LEVEL=debug
#
# Nested values use underscores:
#   PULSECHECK_SERVER_TLS_ENABLED=true
#   PULSECHECK_NOTIFICATIONS_EMAIL_PASSWORD=secret