Skip to main content

Administrator guide

This guide is for the people who run Vulnerability Operator: they install the server, connect the agents, decide who sees what, and keep the scans and alerts working. The User guide describes the day-to-day pages; the Reference lists every setting and endpoint.

The parts you run​

PartWhere it runsNotes
Server (vop-server)a container or a Kubernetes deploymentServes the API and the web interface; runs the scans and scheduled tasks.
Redisa service you provideLocks, caches, login throttling and the job queue.
S3-compatible storagea service you provideSBOM documents, generated reports and agent binaries. MinIO works.
DatabaseSQLite by default, or PostgreSQL, MySQL, MSSQLSQLite lives in the /data volume of the server.
Web frontenda container with nginxOptional when the server is reached directly.
Linux, Windows and macOS agentsthe hostsA service that sends the inventory.
Kubernetes agentsevery node of a clusterA DaemonSet from its own Helm chart.

First-day checklist​

  1. Install the server. Use Docker Compose for a single machine, or the Helm chart for a cluster.
  2. Sign in as the initial administrator and change the password. If you did not set INITIAL_ADMIN_PASSWORD, the generated one is in the server log on first start.
  3. Set the public address with PUBLIC_URL, and enable TLS. See Security.
  4. Check the scheduled tasks. The Grype vulnerability database is downloaded by the grype-db-update task; the first scan waits for it. See Scans and tasks.
  5. Connect the first agents. Add hosts with Adding hosts, and clusters with Kubernetes agents.
  6. Create users and roles. Use the built-in viewer role for read-only access, and set scopes where teams should see only their clusters and nodes. See Users, roles and scopes.
  7. Configure single sign-on if your organisation uses an identity provider. See Single sign-on.
  8. Set up alerts and, if wanted, an AI backend for report summaries.

Platform status​

Not every platform has been run end to end yet. The project's own status notes say:

  • The server and the Linux agent were run end to end against Redis, an S3 endpoint and the real Grype database. PostgreSQL 16 was run for migrations, ingest, scans, filters, dashboard, package lists and PDF export.
  • The Windows agent and its service have been built and released, but not yet run on a Windows host in this project's testing.
  • The macOS agent has been built and released, but not yet run on a Mac.
  • MySQL and MSSQL drivers are included but were not run.
  • Delivery to Gotify and SMTP was not tested against real servers; ntfy was.

Test these in your own environment before you depend on them.