.env.example

# ==============================================================================
# Environment Configuration Template
# ==============================================================================
# INSTRUCTIONS:
# 1. Copy this file and rename it to `.env` (this file is ignored by git).
# 2. Replace the placeholder values with your actual local configuration.
# 3. DO NOT commit actual secrets (passwords, API keys) to version control.
# 4. Use meaningful defaults for development where safe.
# ==============================================================================

# ------------------------------------------------------------------------------
# Core Application Settings
# ------------------------------------------------------------------------------
# Application Environment (e.g., development, staging, production, testing)
APP_ENV=development
# Enable/disable debug mode (verbose logging, stack traces)
APP_DEBUG=true
APP_NAME="template_python"
APP_VERSION="1.0.0"
# Base URL for the application (useful for generating absolute links, emails)
APP_URL=http://localhost:8080
# Timezone context for the application
APP_TIMEZONE=UTC
# Default locale/language
APP_LOCALE=en

# ------------------------------------------------------------------------------
# Server / Network Configuration
# ------------------------------------------------------------------------------
# Port the application server listens on
PORT=8080
APP_PORT=8080
# Host to bind to (0.0.0.0 for all interfaces, useful in Docker environments)
HOST=0.0.0.0
# Allowed hosts/CORS origins (comma separated)
CORS_ALLOWED_ORIGINS=http://localhost:3000,http://localhost:8080

# ------------------------------------------------------------------------------
# Database Configuration (Relational / SQL)
# ------------------------------------------------------------------------------
# Connection type (e.g., postgres, mysql, sqlite, mssql)
DB_CONNECTION=postgres
DB_HOST=localhost
DB_PORT=5432
DB_DATABASE=template_python_dev
DB_USERNAME=admin
DB_PASSWORD=secret
# Database schema (if applicable, e.g., public for postgres)
DB_SCHEMA=public
# Full connection string alternative (often used by ORMs like Prisma or SQLAlchemy)
# DATABASE_URL=postgres://admin:secret@localhost:5432/template_python_dev

# ------------------------------------------------------------------------------
# Cache / Key-Value Store / Message Brokers
# ------------------------------------------------------------------------------
# Redis configuration
REDIS_HOST=localhost
REDIS_PORT=6379
REDIS_PASSWORD=null
REDIS_DB=0
# REDIS_URL=redis://localhost:6379/0

# Memcached configuration
MEMCACHED_HOST=localhost
MEMCACHED_PORT=11211

# RabbitMQ / Celery / Message Queue
# RABBITMQ_URL=amqp://guest:guest@localhost:5672/

# ------------------------------------------------------------------------------
# Security & Authentication
# ------------------------------------------------------------------------------
# Application secret key (used for sessions, cookie signing, CSRF tokens)
APP_SECRET_KEY=your_super_secret_key_change_in_production
# JWT (JSON Web Token) configuration
JWT_SECRET=your_jwt_secret_key
JWT_EXPIRES_IN=86400 # e.g., in seconds (1 day)
# OAuth / Single Sign-On (SSO) generic providers
OAUTH_CLIENT_ID=your_oauth_client_id
OAUTH_CLIENT_SECRET=your_oauth_client_secret

# ------------------------------------------------------------------------------
# Email / SMTP Configuration
# ------------------------------------------------------------------------------
MAIL_MAILER=smtp
MAIL_HOST=smtp.mailtrap.io
MAIL_PORT=2525
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=tls
MAIL_FROM_ADDRESS=noreply@example.com
MAIL_FROM_NAME="${APP_NAME}"

# ------------------------------------------------------------------------------
# Object Storage / Cloud Providers
# ------------------------------------------------------------------------------
# AWS S3 / MinIO configuration
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=
AWS_USE_PATH_STYLE_ENDPOINT=false
# AWS_ENDPOINT=http://localhost:9000 # Uncomment for MinIO

# Google Cloud Platform
# GOOGLE_APPLICATION_CREDENTIALS=/path/to/service-account.json
# GCP_PROJECT_ID=

# ------------------------------------------------------------------------------
# Observability / Logging / Telemetry
# ------------------------------------------------------------------------------
# Log level: debug, info, warn, error, fatal
LOG_LEVEL=debug
LOG_FORMAT=json # or text
# Sentry DSN for error tracking
# SENTRY_DSN=https://examplePublicKey@o0.ingest.sentry.io/0
# Datadog, Prometheus, NewRelic etc.
# DD_API_KEY=
# TELEMETRY_ENABLED=true

# ------------------------------------------------------------------------------
# Common Third-Party API Keys (Placeholders)
# ------------------------------------------------------------------------------
# Stripe / Payment Gateway
# STRIPE_PUBLIC_KEY=pk_test_...
# STRIPE_SECRET_KEY=sk_test_...
# STRIPE_WEBHOOK_SECRET=whsec_...

# AI / LLM APIs (OpenAI, Anthropic, etc.)
# OPENAI_API_KEY=sk-...
# ANTHROPIC_API_KEY=sk-ant-...

# ------------------------------------------------------------------------------
# Frontend / UI Specific Variables
# ------------------------------------------------------------------------------
# Note: Many frontend frameworks require specific prefixes to expose vars to the client.
# The below variables show how to map backend values to frontend framework standards.
# Next.js: NEXT_PUBLIC_
# Vite: VITE_
# Create React App: REACT_APP_
# Vue/Nuxt: NUXT_PUBLIC_ / VUE_APP_

NEXT_PUBLIC_APP_URL=${APP_URL}
NEXT_PUBLIC_API_URL=${APP_URL}/api/v1
VITE_API_BASE_URL=${APP_URL}/api/v1
REACT_APP_API_URL=${APP_URL}/api/v1

# ------------------------------------------------------------------------------
# CI/CD & Deployment Flags
# ------------------------------------------------------------------------------
# Flags to trigger specific build or deployment behaviors in GitHub Actions, GitLab CI, etc.
# CI=true
# SKIP_PREFLIGHT_CHECK=true
# DOCKER_BUILD_TARGET=development