.env.example

# ─────────────────────────────────────────────────────────────────────────────
# CodeOwl — example environment file
#
# Copy this file to `.env` (same directory as docker-compose.yml) and adjust the
# values. Docker Compose picks `.env` up automatically. Variables shown with a
# value are the defaults baked into docker-compose.yml; you only need to set the
# ones marked REQUIRED, plus anything you want to override.
# ─────────────────────────────────────────────────────────────────────────────

# === AI provider (REQUIRED) ===================================================
# OpenAI API key used for task generation, concept detection, tagging and hints.
# The backend will not start without it.
OPENAI_API_KEY=sk-your-key-here

# === Authentication ===========================================================
# Secret used to sign JWTs (HS256). MUST be at least 256 bits (32+ chars).
# A dev fallback exists, but you MUST set your own value for any real deployment.
JWT_SECRET=change-me-to-a-long-random-secret-at-least-32-chars

# Base URL of the running frontend. Used to build links in outgoing e-mails
# (password reset, student onboarding). Match this to how users reach the app.
APP_BASE_URL=http://localhost:5175

# Optional: e-mail address that is automatically granted the ADMIN role on
# startup. Leave empty to skip admin bootstrapping.
# Note: to use this with Docker, add ROOT_ADMIN_EMAIL to the backend service's
# `environment:` block in docker-compose.yml.
ROOT_ADMIN_EMAIL=

# === CORS =====================================================================
# Comma-separated list of allowed origins. "*" is fine for local development;
# tighten this for production.
CORS_ALLOWED_ORIGINS=*

# === Mail (optional) ==========================================================
# If left empty, the backend logs e-mails to the console instead of sending them
# (handy for local development). Fill these in to send real mail via SMTP.
MAIL_HOST=
MAIL_PORT=587
MAIL_USERNAME=
MAIL_PASSWORD=

# === Frontend build args ======================================================
# Base path the SPA is served under (defaults to the production "/codeowl/").
# Set to "/" to serve the app at the web root.
VITE_BASE_PATH=/codeowl/

# Base URL the frontend uses for API calls. The nginx container proxies
# "/codeowl/api/" to the backend, so the default works out of the box.
VITE_API_BASE_URL=/codeowl/api