.env.example

# Gram Environment Configuration Template
# Copy this file to .env and fill in the values for your environment
# See AGENTS.md for detailed setup instructions

# ============================================================================
# REQUIRED: Application & Environment
# ============================================================================

# Node.js environment (development, staging, production)
NODE_ENV=development

# Application origin URL (frontend access URL)
ORIGIN=http://localhost:4726

# ============================================================================
# REQUIRED: Authentication & Security
# ============================================================================

# Secret key for signing JWT authentication tokens
# Generate with: openssl rand -base64 32
AUTH_SECRET=your-secret-key-here-change-in-production

# ============================================================================
# REQUIRED: Database Configuration
# ============================================================================

# PostgreSQL host
POSTGRES_HOST=localhost

# PostgreSQL port
POSTGRES_PORT=5432

# PostgreSQL user
POSTGRES_USER=gram

# PostgreSQL password
POSTGRES_PASSWORD=somethingsecret

# PostgreSQL database name
POSTGRES_DATABASE=gram

# Set to any value to disable SSL verification (for local development only)
# Omit or leave empty for SSL enabled (production)
POSTGRES_DISABLE_SSL=true

# ============================================================================
# OPTIONAL: Email Notifications (Magic Link Authentication)
# ============================================================================

# Email server hostname
EMAIL_HOST=

# Email server port
EMAIL_PORT=

# Email account username
EMAIL_USER=

# Email account password
EMAIL_PASSWORD=

# ============================================================================
# OPTIONAL: Error Tracking (Sentry)
# ============================================================================

# Sentry DSN for error tracking and performance monitoring
# Example: https://xxxxx@xxxxx.ingest.sentry.io/xxxxx
SENTRY_DSN=

# ============================================================================
# OPTIONAL: Frontend Environment
# ============================================================================

# Frontend port (used during development with react-scripts)
# Set in npm script: PORT=4726 npm start
PORT=4726

# Frontend version (populated from package.json during build)
REACT_APP_VERSION=

# ============================================================================
# NOTES
# ============================================================================

# - For local development, use provided values or docker-compose defaults
# - For production, replace all secrets with secure values
# - Database credentials should use strong passwords
# - AUTH_SECRET must be a random string (use: openssl rand -base64 32)
# - Email configuration only needed if using email-based authentication
# - Sentry is optional but recommended for production deployments
# - Ensure .env is in .gitignore and never committed to version control