README.md

mihama

An osv.dev clone for on-premise usage with extra features.

Why?

google/osv.dev is an OSS project. But it's tightly coupled with GCP. It makes it difficult to deploy your own osv.dev if you are not a GCP user.

Overview

flowchart LR
    FastAPI --> Elasticsearch[(Elasticsearch)]
    ARQ --> Elasticsearch
    ARQ --> Redis
    ARQ --> OSV-data-sources[(OSV data sources)]

Loading

• Elasticsearch as a database
• FastAPI as an backend API
• ARQ as a job queue (for periodic OSV data updates)
  • Redis is required to run ARQ.
• OSV data sources:
  • google/osv.dev
  • ossf/malicious-packages

Extra Features

• Query by CycloneDX SBOM
• Query by SPDX SBOM

Known Limitations

• Query by commit is not supported.

Docs

• Installation
• CLI