From 54a6389169fb3c4bb45dd7babd42f04ce603803b Mon Sep 17 00:00:00 2001 From: rarebuffalo Date: Sun, 3 May 2026 16:10:42 +0530 Subject: [PATCH] docs: update .env.example with AI provider options and threat intel keys --- .env.example | 66 ++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 59 insertions(+), 7 deletions(-) diff --git a/.env.example b/.env.example index eb251a5..0b89aed 100644 --- a/.env.example +++ b/.env.example @@ -1,27 +1,79 @@ -# SecureLens AI Configuration +# ============================================================ +# SecureLens AI — Environment Configuration +# ============================================================ +# Copy this file to .env and fill in your values. +# Never commit your actual .env file to version control. +# ------------------------------------------------------------ # Application +# ------------------------------------------------------------ APP_NAME=SecureLens AI -APP_VERSION=1.0.0 +APP_VERSION=1.1.0 DEBUG=true +# ------------------------------------------------------------ # Server +# ------------------------------------------------------------ HOST=0.0.0.0 PORT=8000 -# CORS - comma-separated list of allowed origins +# ------------------------------------------------------------ +# CORS — comma-separated list of allowed origins +# ------------------------------------------------------------ CORS_ORIGINS=http://localhost:3000,http://localhost:5173 +# ------------------------------------------------------------ # Rate Limiting +# ------------------------------------------------------------ RATE_LIMIT=30/minute -# Scanner +# ------------------------------------------------------------ +# Scanner Timeouts (seconds) +# ------------------------------------------------------------ SCAN_TIMEOUT=5 PATH_CHECK_TIMEOUT=3 -# Database configuration +# ------------------------------------------------------------ +# Database +# ------------------------------------------------------------ DATABASE_URL=postgresql+asyncpg://securelens:securelens@localhost:5433/securelens -# AI Integration -GEMINI_API_KEY= +# ------------------------------------------------------------ +# JWT Auth +# ------------------------------------------------------------ +JWT_SECRET=change-me-in-production-use-a-long-random-string +# ------------------------------------------------------------ +# AI Provider (LiteLLM — pick ONE of the options below) +# ------------------------------------------------------------ +# Option 1: Google Gemini (default) +AI_MODEL=gemini/gemini-2.0-flash +AI_API_KEY=your-gemini-api-key-here + +# Option 2: OpenAI +# AI_MODEL=gpt-4o-mini +# AI_API_KEY=your-openai-api-key-here + +# Option 3: Anthropic Claude +# AI_MODEL=claude-3-5-haiku-20241022 +# AI_API_KEY=your-anthropic-api-key-here + +# Option 4: OpenRouter (access to all models with one key) +# AI_MODEL=openrouter/google/gemini-2.0-flash-exp:free +# AI_API_KEY=your-openrouter-api-key-here + +# Option 5: Ollama (local, free — no key needed) +# AI_MODEL=ollama/llama3.1 +# AI_API_KEY= + +# Legacy: still works for Gemini backward compatibility +# GEMINI_API_KEY=your-gemini-api-key-here + +# ------------------------------------------------------------ +# Threat Intelligence (Optional — free tier available) +# ------------------------------------------------------------ +# VirusTotal: https://www.virustotal.com/ (500 lookups/day free) +VIRUSTOTAL_API_KEY= + +# AbuseIPDB: https://www.abuseipdb.com/ (1000 lookups/day free) +ABUSEIPDB_API_KEY=