CVE-Radar/.env.example at main · RaminNietzsche/CVE-Radar · 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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
PORT=3001
SCAN_DAYS=60

# NEVER commit real keys. Use Docker/K8s secrets in production — see docs/self-hosted/SECRETS.md
# Alternative: point *_FILE at mounted secret paths (e.g. /run/secrets/nvd_api_key)

# Optional API key — when set, all /api/* routes require X-Api-Key or Authorization: Bearer (except GET /health)
# API_SECRET=
# API_SECRET_FILE=/run/secrets/api_secret
# Role for authenticated clients when RBAC is active (default admin): admin | scanner | viewer | auditor
# API_ROLE=admin
# Client build (same value, single-tenant internal tool): VITE_API_KEY=

# OIDC / SSO — map IdP groups to API roles per request (Bearer JWT). See SECURITY.md
# OIDC_ISSUER=https://login.example.com/realms/cve-radar
# OIDC_CLIENT_ID=cve-radar-spa
# OIDC_JWKS_URI=https://login.example.com/realms/cve-radar/protocol/openid-connect/certs
# OIDC_AUDIENCE=cve-radar-api
# OIDC_GROUPS_CLAIM=groups
# OIDC_ROLE_MAPPING={"cve-radar-admin":"admin","cve-radar-scanner":"scanner"}
# OIDC_DEFAULT_ROLE=viewer
# OIDC_UI_SCOPES=openid profile email
# OIDC_HS256_SECRET=dev-only-shared-secret

# Server limits (public deployments)
# RATE_LIMIT_SCAN_PER_MIN=12
# RATE_LIMIT_WATCH_PER_MIN=120
# RATE_LIMIT_API_PER_MIN=240
# RATE_LIMIT_NOTIFICATION_TEST_PER_MIN=1
# TRUST_PROXY_HOPS=1
# Client watch interval is UI-only (default 2 min). See docs/WATCH.md
# SCAN_TIMEOUT_MS=120000

# Structured audit logging (stdout JSON) — see docs/self-hosted/AUDIT.md
# AUDIT_HEALTH=true

# Optional alerting (watch mode new CVEs) — see server/services/notifications/
# Legacy Slack webhook (still supported):
# ALERT_WEBHOOK_URL=https://hooks.slack.com/services/...
# ALERT_WEBHOOK_URL_FILE=/run/secrets/alert_webhook_url
# ALERT_MIN_SEVERITY=HIGH
# ALERT_WEBHOOK_FORMAT=slack
# NOTIFICATION_MIN_SEVERITY=HIGH
# Per-channel min severity (optional; falls back to NOTIFICATION_MIN_SEVERITY):
# NOTIFICATION_SLACK_MIN_SEVERITY=CRITICAL
# NOTIFICATION_DISCORD_MIN_SEVERITY=
# NOTIFICATION_TEAMS_MIN_SEVERITY=
# NOTIFICATION_TELEGRAM_MIN_SEVERITY=
# NOTIFICATION_EMAIL_MIN_SEVERITY=
# NOTIFICATION_WEBHOOK_MIN_SEVERITY=
# NOTIFICATION_DEDUP_MS=900000
# Hourly send cap per channel (sliding window; 0 or unset = unlimited):
# NOTIFICATION_RATE_LIMIT_PER_HOUR=60
# NOTIFICATION_SLACK_RATE_LIMIT_PER_HOUR=
# NOTIFICATION_DISCORD_RATE_LIMIT_PER_HOUR=
# NOTIFICATION_TEAMS_RATE_LIMIT_PER_HOUR=
# NOTIFICATION_TELEGRAM_RATE_LIMIT_PER_HOUR=
# NOTIFICATION_EMAIL_RATE_LIMIT_PER_HOUR=
# NOTIFICATION_WEBHOOK_RATE_LIMIT_PER_HOUR=
# NOTIFICATION_SLACK_WEBHOOK_URL=
# NOTIFICATION_SLACK_WEBHOOK_URL_FILE=/run/secrets/slack_webhook
# NOTIFICATION_DISCORD_WEBHOOK_URL=
# NOTIFICATION_DISCORD_WEBHOOK_URL_FILE=/run/secrets/discord_webhook
# NOTIFICATION_TEAMS_WEBHOOK_URL=
# NOTIFICATION_TEAMS_WEBHOOK_URL_FILE=/run/secrets/teams_webhook
# NOTIFICATION_TELEGRAM_BOT_TOKEN=
# NOTIFICATION_TELEGRAM_BOT_TOKEN_FILE=/run/secrets/telegram_bot_token
# NOTIFICATION_TELEGRAM_CHAT_ID=
# NOTIFICATION_TELEGRAM_CHAT_ID_FILE=/run/secrets/telegram_chat_id
# NOTIFICATION_WEBHOOK_URL=
# NOTIFICATION_WEBHOOK_URL_FILE=/run/secrets/notification_webhook
# NOTIFICATION_SMTP_HOST=
# NOTIFICATION_SMTP_PORT=587
# NOTIFICATION_SMTP_USER=
# NOTIFICATION_SMTP_USER_FILE=/run/secrets/smtp_user
# NOTIFICATION_SMTP_PASS=
# NOTIFICATION_SMTP_PASS_FILE=/run/secrets/smtp_pass
# NOTIFICATION_SMTP_FROM=
# NOTIFICATION_SMTP_TO=
NVD_RESULTS_PER_PAGE=30
# NVD_MAX_PAGES=10
# NVD_API_KEY=
# NVD_API_KEY_FILE=/run/secrets/nvd_api_key

