Environment Variables¶
All configuration is passed to VANTAGE via a .env file at the repository root.
Copy .env.example as a starting point:
cp .env.example .env
Required variables¶
These variables must be set before the stack will start.
MongoDB¶
Variable |
Description |
|---|---|
|
MongoDB root username |
|
MongoDB root password (use a strong, unique value) |
Application¶
Variable |
Description |
|---|---|
|
256-bit secret for JWT signing. Generate: |
|
Runtime environment: |
Optional — threat intelligence APIs¶
At least one API key is required for analysis to return results.
Variable |
Service |
|---|---|
|
VirusTotal |
|
AbuseIPDB |
|
Shodan |
|
AlienVault OTX |
|
GreyNoise |
|
UrlScan.io |
|
Pulsedive |
Optional — email (SMTP)¶
Required for password-reset and notification features.
Variable |
Description |
|---|---|
|
SMTP server hostname |
|
SMTP port (default: |
|
SMTP authentication username |
|
SMTP authentication password |
|
Sender address for outgoing mail |
Optional — network¶
Variable |
Description |
|---|---|
|
JSON array of allowed origins. Example: |
|
Outbound HTTP proxy for API calls (optional) |
|
Outbound HTTPS proxy for API calls (optional) |
Development-only variables¶
Warning
These variables are blocked when ENV=production. The backend will refuse to start
if they are set in a production environment.
Variable |
Description |
|---|---|
|
|
|
Password for the dev admin account (required when |
|
Password for the dev tech account (optional) |
Mongo Express (dev profile only)¶
Variable |
Description |
|---|---|
|
Basic-auth username for the Mongo Express UI |
|
Basic-auth password for the Mongo Express UI |