Skip to content

Commit

Permalink
docs: add general coverage page (aquasecurity#3859)
Browse files Browse the repository at this point in the history
  • Loading branch information
itaysk committed Jun 11, 2023
1 parent 479cfdd commit 139f3e1
Show file tree
Hide file tree
Showing 5 changed files with 71 additions and 1 deletion.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ Scanners (what Trivy can find there):
- Sensitive information and secrets
- Software licenses

Trivy supports most popular programming languages, operating systems, and platforms. For a complete list, see the [Scanning Coverage] page.

To learn more, go to the [Trivy homepage][homepage] for feature highlights, or to the [Documentation site][docs] for detailed information.

## Quick Start
Expand Down Expand Up @@ -130,6 +132,7 @@ Please ensure to abide by our [Code of Conduct][code-of-conduct] during all inte

[Installation]:https://aquasecurity.github.io/trivy/latest/getting-started/installation/
[Ecosystem]: https://aquasecurity.github.io/trivy/latest/ecosystem/
[Scanning Coverage]: https://aquasecurity.github.io/trivy/latest/getting-started/coverage/

[alpine]: https://ariadne.space/2021/06/08/the-vulnerability-remediation-lifecycle-of-alpine-containers/
[rego]: https://www.openpolicyagent.org/docs/latest/#rego
Expand Down
58 changes: 58 additions & 0 deletions docs/getting-started/coverage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Scanning Coverage

Trivy can detect security issues in many different platforms and languages. This page gives a general overview of that coverage, and can help answer the frequently asked question "Does Trivy support X?". For more detailed information about the specific features and options, check the relevant scanner documentation.

## Vulnerabilities & SBOM

### Programming languages
Trivy detects code dependencies for the purpose of SBOM generation and vulnerability detection. The following programming languages have some level of support:

- Ruby
- Python
- PHP
- Node.js
- .NET
- Java
- Go
- Rust
- C/C++
- Elixir
- Dart
- Swift

Some features might be not be universally supported. For a full supportability matrix, [see here](../docs/scanner/vulnerability/language/index.md).

### OS
Trivy detects installed packages for the purpose of vulnerability detection. The following package managers are supported:

- Alpine Linux
- Wolfi Linux
- Chainguard
- Red Hat Universal Base Image
- Red Hat Enterprise Linux
- CentOS
- AlmaLinux
- Rocky Linux
- Oracle Linux
- CBL-Mariner
- Amazon Linux
- openSUSE Leap
- SUSE Enterprise Linux
- Photon OS
- Debian GNU/Linux
- Ubuntu
- Distroless

Some features might be not be universally supported. For a full supportability matrix, [see here](../docs/scanner/vulnerability/os.md).

## IaC & configuration
Trivy reads IaC & configuration languages for the purpose of misconfiguration detection and custom checks.

- Kubernetes
- Dockerfile, Containerfile
- Terraform
- CloudFormation
- Azure ARM Template
- Helm Chart

For more information about checks [see here](../docs/misconfiguration/policy/builtin.md).
7 changes: 6 additions & 1 deletion docs/getting-started/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,13 @@

`tri` is pronounced like **tri**gger, `vy` is pronounced like en**vy**.

### Does Trivy support X?

Check out the [Scanning coverage page](./coverage.md)

### How to generate multiple reports?
See [here](../docs/configuration/reporting.md#converting).

### How to run Trivy under air-gapped environment?
See [here](../docs/advanced/air-gap.md).
See [here](../docs/advanced/air-gap.md).

3 changes: 3 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ Scanners (what Trivy can find there):
- Sensitive information and secrets
- Software licenses

Trivy supports most popular programming languages, operating systems, and platforms. For a complete list, see the [Scanning Coverage] page.

To learn more, go to the [Trivy homepage][homepage] for feature highlights, or to the [Documentation site][Docs] for detailed information.

## Quick Start
Expand Down Expand Up @@ -117,6 +119,7 @@ Contact us about any matter by opening a GitHub Discussion [here][discussions]
[Ecosystem]: ./ecosystem/index.md
[Installation]: getting-started/installation.md
[pronunciation]: #how-to-pronounce-the-name-trivy
[Scanning Coverage]: getting-started/coverage.md

[aquasec]: https://aquasec.com
[oss]: https://www.aquasec.com/products/open-source-projects/
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ nav:
- Getting Started:
- Overview: index.md
- Installation: getting-started/installation.md
- Scanning coverage: getting-started/coverage.md
- FAQ: getting-started/faq.md
- Tutorials:
- Overview: tutorials/overview.md
Expand Down

0 comments on commit 139f3e1

Please sign in to comment.