buggregator.yaml.example

# Buggregator configuration file.
#
# Place as buggregator.yaml next to the binary, or specify with --config flag.
# All values support environment variable substitution: ${VAR} and ${VAR:default}
#
# Every setting has a sensible default — this file is entirely optional.

# HTTP server
server:
  addr: ${HTTP_ADDR::8000}
  cors_origins:                           # Allowed CORS origins. Default: ["*"] (all origins).
    - "*"                                 # Use specific origins to restrict: ["http://localhost:3000"]

# Database
database:
  driver: sqlite                        # Only SQLite supported for now
  dsn: ${DATABASE_DSN::memory:}         # ":memory:" (default), "data.db", or full path

# Attachment storage (SMTP attachments, HTTP dump files)
storage:
  mode: ${STORAGE_MODE:memory}          # "memory" (default, lost on restart) or "filesystem"
  path: ${STORAGE_PATH:./storage}       # Directory for filesystem mode

# Prometheus metrics
metrics:
  enabled: ${METRICS_ENABLED:false}       # Set to true to expose Prometheus metrics
  addr: ${METRICS_ADDR:}                  # Separate metrics server address (e.g., ":9090")
                                          # Leave empty to serve /metrics on the main HTTP server

# Authentication via OAuth2/OIDC providers.
# Supported providers: auth0, google, github, keycloak, gitlab, oidc (generic OIDC).
# For OIDC-compatible providers (auth0, google, keycloak, gitlab, oidc), endpoints are
# auto-discovered from provider_url via .well-known/openid-configuration.
# For GitHub, endpoints are hardcoded (no OIDC support).
# auth:
#   enabled: false
#   provider: ${AUTH_PROVIDER:oidc}               # Provider type
#   provider_url: ${AUTH_PROVIDER_URL:}            # OIDC issuer URL (e.g., https://xxx.us.auth0.com)
#   client_id: ${AUTH_CLIENT_ID:}                  # OAuth2 client ID
#   client_secret: ${AUTH_CLIENT_SECRET:}          # OAuth2 client secret
#   callback_url: ${AUTH_CALLBACK_URL:}            # Callback URL (e.g., http://localhost:8000/auth/sso/callback)
#   scopes: ${AUTH_SCOPES:openid,email,profile}    # Comma-separated scopes
#   jwt_secret: ${AUTH_JWT_SECRET:}                # Secret for signing internal JWT tokens (required)

# TCP servers
tcp:
  smtp:
    addr: ${SMTP_ADDR::1025}
  monolog:
    addr: ${MONOLOG_ADDR::9913}
  var-dumper:
    addr: ${VAR_DUMPER_ADDR::9912}

# Enable/disable modules. All enabled by default.
# Set to false to disable a module entirely (TCP port won't bind, events ignored).
# Can also be controlled via CLIENT_SUPPORTED_EVENTS env (comma-separated list).
modules:
  sentry: true
  ray: true
  var-dump: true
  inspector: true
  monolog: true
  smtp: true
  sms: true
  http-dump: true
  profiler: true

# Webhooks — send HTTP POST notifications when events are received.
# Each webhook fires for a specific event type, or "*" for all events.
# Payload: { uuid, type, payload, timestamp, project }
# webhooks:
#   - event: "*"                          # Fire on any event type
#     url: https://slack.example.com/webhook
#     headers:
#       Authorization: "Bearer token123"
#     verify_ssl: false                   # Default: false
#     retry: true                         # Retry up to 3 times with exponential backoff (default: true)
#   - event: sentry                       # Fire only on Sentry events
#     url: https://pagerduty.example.com/alert
#   - event: smtp                         # Fire only on SMTP events
#     url: https://my-app.example.com/email-hook

# Pre-defined projects. The "default" project always exists.
# Additional projects can be defined here.
# projects:
#   - key: my-app
#     name: My Application
#   - key: staging
#     name: Staging Environment