.env.example

# =============================================================================
# CapyVagas - Environment Variables Configuration
# =============================================================================
# This file contains all environment variables used by the application.
# Each variable includes a description, impact, Docker Secrets note where applicable.
#
# Docker Secrets: Sensitive variables (passwords, API keys, secret keys) should
# be stored in the secrets/ directory or mounted at /run/secrets/
# See secrets/README.md for instructions on how to set them up.
# =============================================================================

# =============================================================================
# Django Settings
# =============================================================================
# Basic Django configuration for the web application.

# DJANGO_SECRET_KEY: Secret key for Django sessions and signing
# IMPORTANT: Use Docker Secrets in production!
# Docker Secret name: django_secret_key
# Example: DJANGO_SECRET_KEY=your-secret-key-here
DJANGO_SECRET_KEY=sua_chave_secreta_aqui

# DEBUG: Enable/disable debug mode
# Impact: When True, detailed error pages are shown. Never enable in production!
# Example: DEBUG=False
DEBUG=False

# ALLOWED_HOSTS: Comma-separated list of allowed hostnames
# Impact: Required for security; controls which hosts can access the application
# Production: ALLOWED_HOSTS=chat-universitario.sh.utfpr.edu.br,backend
# Example: ALLOWED_HOSTS=localhost,127.0.0.1,capyvagas.example.com
ALLOWED_HOSTS=localhost,127.0.0.1,capyvagas.example.com

# DOMAIN: Primary domain for the application
# Impact: Used for generating absolute URLs in emails and API responses
# Production: DOMAIN=chat-universitario.sh.utfpr.edu.br
# Example: DOMAIN=capyvagas.example.com
DOMAIN=capyvagas.example.com

# PORTAL_BASE_URL: Full URL for the portal (with protocol and port)
# Used for generating links in notifications and emails
# Example: PORTAL_BASE_URL=http://localhost:8000
PORTAL_BASE_URL=http://localhost:8000


# =============================================================================
# Database Configuration (PostgreSQL)
# =============================================================================
# Configuration for PostgreSQL database connection.
# Sensitive data should use Docker Secrets for enhanced security.

# POSTGRES_DB: Name of the PostgreSQL database
# Example: POSTGRES_DB=capyvagas
POSTGRES_DB=capyvagas

# POSTGRES_USER: PostgreSQL database username
# Example: POSTGRES_USER=capyvagas_user
POSTGRES_USER=capyvagas_user

# POSTGRES_HOST: PostgreSQL server hostname
# Example: POSTGRES_HOST=db
POSTGRES_HOST=db

# POSTGRES_PORT: PostgreSQL server port
# Example: POSTGRES_PORT=5432
POSTGRES_PORT=5432

# POSTGRES_PASSWORD: PostgreSQL database password
# IMPORTANT: Use Docker Secrets in production!
# Docker Secret name: postgres_password (mounted at /run/secrets/postgres_password)
# Example: POSTGRES_PASSWORD=your_password_here
# POSTGRES_PASSWORD is read from /run/secrets/postgres_password


# =============================================================================
# Redis Configuration
# =============================================================================
# Configuration for Redis cache/broker.

# REDIS_URL: Redis connection URL
# Format: redis://[:password@]host[:port][/database]
# Example: REDIS_URL=redis://redis:6379/0
REDIS_URL=redis://redis:6379/0


# =============================================================================
# WAHA Configuration (WhatsApp HTTP API)
# =============================================================================
# Configuration for WAHA (WhatsApp HTTP API) integration.

# WAHA_URL: Base URL of the WAHA server
# Example: WAHA_URL=http://waha:3000
WAHA_URL=http://waha:3000

# WAHA_SESSION_NAME: WAHA session identifier
# Each session represents a different WhatsApp account
# Example: WAHA_SESSION_NAME=default
WAHA_SESSION_NAME=default

# WAHA_TIMEOUT_SECONDS: Timeout for WAHA API requests
# Example: WAHA_TIMEOUT_SECONDS=5
WAHA_TIMEOUT_SECONDS=5

# WAHA_API_KEY: API key for WAHA authentication
# IMPORTANT: Use Docker Secrets in production!
# Docker Secret name: waha_api_key
# Example: WAHA_API_KEY=your_api_key_here
WAHA_API_KEY=sua_api_key_aqui


