Skip to main content

Configuration

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​

VariableDefaultPurpose
HTTP_ADDR:8080Address the server listens on.
TLS_CERT_FILE, TLS_KEY_FILEServe HTTPS when both are set.
PUBLIC_URLThe address of the UI, for example https://vop.example.com. Required with OIDC or SAML.

Redis and object storage​

VariableDefaultPurpose
REDIS_ADDR, REDIS_PASSWORD, REDIS_DBlocalhost:6379, empty, 0Redis connection. Redis must be reachable when the server starts.
STORAGE_BACKENDs3s3 keeps SBOMs, reports and agent binaries in a bucket. local keeps them as files in STORAGE_DIR.
STORAGE_DIR./data/storageDirectory for the local backend.
S3_ENDPOINTlocalhost:9000S3 endpoint, without a scheme.
S3_ACCESS_KEY, S3_SECRET_KEYRequired with the s3 backend.
S3_BUCKETvulnerability-operatorCreated at start when missing.
S3_REGION, S3_USE_SSL, S3_PATH_STYLEus-east-1, false, trueOptions for S3-compatible stores.

Database​

VariableDefaultPurpose
DB_DRIVERsqlitesqlite, mysql, postgres or mssql.
DB_NAME, DB_HOST, DB_PORT, DB_USER, DB_PASSWORD, DB_SSLMODE, DB_TIMEZONEDB_TIMEZONE=UTCConnection. For SQLite, DB_NAME is the file.
DB_MAX_OPEN_CONNS, DB_MAX_IDLE_CONNS, DB_CONN_MAX_LIFETIME_MINUTES50, 10, 5Connection pool.
EXECUTE_MIGRATIONStrueRun the migrations on start.

Roles and workers​

VariableDefaultPurpose
VOP_ROLEallall 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_CONCURRENCY2Jobs one process runs at once.
SCAN_WORKERS4Assets matched in parallel. Saving the results stays one at a time.

Vulnerability data​

VariableDefaultPurpose
GRYPE_DB_DIR./data/grypeWhere the local Grype database is kept.
GRYPE_DB_UPDATEtruefalse only reads the local database. Use it for air-gapped installations, and copy the database there yourself.

Sessions, sign-in and limits​

VariableDefaultPurpose
INITIAL_ADMIN_EMAIL, INITIAL_ADMIN_PASSWORDadmin@localhost, generatedThe first administrator, created when the database is empty.
AUTH_PASSWORD_LOGINtruefalse allows sign-in only through a provider. Needs OIDC or SAML.
ALERT_DIGEST_INTERVAL0Bundle finding and software alerts into one message per channel per interval, for example 4h. 0 sends each alert at once.
SESSION_TTL12hLifetime of a web session.
MAX_SBOM_MB128Largest SBOM an agent may upload.
REPORT_MAX_ROWS10000Row limit of PDF reports and exports.
AGENT_OFFLINE_AFTER5mSilence after which an agent is offline.
RETENTION_DAYS90Age after which scan history and alert logs are deleted.
LOG_LEVELINFOERROR, 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.

TaskDefault schedulePurpose
grype-db-update0 */6 * * *Download the newest Grype database.
vulnerability-scan0 */2 * * *Scan the pending assets, and rescan after a database update.
agent-offline-check*/5 * * * *Send the agent offline alerts.
retention-cleanup30 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.