diff --git a/apps/api/.env.example b/apps/api/.env.example index 2d8beb7..eecaf18 100644 --- a/apps/api/.env.example +++ b/apps/api/.env.example @@ -8,6 +8,8 @@ # ============================================================================== NODE_ENV=development JWT_SECRET=hBx9Xh8J6KOMAGAsSjvcZJBT5TWyIkFX +# Port the API server listens on (default: 8080) +# PORT=8080 # ============================================================================== # Application URLs @@ -25,6 +27,8 @@ LANDING_URI=http://localhost:4000 # ============================================================================== # API key for authenticating with the Plunk API (obtained from dashboard) PLUNK_API_KEY= +# From address used for platform notification emails (project disabled, billing limits, etc.) +# PLUNK_FROM_ADDRESS= # ============================================================================== # Database & Redis @@ -85,3 +89,46 @@ STRIPE_METER_EVENT_NAME=emails # Meter event name (API key from your Stripe mete # Set to 'false' to disable automatic project suspension (useful for self-hosters who manage manually) # Default: true (automatic project disabling enabled) # AUTO_PROJECT_DISABLE=true + +# ============================================================================== +# Notifications (Optional - system notifications via ntfy) +# ============================================================================== +# ntfy topic URL for internal system notifications (e.g. project disabled, billing limits). +# When unset, ntfy notifications are disabled. +# Examples: +# - Public ntfy.sh: https://ntfy.sh/your-unique-topic-name +# - Self-hosted: https://your-ntfy-server.com/your-topic +# NTFY_URL= + +# ============================================================================== +# Attachments (Optional) +# ============================================================================== +# Limits applied to attachments on transactional emails. +# AWS SES caps total message size at 40 MB; the defaults below leave headroom. +# MAX_ATTACHMENT_SIZE_MB=10 +# MAX_ATTACHMENTS_COUNT=10 + +# ============================================================================== +# User Management (Optional) +# ============================================================================== +# When 'true', the signup endpoint rejects new user registrations. +# Default: false +# DISABLE_SIGNUPS=false +# When 'true', validates emails on signup (disposable domains, plus-addressing, +# domain existence, MX records). +# Default: false +# VERIFY_EMAIL_ON_SIGNUP=false + +# ============================================================================== +# Phishing Detection (Optional - AI-powered phishing scan via OpenRouter) +# ============================================================================== +# When OPENROUTER_API_KEY is set, a random sample of outgoing emails is +# analyzed by an LLM. Projects can be auto-disabled if a single email exceeds +# PHISHING_CONFIDENCE_THRESHOLD, or if PHISHING_CUMULATIVE_THRESHOLD emails are +# flagged within PHISHING_CUMULATIVE_WINDOW_MS. +# OPENROUTER_API_KEY= +# OPENROUTER_MODEL=anthropic/claude-3-haiku +# PHISHING_DETECTION_SAMPLE_RATE=0.1 +# PHISHING_CONFIDENCE_THRESHOLD=95 +# PHISHING_CUMULATIVE_THRESHOLD=3 +# PHISHING_CUMULATIVE_WINDOW_MS=3600000