The server reads every setting from the environment, or from a .env file in its working directory.
Variables that are already set in the environment take precedence over the file. The agents read the
same way, with the VOP_ variables below.
Server: addresses and TLS
| Variable | Default | Description |
|---|
HTTP_ADDR | :8080 | Listen address. |
TLS_CERT_FILE, TLS_KEY_FILE | | Serve HTTPS when both are set. |
PUBLIC_URL | | Address of the UI, for example https://vop.example.com. Required with OIDC or SAML. |
Server: Redis
| Variable | Default | Description |
|---|
REDIS_ADDR | localhost:6379 | Redis address. |
REDIS_PASSWORD | | Redis password. |
REDIS_DB | 0 | Redis database number. |
Server: storage
| Variable | Default | Description |
|---|
STORAGE_BACKEND | s3 | s3 or local. |
STORAGE_DIR | ./data/storage | Directory for the local backend. |
Server: S3
Used when STORAGE_BACKEND is s3.
| Variable | Default | Description |
|---|
S3_ENDPOINT | localhost:9000 | S3 endpoint, without a scheme. |
S3_ACCESS_KEY, S3_SECRET_KEY | | Required. |
S3_BUCKET | vulnerability-operator | Created at start when missing. |
S3_REGION | us-east-1 | Region. |
S3_USE_SSL | false | Use HTTPS to the endpoint. |
S3_PATH_STYLE | true | Path-style addressing, as MinIO needs. |
Server: database
| Variable | Default | Description |
|---|
DB_DRIVER | sqlite | sqlite, mysql, postgres or mssql. |
DB_NAME | | Database name; for SQLite the file path. |
DB_HOST, DB_PORT | | Database host and port. |
DB_USER, DB_PASSWORD | | Database credentials. |
DB_SSLMODE | | TLS mode of the driver, for example require for PostgreSQL. |
DB_TIMEZONE | UTC | Time zone of the connection. |
DB_MAX_OPEN_CONNS | 50 | Open connections of the pool. |
DB_MAX_IDLE_CONNS | 10 | Idle connections of the pool. |
DB_CONN_MAX_LIFETIME_MINUTES | 5 | Lifetime of a connection. |
EXECUTE_MIGRATIONS | true | Run the migrations on start. |
Server: roles and workers
| Variable | Default | Description |
|---|
VOP_ROLE | all | all: API and workers in one process. api: HTTP only, queues the work. worker: jobs and scheduler only, no HTTP. |
WORKER_CONCURRENCY | 2 | Jobs one process runs at once. |
SCAN_WORKERS | 4 | Assets matched in parallel. |
Server: vulnerability data
| Variable | Default | Description |
|---|
GRYPE_DB_DIR | ./data/grype | Local Grype database directory. |
GRYPE_DB_UPDATE | true | false only reads the local database. |
RELEASE_MANIFEST_URL | the project's release bucket | Address of releases.json for managed agent updates. Empty turns them off. |
Server: sign-in
| Variable | Default | Description |
|---|
INITIAL_ADMIN_EMAIL | admin@localhost | First administrator, created when the database has no users. |
INITIAL_ADMIN_PASSWORD | generated | Its password. A generated one is written to the log. |
AUTH_PASSWORD_LOGIN | true | false: sign-in only through a provider. Needs OIDC or SAML. |
SESSION_TTL | 12h | Lifetime of a web session. |
Server: OpenID Connect
| Variable | Default | Description |
|---|
OIDC_ISSUER_URL | | The provider. Setting it enables OIDC. |
OIDC_CLIENT_ID, OIDC_CLIENT_SECRET | | The client registration. |
OIDC_NAME | SSO | Label of the sign-in button. |
OIDC_SCOPES | openid,email,profile | Scopes requested. |
OIDC_GROUPS_CLAIM | groups | Claim with the group list. |
OIDC_GROUP_MAPPINGS | | JSON list that maps groups to roles and scope. See Users, roles and scopes. |
OIDC_ADMIN_GROUPS | | Comma-separated groups whose members become administrators. Kept for compatibility. |
OIDC_ALLOW_UNVERIFIED_EMAIL | false | Accept sign-ins whose e-mail address is not verified. |
Server: SAML
| Variable | Default | Description |
|---|
SAML_METADATA_URL or SAML_METADATA_FILE | | Identity provider metadata. Either enables SAML. |
SAML_NAME | SAML | Label of the sign-in button. |
SAML_ENTITY_ID | <PUBLIC_URL>/api/v1/auth/saml/metadata | Service provider entity ID. |
SAML_EMAIL_ATTRIBUTE | email | Attribute with the e-mail address. |
SAML_NAME_ATTRIBUTE | displayName | Attribute with the name. |
SAML_GROUPS_ATTRIBUTE | groups | Attribute with the groups. |
SAML_GROUP_MAPPINGS | | The same mapping as OIDC_GROUP_MAPPINGS. |
SAML_ADMIN_GROUPS | | Comma-separated groups whose members become administrators. Kept for compatibility. |
SAML_SP_CERT_FILE, SAML_SP_KEY_FILE | | PEM certificate and key that sign the sign-in requests. |
Server: limits and retention
| Variable | Default | Description |
|---|
AGENT_OFFLINE_AFTER | 5m | Silence after which an agent is offline. |
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. |
MAX_SBOM_MB | 128 | Largest SBOM upload. |
REPORT_MAX_ROWS | 10000 | Row limit of PDF reports and exports. |
RETENTION_DAYS | 90 | Age after which scan history and alert logs are deleted. |
LOG_LEVEL | INFO | ERROR, WARN, INFO or DEBUG. |
Agents
| Variable | Description |
|---|
VOP_SERVER_URL | Server address, as the serverUrl of the configuration file. |
VOP_AGENT_KEY | Agent key, as the agentKey of the configuration file. |
VOP_HEARTBEAT_INTERVAL | Heartbeat interval, 60s by default. |
VOP_INVENTORY_INTERVAL | Inventory interval, 6h by default. |
VOP_SCAN_PATHS | Comma-separated extra directories to catalog. |
VOP_FIM_PATHS | Comma-separated files and directories of the file integrity scan. Empty turns it off. |
VOP_FIM_INTERVAL | File integrity scan interval, 1h by default. |
VOP_PACKAGE_HOOKS | false turns the Linux package-manager hooks off. |
VOP_MANAGED_UPDATES | false turns the agent's self-update off. |
See Agent configuration for the configuration file and its keys.