# =============================================================================
# WAHA Dashboard Configuration
# =============================================================================
# Credentials for WAHA's built-in web dashboard.
# Access at: http://waha:3000/dashboard

# WAHA_DASHBOARD_USERNAME: Username for WAHA dashboard login
# Example: WAHA_DASHBOARD_USERNAME=admin
WAHA_DASHBOARD_USERNAME=seu_usuario_aqui

# WAHA_DASHBOARD_PASSWORD: Password for WAHA dashboard login
# IMPORTANT: Use Docker Secrets in production!
# Docker Secret name: waha_dashboard_password
# Example: WAHA_DASHBOARD_PASSWORD=your_password_here
WAHA_DASHBOARD_PASSWORD=sua_senha_aqui


# =============================================================================
# WAHA Swagger Documentation
# =============================================================================
# Credentials for WAHA's Swagger API documentation.
# Access at: http://waha:3000/apiDocs

# WHATSAPP_SWAGGER_USERNAME: Username for Swagger UI login
# Example: WHATSAPP_SWAGGER_USERNAME=swagger
WHATSAPP_SWAGGER_USERNAME=swagger

# WHATSAPP_SWAGGER_PASSWORD: Password for Swagger UI login
# IMPORTANT: Use Docker Secrets in production!
# Docker Secret name: whatsapp_swagger_password
# Example: WHATSAPP_SWAGGER_PASSWORD=your_password_here
WHATSAPP_SWAGGER_PASSWORD=sua_senha_aqui


# =============================================================================
# Bot Dashboard Configuration
# =============================================================================
# Credentials for the CapyVagas bot control panel (Django admin).

# BOT_DASHBOARD_USERNAME: Username for bot dashboard login
# Example: BOT_DASHBOARD_USERNAME=admin
BOT_DASHBOARD_USERNAME=seu_usuario_aqui

# BOT_DASHBOARD_PASSWORD: Password for bot dashboard login
# IMPORTANT: Use Docker Secrets in production!
# Docker Secret name: bot_dashboard_password
# Example: BOT_DASHBOARD_PASSWORD=your_password_here
BOT_DASHBOARD_PASSWORD=sua_senha_aqui


# =============================================================================
# Django Admin Configuration
# =============================================================================
# Credentials for Django admin panel (accessible at /admin).

# DJANGO_ADMIN_USERNAME: Username for Django admin login
# Example: DJANGO_ADMIN_USERNAME=admin
DJANGO_ADMIN_USERNAME=seu_usuario_aqui

# DJANGO_ADMIN_PASSWORD: Password for Django admin login
# IMPORTANT: Use Docker Secrets in production!
# Docker Secret name: django_admin_password
# Example: DJANGO_ADMIN_PASSWORD=your_password_here
DJANGO_ADMIN_PASSWORD=sua_senha_aqui


# =============================================================================
# Email Configuration
# =============================================================================
# Configuration for email sending.
#
# IMPORTANT: There are TWO email paths:
# 1. EMAIL_PROVIDER: Controls the bot's custom email service (confirmation emails,
#    alerts). This is what sends registration confirmation emails via WhatsApp bot.
#    Options: "ses" (AWS SES via Django backend), "resend" (Resend API), "smtp", "console"
# 2. EMAIL_BACKEND: Controls Django's built-in email (allauth signup, password reset).
#    Automatically set to SES when AWS credentials are present.
#
# In production, EMAIL_PROVIDER must be set to "ses" (or "resend") for emails to be delivered.
# Default is "console" which only writes to container logs — emails are NEVER delivered.

# EMAIL_PROVIDER: Bot email service provider
# Options: "brevo" (Brevo/Sendinblue API), "ses" (AWS SES), "resend" (Resend API), "smtp", "console" (dev only!)
# Production recomendado: "brevo" (300 emails/dia gratis, nao exige dominio verificado)
# Example: EMAIL_PROVIDER=brevo
EMAIL_PROVIDER=brevo

# EMAIL_FALLBACK_PROVIDER: Fallback provider if primary fails
# Options: same as EMAIL_PROVIDER, or empty string for no fallback
# Example: EMAIL_FALLBACK_PROVIDER=console
EMAIL_FALLBACK_PROVIDER=