# GITHUB_TOKEN=
# GITHUB_TOKEN_FILE=/run/secrets/github_token
GITHUB_MAX_PAGES=3
# GITLAB_ADVISORY_ENABLED=true
# GITLAB_ADVISORY_MIRROR_URL=https://gitlab.example/mirror/advisories-community/-/raw/main
# OSV_TIMEOUT_MS=15000

# Distro / OS advisory feeds (#153)
# ALPINE_ENABLED=true
# ALPINE_RELEASES=v3.20,v3.21
# ALPINE_SECDB_MIRROR_URL=https://mirror.example/alpine-secdb
# USN_ENABLED=true
# UBUNTU_RELEASES=jammy,noble
# USN_MIRROR_URL=https://mirror.example/ubuntu-security
# UBUNTU_CVE_PAGES=15
# UBUNTU_CVE_PAGE_SIZE=20
# REDHAT_ENABLED=true
# REDHAT_SECURITY_API_BASE=https://mirror.example/redhat/hydra/rest/securitydata
# DEBIAN_ENABLED=true
# DEBIAN_TRACKER_CACHE_PATH=/data/debian/security-tracker.json
# DEBIAN_TRACKER_URL=https://security-tracker.debian.org/tracker/data/json
# ALAS_ENABLED=true
# ALAS_UPDATEINFO_URL=https://mirror.example/amzn2023/updateinfo.xml
# ALAS_MIRROR_URL=https://mirror.example/amazon/updateinfo.xml
# MITRE_CVE_ENABLED=false
# MITRE_CVE_API_BASE=https://mirror.example/mitre/api/cve

# Translation (Google GTX unofficial — dev/personal only; optional DeepL / LibreTranslate / MyMemory / Ollama)
# See docs/TRANSLATION.md for provider priority and limits.
TRANSLATE_ENABLED=true
TRANSLATE_MAX_ITEMS=50
TRANSLATE_BATCH_MAX=40
TRANSLATE_CONCURRENCY=3
# DEEPL_API_KEY=your-deepl-key:fx
# DEEPL_API_KEY_FILE=/run/secrets/deepl_api_key
# MYMEMORY_EMAIL=you@example.com
# LIBRETRANSLATE_URL=https://your-libretranslate-host
# LIBRETRANSLATE_API_KEY=
# OLLAMA_URL=http://127.0.0.1:11434
# OLLAMA_MODEL=llama3.2

# Shared cache for multi-instance deployments (optional — in-memory when unset)
# REDIS_URL=redis://127.0.0.1:6379
# CACHE_MAX_ENTRIES=2000

# BullMQ scan job queue (optional — requires REDIS_URL + worker process)
# JOB_QUEUE_ENABLED=true
# WORKER_CONCURRENCY=1
# JOB_RESULT_TTL_SEC=3600

# Optional PostgreSQL scan history (metadata only; skip when unset)
# DATABASE_URL=postgres://cve_radar:cve_radar@127.0.0.1:5432/cve_radar
# Docker Compose postgres profile: DATABASE_URL=postgres://cve_radar:cve_radar@postgres:5432/cve_radar (in-stack)
# Multi-tenant v1 API: X-Tenant-Id: <slug> (default when omitted; invalid header → 400) — docs/self-hosted/TENANTS.md

# Server data directory (Docker Compose mounts /app/data by default)
# DATA_DIR=./data

# Air-gapped deployment (local mirrors only — see docs/self-hosted/AIRGAP.md)
# AIRGAPPED=true
# NVD_MIRROR_URL=http://internal-mirror/nvd
# OSV_MIRROR_URL=http://internal-mirror/osv
# OSV_BULK_PATH=/data/osv/extracted
# Docker Compose: OSV_BULK_PATH=/app/data/osv-bulk/extracted + volume mount (see docker-compose.yml)
# KEV_MIRROR_URL=http://internal-mirror/kev/catalog.json
# MIRROR_MANIFEST_PATH=/data/mirrors/.mirror-manifest.json
# MIRROR_STALE_DAYS=7

# Mirror sync (internet-connected zone — see docs/self-hosted/AIRGAP.md)
# MIRROR_SYNC_DEST=./data/mirrors
# MIRROR_NVD_DAYS=60
# MIRROR_SKIP_OSV=true

# Kubernetes stack discovery (opt-in — see docs/self-hosted/K8S.md)
# K8S_DISCOVERY_ENABLED=true
# K8S_DISCOVERY_NAMESPACES=production,staging
# K8S_KUBECONFIG=/path/to/kubeconfig

# Prometheus metrics at GET /metrics (see docs/self-hosted/METRICS.md)
# METRICS_ENABLED=true
# METRICS_PROTECT=false

# EPSS enrichment (FIRST.org) — set false to disable riskScore fields
# EPSS_ENABLED=true
# EPSS_BATCH_SIZE=100

# CWE → NIST / PCI-DSS compliance mapping (static map in shared/compliance/)
# COMPLIANCE_ENABLED=true