.env.example

# =============================================================================
# DeepV-Ki Environment Configuration
# =============================================================================
# Copy this file to .env and fill in the values:
#   cp .env.example .env
#
# Variables marked [Required] must be set for core functionality.
# Variables marked [Optional] have sensible defaults or enable extra features.
# Commented-out variables show available options with their defaults.
# =============================================================================

# -----------------------------------------------------------------------------
# AI Provider API Keys
# At least one provider key is required for Wiki generation.
# -----------------------------------------------------------------------------

# [Required] At least one of the following AI provider keys
OPENAI_API_KEY=
GOOGLE_API_KEY=

# [Optional] Additional AI providers
# OPENROUTER_API_KEY=
# DASHSCOPE_API_KEY=

# [Optional] Azure OpenAI - required if using Azure as provider
# AZURE_OPENAI_API_KEY=
# AZURE_OPENAI_ENDPOINT=
# AZURE_OPENAI_VERSION=

# [Optional] AWS Bedrock - required if using Bedrock as provider
# AWS_ACCESS_KEY_ID=
# AWS_SECRET_ACCESS_KEY=
# AWS_REGION=us-east-1
# AWS_ROLE_ARN=

# [Optional] Custom API endpoints for OpenAI-compatible services
# OPENAI_BASE_URL=https://api.openai.com/v1
# DASHSCOPE_BASE_URL=https://dashscope.aliyuncs.com/compatible-mode/v1

# [Optional] Ollama local model host
# OLLAMA_HOST=http://localhost:11434

# -----------------------------------------------------------------------------
# Server Configuration
# -----------------------------------------------------------------------------

# [Optional] Backend API server port (default: 8001)
PORT=8001

# [Optional] Backend server base URL, used by frontend to proxy API requests
SERVER_BASE_URL=http://localhost:8001

# [Optional] Frontend URL, used for OAuth/SSO redirects
FRONTEND_URL=http://localhost:3000

# [Optional] Runtime environment: 'production' or 'development'
# NODE_ENV=development

# -----------------------------------------------------------------------------
# Frontend Configuration (Next.js)
# -----------------------------------------------------------------------------

# [Optional] Override backend URL for Next.js API routes (server-side)
# Takes priority over SERVER_BASE_URL in frontend API route handlers
# PYTHON_BACKEND_HOST=http://localhost:8001

# [Optional] Public-facing GitLab URL for frontend UI display
# NEXT_PUBLIC_GITLAB_URL=https://gitlab.com

# [Optional] Public-facing API base URL for browser-side requests
# NEXT_PUBLIC_API_URL=http://localhost:3000

# -----------------------------------------------------------------------------
# GitLab OAuth Configuration
# Required only when GitLab authentication is enabled.
# If you don't need GitLab OAuth login, these can be left empty.
# -----------------------------------------------------------------------------

# [Required for GitLab Auth] GitLab instance URL
GITLAB_URL=https://gitlab.com

# [Required for GitLab Auth] OAuth Application credentials from GitLab
GITLAB_CLIENT_ID=
GITLAB_CLIENT_SECRET=

# [Required for GitLab Auth] Must match the Callback URL configured in your GitLab Application
# Local: http://localhost:8001/api/auth/gitlab/callback
# Prod:  https://your-domain.com/api/auth/gitlab/callback
GITLAB_REDIRECT_URI=http://localhost:8001/api/auth/gitlab/callback

# [Optional] GitLab Personal Access Token for server-side Git operations
# Used for cloning repos, fetching file trees, etc.
# GITLAB_TOKEN=

# [Optional] GitHub Personal Access Token for accessing private repos
# GITHUB_TOKEN=

# -----------------------------------------------------------------------------
# SSO / OIDC Configuration (Optional, for enterprise SSO login)
# -----------------------------------------------------------------------------

# SSO_CLIENT_ID=
# SSO_CLIENT_SECRET=
# SSO_SERVER_METADATA_URL=https://sso.example.com/realms/oa-sso/.well-known/openid-configuration

# -----------------------------------------------------------------------------
# Session & Security
# -----------------------------------------------------------------------------

# [Required for production] Session encryption key
# Generate a strong random string for production deployments
SESSION_SECRET_KEY=change_this_to_a_random_secret_string

# -----------------------------------------------------------------------------
# Wiki Authentication (Optional)
# -----------------------------------------------------------------------------

# [Optional] Enable wiki access authentication (default: False)
# DEEPWIKI_AUTH_MODE=False

# [Optional] Auth code required when DEEPWIKI_AUTH_MODE is enabled
# DEEPWIKI_AUTH_CODE=

# -----------------------------------------------------------------------------
# Advanced Configuration
# -----------------------------------------------------------------------------

# [Optional] Custom path to JSON config files (generator.json, embedder.json, etc.)
# Defaults to api/config/ directory
# DEEPWIKI_CONFIG_DIR=/path/to/custom/config/dir

# [Optional] Redis URL for Celery task queue (default: redis://localhost:6379/0)
# REDIS_URL=redis://localhost:6379/0

# -----------------------------------------------------------------------------
# Logging Configuration
# -----------------------------------------------------------------------------

# [Optional] Log level: DEBUG, INFO, WARNING, ERROR, CRITICAL (default: INFO)
LOG_LEVEL=INFO

# [Optional] Log file path (default: api/logs/application.log)
# LOG_FILE_PATH=api/logs/application.log

# [Optional] Max log file size in MB before rotation (default: 10)
# LOG_MAX_SIZE=10

# [Optional] Number of rotated log file backups to keep (default: 5)
# LOG_BACKUP_COUNT=5