# RESEND_API_KEY: API key for Resend email service (required if EMAIL_PROVIDER=resend)
# IMPORTANT: Use Docker Secrets in production!
# Docker Secret name: resend_api_key
# Example: RESEND_API_KEY=re_your_api_key_here
# RESEND_API_KEY is read from /run/secrets/resend_api_key

# BREVO_API_KEY: API key for Brevo (ex-Sendinblue) (required if EMAIL_PROVIDER=brevo)
# IMPORTANT: Use Docker Secrets in production! Nao commite a chave.
# Docker Secret name: brevo_api_key (arquivo secrets/brevo_api_key.txt)
# Obter em: https://app.brevo.com/settings/keys/api
# Example: BREVO_API_KEY=xkeysib-xxx-yyy
# BREVO_API_KEY is read from /run/secrets/brevo_api_key

# EMAIL_BACKEND: Django email backend (allauth, password reset)
# Options:
#   - django.core.mail.backends.console.EmailBackend (prints to terminal - dev)
#   - django_ses.SESBackend (production - auto-selected when AWS creds present)
#   - django.core.mail.backends.smtp.EmailBackend (production SMTP)
# In production with AWS credentials, this is automatically set to django_ses.SESBackend.
# Example: EMAIL_BACKEND=django.core.mail.backends.console.EmailBackend
EMAIL_BACKEND=django.core.mail.backends.console.EmailBackend

# EMAIL_HOST: SMTP server hostname (used when EMAIL_PROVIDER=smtp or EMAIL_BACKEND=smtp)
# Example: EMAIL_HOST=email-smtp.us-east-1.amazonaws.com
EMAIL_HOST=email-smtp.us-east-1.amazonaws.com

# EMAIL_PORT: SMTP server port
# Common ports: 587 (TLS), 465 (SSL)
# Example: EMAIL_PORT=587
EMAIL_PORT=587

# EMAIL_USE_TLS: Enable TLS/SSL for SMTP connection
# Example: EMAIL_USE_TLS=True
EMAIL_USE_TLS=True

# EMAIL_HOST_USER: SMTP username
# Example: EMAIL_HOST_USER=your_smtp_username
EMAIL_HOST_USER=seu_smtp_username_aqui

# EMAIL_HOST_PASSWORD: SMTP password
# IMPORTANT: Use Docker Secrets in production!
# Docker Secret name: email_password
# Example: EMAIL_HOST_PASSWORD=your_password_here
# EMAIL_HOST_PASSWORD is read from /run/secrets/email_password

# DEFAULT_FROM_EMAIL: Default sender email address (must be verified in SES/Resend)
# Example: DEFAULT_FROM_EMAIL=noreply@capyvagas.example.com
DEFAULT_FROM_EMAIL=seu_email_aqui@example.com

# ALERT_EMAIL: Recipient for operational alerts (bot offline, backup failures)
# Falls back to DEFAULT_FROM_EMAIL when unset
# Example: ALERT_EMAIL=admin@example.com
ALERT_EMAIL=


# =============================================================================
# AWS Configuration
# =============================================================================
# Configuration for AWS services (SES for email, etc.).

# AWS_ACCESS_KEY_ID: AWS IAM access key
# IMPORTANT: Use Docker Secrets in production!
# Docker Secret name: aws_access_key_id
# Example: AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE
AWS_ACCESS_KEY_ID=sua_access_key_aqui

# AWS_SECRET_ACCESS_KEY: AWS IAM secret key
# IMPORTANT: Use Docker Secrets in production!
# Docker Secret name: aws_secret_access_key
# Example: AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
AWS_SECRET_ACCESS_KEY=sua_secret_key_aqui

# AWS_DEFAULT_REGION: Default AWS region
# Example: AWS_DEFAULT_REGION=us-east-1
AWS_DEFAULT_REGION=us-east-1


# =============================================================================
# Security Notes
# =============================================================================
# - All production passwords, API keys, and secret keys should be stored as Docker Secrets
# - Create secrets files in the secrets/ directory and ensure they're mounted
# - Never commit actual credentials to version control
# - Use different credentials for each environment (dev, staging, prod)
# - Rotate credentials periodically (recommended: every 90 days)