.env.example

# .env.example - Configuration template
# Copy this file to .env and fill in the appropriate values for your environment.
# Do NOT commit the .env file to version control.

# -- General Project Settings --

# Project Name: Used for identification purposes.
PROJECT_NAME="Quick Forge AI"

# Stack Name: Identifier for deployment stacks (e.g., Docker Swarm, Kubernetes).
STACK_NAME="quick-forge-ai"

# Environment: Specifies the deployment environment.
# Options: local, staging, production
ENVIRONMENT=local

# -- Domain & Frontend Settings --

# Domain: The primary domain for the application.
# Used by Traefik for routing and TLS certificate acquisition.
# Example for local development using nip.io: localhost.nip.io
# Example for production: yourdomain.com
DOMAIN=localhost.nip.io

# Frontend Host: The full URL of the frontend application.
# Used by the backend to generate links (e.g., in emails).
# Example for local development: http://localhost:5173
# Example for production: https://dashboard.yourdomain.com
FRONTEND_HOST=http://localhost:5173

# -- Backend Settings --

# Backend CORS Origins: A comma-separated list of allowed origins for Cross-Origin Resource Sharing.
# Include frontend URLs for local, staging, and production environments.
# Example: http://localhost:5173,https://dashboard.yourdomain.com,https://staging.yourdomain.com
BACKEND_CORS_ORIGINS="http://localhost,http://localhost:5173,https://localhost,https://localhost:5173,https://localhost:5174,http://localhost:5174,http://localhost.nip.io"

# Secret Key: A strong, unique secret key for cryptographic signing (e.g., JWTs).
# Generate a secure key using tools like `openssl rand -hex 32`.
# KEEP THIS SECRET.
SECRET_KEY=''

# First Superuser: Email address for the initial administrator account.
FIRST_SUPERUSER=admin@telepace.com

# First Superuser Password: Password for the initial administrator account.
# Choose a strong password.
FIRST_SUPERUSER_PASSWORD='telepace'

# -- Email (SMTP) Settings --
# Configuration for sending emails (e.g., password resets, notifications).

# SMTP Host: The hostname or IP address of your SMTP server.
SMTP_HOST=smtp.example.com

# SMTP Port: The port number for the SMTP server.
# Common ports: 587 (TLS), 465 (SSL), 25 (unencrypted - not recommended).
SMTP_PORT=587

# SMTP User: The username for authenticating with the SMTP server.
SMTP_USER=telepace

# SMTP Password: The password for authenticating with the SMTP server.
# KEEP THIS SECRET.
SMTP_PASSWORD=telepace

# SMTP TLS: Enable TLS encryption (recommended). Set to True or False.
SMTP_TLS=True

# SMTP SSL: Enable SSL encryption (older method, less common than TLS). Set to True or False.
SMTP_SSL=False

# Emails From Email: The email address displayed as the sender.
EMAILS_FROM_EMAIL=noreply@yourdomain.com

# -- Database Settings --

# Database Type: Specify the database provider.
# Options: postgres, supabase
DATABASE_TYPE=postgres

# --- PostgreSQL Settings (if DATABASE_TYPE=postgres) ---

# Postgres Server: Hostname or IP address of the PostgreSQL server.
POSTGRES_SERVER=127.0.0.1

# Postgres Port: Port number for the PostgreSQL server.
POSTGRES_PORT=5432

# Postgres User: Username for connecting to the PostgreSQL database.
POSTGRES_USER=postgres

# Postgres Password: Password for the PostgreSQL user.
# KEEP THIS SECRET.
POSTGRES_PASSWORD=telepace

# Postgres DB: Name of the PostgreSQL database to use.
POSTGRES_DB=app

# --- Supabase Settings (if DATABASE_TYPE=supabase) ---

# Supabase URL: Your Supabase project URL (found in Project Settings > API).
SUPABASE_URL=https://<your_project_ref>.supabase.co

# Supabase API Key: Your Supabase project 'service_role' key (found in Project Settings > API).
# KEEP THIS SECRET.
SUPABASE_API_KEY=<your_supabase_service_role_key>

# Supabase DB Host: The database host address (found in Project Settings > Database > Connection string).
# Use the connection pooler host for better performance.
# Example (Pooler): aws-0-us-west-1.pooler.supabase.com
# Example (Direct): db.<your_project_ref>.supabase.co
SUPABASE_DB_HOST=aws-0-us-west-1.pooler.supabase.com

# Supabase DB Port: The database port number (found in Project Settings > Database > Connection string).
# Common ports: 5432 (Direct/Session pooling), 6543 (Transaction pooling).
SUPABASE_DB_PORT=6543

# Supabase DB User: The database username (found in Project Settings > Database > Connection string).
# Usually 'postgres' for direct connection or 'postgres.<project_ref>' for pooler.
SUPABASE_DB_USER=''

# Supabase DB Password: The database password (set in Project Settings > Database).
# KEEP THIS SECRET.
SUPABASE_DB_PASSWORD=<your_supabase_db_password>

# Supabase DB Name: The name of the database. Usually 'postgres'.
SUPABASE_DB_NAME=postgres

# Supabase DB Pool Mode: The connection pooling mode.
# Options: session, transaction
SUPABASE_DB_POOL_MODE=transaction

# -- Monitoring --

# Sentry DSN: Your Sentry Data Source Name for error tracking.
# Optional. Leave blank if not using Sentry.
SENTRY_DSN=''

# -- Docker Image Settings --
# Specify custom Docker image names if you are building and pushing your own images.
# Otherwise, leave them as default if using local builds or pre-defined images.

# Docker Image Backend: Name/tag of the backend Docker image.
DOCKER_IMAGE_BACKEND=backend

# Docker Image Frontend: Name/tag of the frontend Docker image.
DOCKER_IMAGE_FRONTEND=frontend


# Test environment configuration example (port number +1), multiple sets of services are deployed simultaneously on the same machine
# TRAEFIK_HTTP_PORT=81
# TRAEFIK_HTTPS_PORT=444
# PROXY_HTTP_PORT=81
# PROXY_DASHBOARD_PORT=8091
# DB_PORT=5433
# ADMINER_PORT=8081
# BACKEND_PORT=8001
# MAILCATCHER_WEB_PORT=1081
# MAILCATCHER_SMTP_PORT=1026
# FRONTEND_PORT=5174
# PLAYWRIGHT_PORT=9324
# BACKEND_PORT=8001
# BACKEND_API_URL=http://localhost:8001
# MAILCATCHER_WEB_PORT=1081
# MAILCATCHER_HOST=http://localhost:1081

# ADMINER_CONTAINER_PORT=8081
# BACKEND_CONTAINER_PORT=8001
# FRONTEND_CONTAINER_PORT=81

# -- Production Settings --
# PRODUCTION_API_URL=https://api.yourdomain.com