.env.example

# Environment configuration for the FastAPI backend template.
#
# Copy to `.env` and fill in the REQUIRED block below:
#     cp .env.example .env
#
# Every other value is shown commented-out with its built-in default — uncomment
# only what you need to override. Generated from app/core/settings.py and
# app/user/config.py; regenerate if you add settings fields.


# ==========================================================================
# REQUIRED — the application will not start without these
# ==========================================================================

# Generate each secret with:  openssl rand -hex 32
# Both must be at least 32 characters (enforced by a validator in settings.py).

# PostgreSQL username
POSTGRES_USER=

# PostgreSQL password
POSTGRES_PASSWORD=

# PostgreSQL database name
POSTGRES_DB=

# Secret key for signing
SECRET_KEY=

# JWT secret key
JWT_SECRET_KEY=


# ==========================================================================
# Core application settings  (app/core/settings.py)
# ==========================================================================

# ---------- Application Settings ----------
# Application name
# APP_NAME=MyApp
# Application version
# APP_VERSION=0.1.0
# Current environment
# ENVIRONMENT=development
# Debug mode
# DEBUG=false

# ---------- API Settings ----------
# API v1 prefix
# API_V1_PREFIX=/api/v1
# API port
# API_PORT=8000
# API host
# HOST=0.0.0.0

# ---------- Database Settings ----------
# PostgreSQL host
# POSTGRES_HOST=localhost
# PostgreSQL port
# POSTGRES_PORT=5432
# Connection pool size
# DB_POOL_SIZE=5
# Max overflow connections
# DB_MAX_OVERFLOW=10
# Pool timeout in seconds
# DB_POOL_TIMEOUT=30
# Echo SQL statements
# DB_ECHO=false

# ---------- Security Settings ----------
# JWT algorithm
# JWT_ALGORITHM=HS256
# JWT_ACCESS_TOKEN_EXPIRE_MINUTES=120
# JWT_REFRESH_TOKEN_EXPIRE_DAYS=7

# ---------- CORS Settings ----------
# Comma-separated list of allowed origins
# CORS_ORIGINS=http://localhost:3000,http://localhost:8000
# Allow credentials in CORS requests
# CORS_ALLOW_CREDENTIALS=true
# Allowed HTTP methods for CORS
# CORS_ALLOW_METHODS=
# Allowed headers for CORS
# CORS_ALLOW_HEADERS=
# Regex pattern for CORS origin matching
# CORS_ORIGIN_REGEX=

# ---------- Security Settings (Middleware) ----------
# Trusted hosts for production (use specific domains in production)
# TRUSTED_HOSTS=

# ---------- Compression Settings ----------
# Enable GZip compression for responses
# ENABLE_GZIP=true
# Minimum response size in bytes to trigger GZip compression
# GZIP_MINIMUM_SIZE=1000

# ---------- Redis Settings ----------
# Redis host
# REDIS_HOST=localhost
# Redis port
# REDIS_PORT=6379
# Redis database
# REDIS_DB=0
# Redis password
# REDIS_PASSWORD=
# Max Redis connection pool size
# REDIS_MAX_CONNECTIONS=10
# Enable Redis caching (set False to bypass cache entirely)
# CACHE_ENABLED=true

# ---------- Logging Settings ----------
# Logging level
# LOG_LEVEL=INFO
# Enable logging to files
# ENABLE_FILE_LOGGING=true
# Maximum size of log file in bytes before rotation
# LOG_FILE_MAX_SIZE=10485760
# Number of backup log files to keep
# LOG_FILE_BACKUP_COUNT=5

# ---------- Object Storage Settings ----------
# DigitalOcean Spaces Bucket Name
# DO_SPACES_BUCKET_NAME=
# DigitalOcean Spaces Region
# DO_SPACES_REGION=blr1
# DigitalOcean Spaces Endpoint URL
# DO_SPACES_ENDPOINT_URL=
# DigitalOcean Spaces Access Key ID
# DO_SPACES_ACCESS_KEY_ID=
# DigitalOcean Spaces Secret Access Key
# DO_SPACES_SECRET_ACCESS_KEY=
# Public domain for assets (CDN)
# S3_PUBLIC_DOMAIN=

# ---------- File Upload Settings ----------
# Maximum file upload size in MB
# UPLOAD_MAX_SIZE_MB=10
# Allowed file MIME types
# ALLOWED_DOCUMENT_TYPES=
# Max image width
# MAX_IMAGE_WIDTH=4096
# Max image height
# MAX_IMAGE_HEIGHT=4096
# Presigned URL expiry time in hours (max 7 days)
# DOCUMENT_URL_EXPIRY_HOURS=1

# ---------- Celery Settings ----------
# Track when tasks are started
# CELERY_TASK_TRACK_STARTED=true
# Hard time limit for tasks in seconds
# CELERY_TASK_TIME_LIMIT=300
# Soft time limit for tasks in seconds
# CELERY_TASK_SOFT_TIME_LIMIT=240
# Acknowledge tasks after execution (not on receive)
# CELERY_TASK_ACKS_LATE=true
# Reject tasks if worker is lost
# CELERY_TASK_REJECT_ON_WORKER_LOST=true
# Task compression algorithm (gzip, bzip2, or empty)
# CELERY_TASK_COMPRESSION=
# Worker pool type (prefork, solo, threads)
# CELERY_WORKER_POOL=prefork
# Number of tasks to prefetch per worker
# CELERY_WORKER_PREFETCH_MULTIPLIER=4
# Max tasks before worker process restart
# CELERY_WORKER_MAX_TASKS_PER_CHILD=500
# Seconds to wait for lost worker
# CELERY_WORKER_LOST_WAIT=10
# Retry broker connection on startup
# CELERY_BROKER_CONNECTION_RETRY_ON_STARTUP=true
# Max broker connection retries
# CELERY_BROKER_CONNECTION_MAX_RETRIES=10
# Result expiration time in seconds
# CELERY_RESULT_EXPIRES=3600
# Thread-safe result backend
# CELERY_RESULT_BACKEND_THREAD_SAFE=true
# DB pool size per worker
# CELERY_DB_POOL_SIZE=3
# Max overflow connections per worker
# CELERY_DB_MAX_OVERFLOW=5
# Connection recycle time in seconds
# CELERY_DB_POOL_RECYCLE=1800

# ==========================================================================
# Authentication settings  (app/user/config.py)
# ==========================================================================

# ---------- General ----------
# AUTH_EMAIL_PASSWORD_ENABLED=true
# AUTH_GOOGLE_OAUTH_ENABLED=false
# AUTH_PHONE_OTP_ENABLED=false
# GOOGLE_CLIENT_ID=
# OTP_LENGTH=6
# OTP_TTL_SECONDS=300
# OTP_MAX_ATTEMPTS=5
# OTP_SMS_PROVIDER=noop
# JWT_ACCESS_TOKEN_EXPIRE_MINUTES=120
# JWT_REFRESH_TOKEN_EXPIRE_DAYS=7
# SUPER_ADMIN_ROLE=super_admin
# USER_CACHE_TTL_SECONDS=900
# USER_ROLE_LIST_CACHE_TTL_SECONDS=900


# ==========================================================================
# Docker Compose only (not read by Settings)
# ==========================================================================

# Flower monitoring UI credentials and port — consumed by docker-compose.yml.
# FLOWER_USERNAME=admin
# FLOWER_PASSWORD=
# FLOWER_PORT=5555