Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: Add a table of contents at the beginning of README.md #200

Merged
merged 1 commit into from
Dec 28, 2023
Merged

chore: Add a table of contents at the beginning of README.md #200

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,37 @@ OWASP dep-scan is a next-generation security and risk audit tool based on known
[![release](https://github.com/owasp-dep-scan/dep-scan/actions/workflows/pythonpublish.yml/badge.svg)](https://github.com/owasp-dep-scan/dep-scan/actions/workflows/pythonpublish.yml)
[![Discord](https://img.shields.io/badge/-Discord-lime?style=for-the-badge&logo=discord&logoColor=white&color=black)](https://discord.gg/pF4BYWEJcS)

## Contents
- [Features](#features)
- [Vulnerability Data sources](#vulnerability-data-sources)
- [Linux distros](#linux-distros)
- [Usage](#usage)
- [OCI Artifacts via ORAS cli](#oci-artifacts-via-oras-cli)
- [Single binary executables](#single-binary-executables)
- [Server mode](#server-mode)
- [Scanning projects locally (Python version)](#scanning-projects-locally-python-version)
- [Scanning containers locally (Python version)](#scanning-containers-locally-python-version)
- [Scanning projects locally (Docker container)](#scanning-projects-locally-docker-container)
- [Supported languages and package format](#supported-languages-and-package-format)
- [Reachability analysis](#reachability-analysis)
- [Example analysis for a Java project](#example-analysis-for-a-java-project)
- [Example analysis for a JavaScript project](#example-analysis-for-a-javascript-project)
- [Customization through environment variables](#customization-through-environment-variables)
- [GitHub Security Advisory](#github-security-advisory)
- [Suggest mode](#suggest-mode)
- [Package Risk audit](#package-risk-audit)
- [Automatic adjustment](#automatic-adjustment)
- [Configuring weights](#configuring-weights)
- [Live OS scan](#live-os-scan)
- [License scan](#license-scan)
- [Kubernetes and Cloud apps](#kubernetes-and-cloud-apps)
- [PDF reports](#pdf-reports)
- [Custom reports](#custom-reports)
- [Performance tuning](#performance-tuning)
- [Use nydus to speed up the initial vdb download](#use-nydus-to-speed-up-the-initial-vdb-download)
- [Discord support](#discord-support)
- [License](#license)

## Features

- Scan most application code - local repos, Linux container images, Kubernetes manifests, and OS - to identify known CVEs with prioritization
Expand Down