The server reads its configuration from environment variables. Every variable can
also be set in a .env file in its working directory. Variables that are already
set in the real environment, such as a container or a Kubernetes secret, take
precedence over the file.
The complete table is in the environment reference.
This page groups the settings by the decision they support.
Addresses and TLS
| Variable | Default | Purpose |
|---|
HTTP_ADDR | :8080 | Address the server listens on. |
TLS_CERT_FILE, TLS_KEY_FILE | | Serve HTTPS when both are set. |
PUBLIC_URL | | The address of the UI, for example https://vop.example.com. Required with OIDC or SAML. |
Redis and object storage
| Variable | Default | Purpose |
|---|
REDIS_ADDR, REDIS_PASSWORD, REDIS_DB | localhost:6379, empty, 0 | Redis connection. Redis must be reachable when the server starts. |
STORAGE_BACKEND | s3 | s3 keeps SBOMs, reports and agent binaries in a bucket. local keeps them as files in STORAGE_DIR. |
STORAGE_DIR | ./data/storage | Directory for the local backend. |
S3_ENDPOINT | localhost:9000 | S3 endpoint, without a scheme. |
S3_ACCESS_KEY, S3_SECRET_KEY | | Required with the s3 backend. |
S3_BUCKET | vulnerability-operator | Created at start when missing. |
S3_REGION, S3_USE_SSL, S3_PATH_STYLE | us-east-1, false, true | Options for S3-compatible stores. |
Database
| Variable | Default | Purpose |
|---|
DB_DRIVER | sqlite | sqlite, mysql, postgres or mssql. |
DB_NAME, DB_HOST, DB_PORT, DB_USER, DB_PASSWORD, DB_SSLMODE, DB_TIMEZONE | DB_TIMEZONE=UTC | Connection. For SQLite, DB_NAME is the file. |
DB_MAX_OPEN_CONNS, DB_MAX_IDLE_CONNS, DB_CONN_MAX_LIFETIME_MINUTES | 50, 10, 5 | Connection pool. |
EXECUTE_MIGRATIONS | true | Run the migrations on start. |
Roles and workers
| Variable | Default | Purpose |
|---|
VOP_ROLE | all | all serves the API and runs the workers in one process. api serves HTTP and queues work. worker runs the jobs and the scheduler without HTTP. |
WORKER_CONCURRENCY | 2 | Jobs one process runs at once. |
SCAN_WORKERS | 4 | Assets matched in parallel. Saving the results stays one at a time. |
Vulnerability data
| Variable | Default | Purpose |
|---|
GRYPE_DB_DIR | ./data/grype | Where the local Grype database is kept. |
GRYPE_DB_UPDATE | true | false only reads the local database. Use it for air-gapped installations, and copy the database there yourself. |
Sessions, sign-in and limits
| Variable | Default | Purpose |
|---|
INITIAL_ADMIN_EMAIL, INITIAL_ADMIN_PASSWORD | admin@localhost, generated | The first administrator, created when the database is empty. |
AUTH_PASSWORD_LOGIN | true | false allows sign-in only through a provider. Needs OIDC or SAML. |
ALERT_DIGEST_INTERVAL | 0 | Bundle finding and software alerts into one message per channel per interval, for example 4h. 0 sends each alert at once. |
SESSION_TTL | 12h | Lifetime of a web session. |
MAX_SBOM_MB | 128 | Largest SBOM an agent may upload. |
REPORT_MAX_ROWS | 10000 | Row limit of PDF reports and exports. |
AGENT_OFFLINE_AFTER | 5m | Silence after which an agent is offline. |
RETENTION_DAYS | 90 | Age after which scan history and alert logs are deleted. |
LOG_LEVEL | INFO | ERROR, WARN, INFO or DEBUG. |
Scheduled tasks
The server registers four tasks. Their schedules can be changed, and each can be
run now, on the Scans and tasks page.
| Task | Default schedule | Purpose |
|---|
grype-db-update | 0 */6 * * * | Download the newest Grype database. |
vulnerability-scan | 0 */2 * * * | Scan the pending assets, and rescan after a database update. |
agent-offline-check | */5 * * * * | Send the agent offline alerts. |
retention-cleanup | 30 3 * * * | Delete old scan runs and alert logs. |
A scan also starts shortly after an SBOM is uploaded.
What is stored in the database
Some settings are not environment variables. They are managed in the UI and kept
in the database:
The JWT signing secret is generated on the first start and stored in the database.
Back up the database, as described in Operations.