BugFinder/.env.example at main · highoncomputers/BugFinder · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# =============================================================================
# BugFinder Configuration
# Copy to .env and fill in your values
# All variables prefixed with BF_ are read by BugFinder
# =============================================================================

# ── AI Provider ────────────────────────────────────────────────────────────
# NVIDIA API (default provider, required for AI features)
BF_NVIDIA_API_KEY=
BF_NVIDIA_MODEL=minimax-m3
BF_NVIDIA_BASE_URL=https://integrate.api.nvidia.com/v1

# OpenAI (alternative provider — set BF_AI_PROVIDER="openai")
# BF_OPENAI_API_KEY=
# BF_OPENAI_MODEL=gpt-4o

# Anthropic (alternative provider — set BF_AI_PROVIDER="anthropic")
# BF_ANTHROPIC_API_KEY=
# BF_ANTHROPIC_MODEL=claude-3-opus-20240229

# Ollama (local — set BF_AI_PROVIDER="ollama")
# BF_OLLAMA_BASE_URL=http://localhost:11434
# BF_OLLAMA_MODEL=llama3

# Which AI provider to use: nvidia (default), openai, anthropic, ollama
BF_AI_PROVIDER=nvidia

# ── Web UI ─────────────────────────────────────────────────────────────────
BF_WEB_HOST=127.0.0.1
BF_WEB_PORT=8080
BF_WEB_SECRET_KEY=change-me-to-a-random-secret
BF_WEB_SESSION_EXPIRY_HOURS=24
BF_WEB_ALLOWED_ORIGINS=http://localhost:8080

# ── Database ───────────────────────────────────────────────────────────────
# SQLite (default): sqlite+aiosqlite:////path/to/bugfinder.db
# PostgreSQL: postgresql+asyncpg://user:pass@host:5432/bugfinder
BF_DATABASE_URL=

# ── Redis (optional — for celery background tasks) ─────────────────────────
BF_REDIS_URL=

# ── Scanning ───────────────────────────────────────────────────────────────
BF_MAX_CONCURRENT_TASKS=10
BF_RATE_LIMIT_PER_SECOND=50
BF_REQUEST_TIMEOUT=30
BF_USER_AGENT=BugFinder/0.2.0 (Security Assessment Tool)
BF_RESPECT_ROBOTS=true

# ── Scope ──────────────────────────────────────────────────────────────────
BF_SCOPE_ENFORCEMENT=true
# Comma-separated: BF_ALLOWED_DOMAINS=example.com,api.example.com
BF_ALLOWED_DOMAINS=

# ── Notifications ──────────────────────────────────────────────────────────
# Discord webhook URL
# BF_DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks/...

# Slack webhook URL
# BF_SLACK_WEBHOOK_URL=https://hooks.slack.com/services/...

# SMTP email settings
# BF_SMTP_HOST=smtp.gmail.com
# BF_SMTP_PORT=587
# BF_SMTP_USER=your@email.com
# BF_SMTP_PASSWORD=your-app-password
# BF_EMAIL_FROM=bugfinder@yourdomain.com
# BF_EMAIL_TO=you@yourdomain.com

# GitHub issues (auto-create issues for findings)
# BF_GITHUB_TOKEN=ghp_...
# BF_GITHUB_REPO=owner/repo

# ── Mode ───────────────────────────────────────────────────────────────────
BF_BEGINNER_MODE=true
BF_EDUCATIONAL_MODE=true
BF_LOG_LEVEL=INFO
BF_DEBUG=false